Get Shipping Provider Options
GET/api/fulfillment-orders/:fulfillmentOrder/shipping-provider-options
The shipping-provider options for the Edit Shipping Details picker (per-FO provider override). Lists the configured shipping-provider integration instances in the tenant PLUS a synthetic Manual option, each with whether it's mapped to this FO's warehouse (is_mapped) and whether it's the warehouse's preferred default (is_warehouse_default). The dialog pre-selects default_integration_instance_id.
orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
The provider an FO dispatches to is normally the warehouse's preferred; this lets an operator override it per FO. ANY configured shipping provider is selectable AND submittable — is_mapped merely reflects whether an explicit ShippingProviderWarehouse mapping exists and never gates submission (the mapping only informs the default).
Click & Collect (pickup) lock. When the FO's effective shipping method is a pickup method, the response collapses to a single locked option (default_fulfillment_type = pickup, one option named "Pickup (Click & Collect)") — a pickup order is collected in person and is never dispatched to a carrier. Pass shipping_method_id to preview the options against a not-yet-saved method so the lock engages/releases live.
Optional query param: shipping_method_id — see above.
Authenticate with a Personal Access Token.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
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.