Stop batch request

POST https://app.ecwid.com/api/v3/{storeId}/batch/cancel-group?ticketId={ticketId}&groupId={groupId}

Stops all remaining non-executed requests inside the batch. These requests receive COMPLETED status and therefore are not executed later on. Already completed requests inside the batch are not affected.

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
ticketId	string	Internal "ticket ID" assigned to the batch. Required
groupId	number	Internal group ID assigned to the batch. Required
escapedJson	number	Set true to get responses for already completed 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
updateCount	number	Defines if the request was successful. One of: 1 if the batch was stopped, 0 if the item was not updated.