Sync Fulfillment Order from Provider
POST/api/fulfillment-orders/:fulfillmentOrder/sync-from-provider
Pull the shipping provider's latest data for the whole fulfillment order and reconcile the shipments it may have produced. An awaiting fulfillment order that the provider now reports shipped gets its shipment created; existing shipments have their tracking and status refreshed.
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 with lines and shipments), message (summary of what the sync did), shipment_status (the provider's reported shipment status), tracking_pipeline_ran (whether tracking updates were processed).
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.