Skip to main content

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.

Required scope: orders:write

Grant 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​

OK

Response Headers
    Content-Type