Get batch status

GET https://app.ecwid.com/api/v3/{storeId}/batch?ticket={ticketId}

Request and response example

Request:

GET /api/v3/1003/batch?ticket=11kl140a2-966f-1a9f-b4e6-fc451bc78570 HTTP/1.1
Authorization: Bearer secret_token
Host: app.ecwid.com

Response:

{
    "status": "COMPLETED",
    "totalRequests": 3,
    "completedRequests": 3
}

Required access scopes

This request does not require any access scopes.

Path params

All path params are required.

Param	Type	Description
storeId	number	Ecwid store ID.

Query params

Request works with two query params, one of which is required.

Param	Type	Description
ticketId	string	Internal ticket ID assigned to the specific batch request. Required
escapedJson	boolean	Set true to get responses for API requests included in the batch. Responses are returned as escaped JSON string in the escapedHttpBody field. By default, responses for API requests included in the batch are not returned. Optional

Response JSON

A JSON object with the following fields:

Field	Type	Description
status	string	Current status of the batch request. One of: QUEUED – No requests inside the batch are yet completed. yet. IN_PROGRESS – At least one request inside the batch was already completed. COMPLETED – All requests inside the batch have been completed.
totalRequests	number	Total number of API requests included in the batch.
completedRequests	number	Number of completed API requests from the batch.
responses	object responses	Details of requests included in the batch.

responses

Field	Type	Description
id	string	Optional ID for the REST API request included in the batch. Only returns if it was specified in the batch request.
status	string	Request status. One of: COMPLETED – All requests were completed. FAILED – Response HTTP code was not 200 OK. NOT_EXECUTED – Request was not executed, because one of the previous requests failed and batch execution has been stoped.
httpBody	json object	Response body for the request, if it has any. Returned only if escapedJson query param is not included or is set to false.
escapedHttpBody	string	Escaped JSON string of response body for the request. Returned only with escapedJson=true query param.
httpStatusCode	number	Response HTTP code for the request.
httpStatusLine	string	Contains error messages for failed requests in the batch.