Retry Sales Channel Shipping Label Purchase
POST/api/sales-orders/:salesOrder/channel-shipping-labels/retry
Retry the order's held or failed channel label purchases now (those with can_retry true), for example after setting a fallback box size. A label that was already bought is never bought again. No request body.
orders:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
Requires the sales_orders.update permission.
The purchase runs in the background, so the response is the refreshed label list (same shape as List Sales Channel Shipping Labels) with retried labels back at pending. Poll the list to see the result.
Errors: 422 with a message when there is nothing to retry or the order's sales channel does not buy labels; 404 when the sales order does not exist.
Path parameters:
- salesOrder (required): Sales order ID.
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 Content
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.