Sync Fulfillment Order to Provider
POST/api/fulfillment-orders/:fulfillmentOrder/sync-to-provider
Push the fulfillment order's current order-level state (items, quantities, customer address) to the shipping provider. When shipments already exist each one is reconciled and re-sent; when none exist yet the registered provider order is updated in place — the primary use while the order is still awaiting fulfillment.
orders:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
The fulfillment order must already have a registered provider order — 422 otherwise, and 422 on provider/transport failures.
Response fields: data (the refreshed fulfillment order), message (summary), shipments_pushed (how many provider shipments were re-sent), awaiting (true when the provider order was updated in place because no shipments exist yet).
Authentication: Requires 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.