get https://app.ecwid.com/api/v3//batch?ticket=
Get status of a previously created batch request by its ticket ID.
Response
A JSON object with the following fields:
| Field | Type | Description |
|---|---|---|
| status | string | "QUEUED" – no requests were completed yet; "IN_PROGRESS" – there is at least one completed request; "COMPLETED" – All requests were completed |
| totalRequests | number | Total number of API requests |
| completedRequests | number | Number of completed API requests |
| responses | Array <RequestDetails> | Details of requests made to Ecwid API |
RequestDetails
| Field | Type | Description |
|---|---|---|
| id | string | Optional request ID you specified for each API request |
| status | string | "COMPLETED" – All requests were completed; "FAILED" – if response HTTP code was not 200OK; "NOT_EXECUTED" – request was not executed, because previous requests failed. See Handling failed requests to learn more details |
| httpBody | json | Response body for your requests. escapedHttpBody is returned instead if escapedJson parameter is true in your batch status request. For example: details of orders found, status of a discount coupon update, id of a product created, etc. Check examples for each endpoint |
| escapedHttpBody | string | Escaped JSON string of response body for each API request in a batch. Returned if escapedJson parameter is true in your batch status request |
| httpStatusCode | number | HTTP status code from Ecwid API for a request |
| httpStatusLine | string | HTTP status reason phrase |
Errors
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 |