get https://app.ecwid.com/api/v3//batch?status=STATUS&limit=100
Get all requests with a certain status.
Headers
| Name | Type | Description |
|---|---|---|
| Authorization | string | oAuth token with mandatory Bearer before it. Example: Bearer e***s0, where e***s0 should be replaced with your oAuth token. |
Query parameters
Parameters in bold are mandatory
| Name | Type | Description |
|---|---|---|
| status | string | QUEUED – to get the list of not completed requests; IN_PROGRESS – to get the list of requests in progress; COMPLETED – to get the list of completed requests. |
| offset | number | Offset from the beginning of the returned items list (for paging) |
| limit | number | Maximum number of returned items. Maximum allowed value: 100. Default value: 100 |
Response
A JSON object of type 'Items' with the following fields:
Items
| Field | Type | Description |
|---|---|---|
| ticket | string | Ticket ID for your batch request. Use it to Get batch request status |
| status | string | "QUEUED" – scheduled request; "IN_PROGRESS" – request in progress; "COMPLETED" – completed request |
Errors
Error response example
HTTP/1.1 500 Server Error
Content-Type application/json; charset=utf-8
In case of error, Ecwid responds with an error HTTP status code and, optionally, JSON-formatted body containing error description
HTTP codes
| HTTP Status | Description |
|---|---|
| 400 | Request parameters are malformed |
| 415 | Unsupported content-type: expected application/json or text/json |
| 500 | Cannot retrieve the order info because of an error on the server |
Error response body (optional)
| Field | Type | Description |
|---|---|---|
| errorMessage | string | Error message |