Skip to main content

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), whether it's the warehouse's preferred default (is_warehouse_default), and what the provider's submit payload can carry: supports_signature_required (the Signature required flag) and supports_warehouse_instructions (the Warehouse instructions text). The dialog offers those fields only when true. default_integration_instance_id / default_fulfillment_type name the provider the order dispatches to when no override is set, and the dialog pre-selects it.

Required scope: orders:read

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

Routing rules. When the fulfillment order's warehouse has a shipping-method routing rule for the order's shipping method, the rule is what the order dispatches to without an override, so it becomes the pre-selected default: routing_rule_id identifies the rule, the matching option carries is_routing_rule: true (the Manual option when the rule routes to Manual), and default_integration_instance_id / default_fulfillment_type echo the rule's target. With no applicable rule, routing_rule_id is null and the defaults echo the warehouse default. Every option carries is_routing_rule (except the single fixed Amazon MCF / pickup option). Manage rules via /api/warehouses/{warehouse}/provider-routing-rules.

Amazon MCF (FBA) warehouses. The response collapses to a single fixed "Amazon MCF" option and adds: fba_shipping_speeds (the MCF shipping speeds that can be requested for this order), fba_block_amzl_forced (true when the order's sales channel is configured to block Amazon Logistics — BLOCK_AMZL is always sent), and fba_blank_box_default (true when the order's sales channel defaults MCF orders to unbranded BLANK_BOX packaging — applied only while the fulfillment order has no explicit requested_metadata.feature_constraints choice).

Optional query param: shipping_method_id — see above. Send it empty (?shipping_method_id=) to preview the fulfillment order with no shipping method of its own — what clearing the method, or entering a free-text method, saves — so the sales order's shipping method (and any routing rule for it) decides the default provider. Omit it entirely to use the method currently saved on the fulfillment order.

Authenticate with a Personal Access Token.

Required permission: fulfillment_orders.index (Fulfillment Orders → View). A token also needs its orders scope.

Request​

Responses​

OK

Response Headers
    Content-Type