Set Sales Order Shipping Pending Review
PATCH/api/sales-orders/:salesOrder/shipping-pending-review
Sets or clears the order's shipping_pending_review flag. A B2B portal order whose buyer chose a method priced "calculated on review" is placed with the flag set, meaning shipping has not been priced yet. Applying a shipping estimate, or adding a REVENUE "Shipping" financial line, clears it automatically; send pending: false to clear it without charging shipping (no charge), or pending: true to flag the order again.
orders:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Request body:
pending(boolean, required).
Response (data): shipping_pending_review.
Authentication: Requires Bearer token.
Requires permission: sales_orders.update
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.