Get batch request status

Get status of a previously created batch request by its ticket ID.

Headers

NameTypeDescription
AuthorizationstringoAuth token with mandatory Bearer before it. Example: Bearer e***s0, where e***s0 should be replaced with your oAuth token.

Query parameters

FieldTypeDescription
ticketstringTicket ID you received from Ecwid when creating a batch request
escapedJsonbooleanSet to true to get responses to each of your API requests as escaped JSON string in the escapedHttpBody field. Set to false to get a JSON object in response for your API requests. Default: false

Response

A JSON object of type 'BatchRequestStatus' with the following fields:

BatchRequestStatus

FieldTypeDescription
statusstring"QUEUED" – no requests were completed yet; "IN_PROGRESS" – there is at least one completed request; "COMPLETED" – All requests were completed
totalRequestsnumberTotal number of API requests
completedRequestsnumberNumber of completed API requests
responsesArray <RequestDetails>Details of requests made to Ecwid API

RequestDetails

FieldTypeDescription
idstringOptional request ID you specified for each API request
statusstring"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
httpBodyjsonResponse 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
escapedHttpBodystringEscaped JSON string of response body for each API request in a batch. Returned if escapedJson parameter is true in your batch status request
httpStatusCodenumberHTTP status code from Ecwid API for a request
httpStatusLinestringHTTP status reason phrase

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 StatusDescription
400Request parameters are malformed
415Unsupported content-type: expected application/json or text/json
500Cannot retrieve the order info because of an error on the server

Error response body (optional)

FieldTypeDescription
errorMessagestringError message
Language
Authentication
Query