PROCESS STATUS
Use this call to get the status of process by ID.
Header information
| Endpoint | /process |
| Method | GET |
| Base node | process |
Request payload
| Field | Obligatory | Type | Default value | Description |
| ID | yes | string (1-32) | Process ID |
Response payload
| Field | Obligatory | Type | Description |
| createdAt | yes | date | Date when process was queued, formatted in ISO8601 (Y-m-d\TH:i:sP) |
| process | yes | string | Type of process |
| startedAt | yes | date | Date when processing was started, formatted in ISO8601 (Y-m-d\TH:i:sP) |
| type | yes | string | Type of process |
| statuses | yes | collection of status |
Request example
<?xml version="1.0" encoding="utf-8"?>
<process>
<ID>hCpwGgrvYF0iI32T</ID>
</process>
Response example
{
"Request": {
"RequestType": "Process",
"RequestAction": "Read",
"RequestIdentifier": "hCpwGgrvYF0iI32T",
"ProcessedAt": "2018-03-23T14:34:31+01:00"
},
"Response": {
"Result": "Success",
"ProcessReadResponseContainer": {
"createdAt": "2018-03-23T14:34:31+01:00",
"process": "order_update",
"startedAt": "2018-03-23T14:34:31+01:00",
"type": "order",
"statuses": [
{
"status": "completed",
"items": 1,
"processed": 1,
"date": "2018-03-23T14:34:31+01:00"
},
{
"status": "started",
"items": 1,
"processed": 1,
"date": "2018-03-23T14:34:31+01:00"
},
{
"status": "transferred",
"items": 1,
"processed": 0,
"date": "2018-03-23T14:34:31+01:00"
},
{
"status": "queued",
"items": 1,
"processed": 0,
"date": "2018-03-23T14:34:31+01:00"
}
]
}
}
}
<?xml version="1.0"?>
<ApiResponseContainer>
<Request>
<RequestType>Process</RequestType>
<RequestAction>Read</RequestAction>
<RequestIdentifier>hCpwGgrvYF0iI32T</RequestIdentifier>
<ProcessedAt>2018-03-23T14:34:31+01:00</ProcessedAt>
</Request>
<Response>
<Result>Success</Result>
<ProcessReadResponseContainer>
<createdAt>2018-03-23T14:34:31+01:00</createdAt>
<process>order_update</process>
<startedAt>2018-03-23T14:34:31+01:00</startedAt>
<type>order</type>
<statuses>
<status>
<status><![CDATA[completed]]></status>
<items>1</items>
<processed>1</processed>
<date>2018-03-23T14:34:31+01:00</date>
</status>
<status>
<status><![CDATA[started]]></status>
<items>1</items>
<processed>1</processed>
<date>2018-03-23T14:34:31+01:00</date>
</status>
<status>
<status><![CDATA[transferred]]></status>
<items>0</items>
<processed>1</processed>
<date>2018-03-23T14:34:31+01:00</date>
</status>
<status>
<status><![CDATA[queued]]></status>
<items>1</items>
<processed>0</processed>
<date>2018-03-23T14:34:31+01:00</date>
</status>
</statuses>
</ProcessReadResponseContainer>
</Response>
</ApiResponseContainer>