post https://app.ecwid.com/api/v3//batch/cancel-group
Switches all batches with a corresponding groupId to the "COMPLETED" status.
Headers
| Name | Type | Description |
|---|---|---|
| Authorization | string | oAuth token with mandatory Bearer before it. Example: Bearer e***s0, where e***s0 should be replaced with your oAuth token. |
Query parameters
| Field | Type | Description |
|---|---|---|
| groupId | string | ID of a group that should be completed |
Response
A JSON object of type 'UpdateStatus' with the following fields:
UpdateStatus
| Field | Type | Description |
|---|---|---|
| updateCount | number | The number of updates (1 or 0 depending on whether the update was successful) |
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 Status | Description |
|---|---|
| 400 | Request parameters are malformed |
| 415 | Unsupported content-type: expected application/json or text/json |
| 500 | Error on the server |
Error response body (optional)
| Field | Type | Description |
|---|---|---|
| errorMessage | string | Error message |