All URIs are relative to https://secure.ultracart.com/rest/v2
| Method | HTTP request | Description |
|---|---|---|
| getWorkflowAgentWebsocketAuthorization | PUT /workflow/agent/auth | Get agent websocket authorization |
| getWorkflowAssignmentGroups | GET /workflow/assignment_groups | Retrieve a list of groups that workflow tasks can be assigned to |
| getWorkflowAssignmentUsers | GET /workflow/assignment_users | Retrieve a list of users that workflow tasks can be assigned to |
| getWorkflowMe | GET /workflow/me | Retrieve a user object for myself |
| getWorkflowTask | GET /workflow/tasks/{task_uuid} | Retrieve a workflow task |
| getWorkflowTaskAttachmentUploadUrl | GET /workflow/tasks/attachments/{extension} | Get a presigned workflow task attachment upload URL |
| getWorkflowTaskByObjectType | GET /workflow/tasks/by/{object_type}/{object_id} | Retrieve a workflow task by object type and id |
| getWorkflowTaskOpenCount | GET /workflow/tasks/open_count | Retrieve workflow task open count |
| getWorkflowTaskTags | GET /workflow/tasks/tags | Get a list of existing workflow task tags |
| getWorkflowTasks | POST /workflow/tasks/search | Search workflow tasks |
| insertWorkflowTask | POST /workflow/tasks | Insert a workflow task |
| updateWorkflowTask | PUT /workflow/tasks/{task_uuid} | Update a workflow task |
WorkflowAgentAuthResponse getWorkflowAgentWebsocketAuthorization()
Get agent websocket authorization
Retrieve a JWT to authorize an agent to make a websocket connection.
// (Internal API). No sample for this method as a merchant will never need call it.This endpoint does not need any parameter.
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
WorkflowGroupsResponse getWorkflowAssignmentGroups(limit, offset)
Retrieve a list of groups that workflow tasks can be assigned to
Retrieve a list of groups that workflow tasks can be assigned to
// (Internal API). No sample for this method as a merchant will never need call it.| Name | Type | Description | Notes |
|---|---|---|---|
| limit | Integer | The maximum number of records to return on this one API call. (Max 200) | [optional] [default to 100] |
| offset | Integer | Pagination of the record set. Offset is a zero based index. | [optional] [default to 0] |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
WorkflowUsersResponse getWorkflowAssignmentUsers(limit, offset)
Retrieve a list of users that workflow tasks can be assigned to
Retrieve a list of users that workflow tasks can be assigned to
// (Internal API). No sample for this method as a merchant will never need call it.| Name | Type | Description | Notes |
|---|---|---|---|
| limit | Integer | The maximum number of records to return on this one API call. (Max 200) | [optional] [default to 100] |
| offset | Integer | Pagination of the record set. Offset is a zero based index. | [optional] [default to 0] |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
WorkflowUserResponse getWorkflowMe()
Retrieve a user object for myself
Retrieve a user object for myself
// (Internal API). No sample for this method as a merchant will never need call it.This endpoint does not need any parameter.
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
WorkflowTaskResponse getWorkflowTask(taskUuid)
Retrieve a workflow task
Retrieve a workflow task
// (Internal API). No sample for this method as a merchant will never need call it.| Name | Type | Description | Notes |
|---|---|---|---|
| taskUuid | String |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
WorkflowAttachmentUploadUrlResponse getWorkflowTaskAttachmentUploadUrl(extension)
Get a presigned workflow task attachment upload URL
Get a presigned workflow task attachment upload URL
// (Internal API). No sample for this method as a merchant will never need call it.| Name | Type | Description | Notes |
|---|---|---|---|
| extension | String |
WorkflowAttachmentUploadUrlResponse
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
WorkflowTasksResponse getWorkflowTaskByObjectType(objectType, objectId)
Retrieve a workflow task by object type and id
Retrieve a workflow task by object type and id
// (Internal API). No sample for this method as a merchant will never need call it.| Name | Type | Description | Notes |
|---|---|---|---|
| objectType | String | ||
| objectId | String |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
WorkflowTaskOpenCountResponse getWorkflowTaskOpenCount()
Retrieve workflow task open count
Retrieve workflow task open count
// (Internal API). No sample for this method as a merchant will never need call it.This endpoint does not need any parameter.
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
WorkflowTaskTagsResponse getWorkflowTaskTags()
Get a list of existing workflow task tags
Retrieves a unique list of all the existing workflow task tags.
// (Internal API). No sample for this method as a merchant will never need call it.This endpoint does not need any parameter.
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
WorkflowTasksResponse getWorkflowTasks(workflowTasksQuery, limit, offset, sort)
Search workflow tasks
Retrieves a set of workflow tasks from the account based on a query object.
// (Internal API). No sample for this method as a merchant will never need call it.| Name | Type | Description | Notes |
|---|---|---|---|
| workflowTasksQuery | WorkflowTasksRequest | Workflow tasks query | |
| limit | Integer | The maximum number of records to return on this one API call. (Default 100, Max 500) | [optional] [default to 100] |
| offset | Integer | Pagination of the record set. Offset is a zero based index. | [optional] [default to 0] |
| sort | String | The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional] |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
WorkflowTaskResponse insertWorkflowTask(workflowTask)
Insert a workflow task
Insert a workflow task
// (Internal API). No sample for this method as a merchant will never need call it.| Name | Type | Description | Notes |
|---|---|---|---|
| workflowTask | WorkflowTask | workflow task |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |
WorkflowTaskResponse updateWorkflowTask(taskUuid, workflowTask)
Update a workflow task
Update a workflow task
// (Internal API). No sample for this method as a merchant will never need call it.| Name | Type | Description | Notes |
|---|---|---|---|
| taskUuid | String | ||
| workflowTask | WorkflowTask | Workflow task |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Status Code 400: bad request input such as invalid json | * UC-REST-ERROR - Contains human readable error message |
| 401 | Status Code 401: invalid credentials supplied | * UC-REST-ERROR - Contains human readable error message |
| 410 | Status Code 410: Your authorized application has been disabled by UltraCart | * UC-REST-ERROR - Contains human readable error message |
| 429 | Status Code 429: you have exceeded the allowed API call rate limit for your application. | * UC-REST-ERROR - Contains human readable error message |
| 500 | Status Code 500: any server side error. the body will contain a generic server error message | * UC-REST-ERROR - Contains human readable error message |