Search batch requests by status

GET https://app.ecwid.com/api/v3/{storeId}/batch?status=STATUS&limit=100

Request and response example

Request:

GET /api/v3/1003/batch?status=COMPLETED&limit=100 HTTP/1.1
Authorization: Bearer secret_token
Host: app.ecwid.com

Response:

{
  "items": [
    {
      "ticket": "11kl140a2-966f-1a9f-b4e6-fc451bc78570",
      "status": "COMPLETED"
    }
  ]
}

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

Some of the query params are required.

Param	Type	Description
status	string	Search term for the current batch status. One of: QUEUED – Find only batch requests that haven't been sarted yet. IN_PROGRESS – Find only batch requests in progress. COMPLETED – Find only completed batch requests. Required
limit	number	Maximum number of returned items. Default and maximum allowed value: 100 Required
offset	number	Offset from the beginning of the returned items list. Used when the response contains more items than limit allows to receive in one request. Usually used to receive all items in several requests with multiple of a hundred, for example: ?offset=0 for the first request, ?offset=100, for the second request, ?offset=200, for the third request, etc. Optional

Response JSON

A JSON object with the following fields:

Field	Type	Description
items	array of objects items	List of found batch requests.

items

Field	Type	Description
ticket	string	Internal "ticket ID" assigned to the batch request.
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.