Bulk Cancel Orders
POST/api/shiprush/instances/:integration_instance/orders/bulk-cancel
Cancel several orders at once so ShipRush drops them on its next poll. Orders that have already shipped cannot be recalled and are skipped, as are orders already cancelled.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Body fields:
- ids (array of integers, required unless apply_to_all is true): the order ids to act on. Ids belonging to another integration instance are ignored.
- apply_to_all (boolean, optional): when true, act on every order matching filters instead of ids.
- filters (object, optional): the same filter keys the List Orders endpoint accepts (e.g. order_number.contains, status.is), plus filter_groups for grouped conditions. Only used with apply_to_all.
Returns counts: processed (acted on), skipped (the action does not apply to the row's state), failed (the action errored), and errors keyed by row id. Returns 422 when neither ids nor apply_to_all is sent.
Authentication: Requires a Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.