Skip to main content

Get Warehouse Provider Routing Rules

GET 
/api/warehouses/:warehouse/provider-routing-rules

Returns a warehouse's shipping-method routing rules together with the choices available for building them.

Required scope: warehouses:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Routing rules refine the warehouse's default shipping provider: each rule maps one shipping method to a shipping-provider integration instance, or to Manual. When a fulfillment order at this warehouse uses that shipping method, it dispatches to the rule's provider instead of the warehouse default.

How a fulfillment order's shipping provider is resolved (first match wins):

  1. Amazon FBA / Walmart WFS warehouse, or a Click & Collect (pickup) shipping method — fixed; never routed.
  2. Per-order override on the fulfillment order (requested_integration_instance_id, or requested_fulfillment_type: "manual") — set via PATCH /api/fulfillment-orders/{fulfillmentOrder}/shipping.
  3. Routing rule for the order's shipping method at this warehouse (the fulfillment order's requested shipping method, else the sales order's).
  4. The warehouse's default provider (order_fulfillment).
  5. Otherwise Manual.

A rule whose integration_instance_id is null routes the method to Manual. A rule pointing at a provider that is no longer usable (disconnected, inactive, or no longer mapped to this warehouse) is skipped at dispatch and the order falls through to the warehouse default.

Response (data):

  • warehouse_id (integer).
  • default — the warehouse default the rules refine: { order_fulfillment, integration_instance_id, name } (name is "Manual" when no provider is set).
  • rules (array) — the saved rules. Rule fields: id, warehouse_id, shipping_method_id, shipping_method (name), shipping_method_full_name, integration_instance_id (null = Manual), instance_name, integration_name, fulfillment_type (e.g. shipstation, pinnacle, manual), orders_30d (fulfillment orders at this warehouse using that shipping method in the last 30 days).
  • eligible_methods (array) — shipping methods a rule may target: every active, non-pickup method { id, name, full_name }.
  • eligible_providers (array) — targets a rule may route to: active shipping-provider instances { id, name, integration_name, fulfillment_type, is_mapped } plus a Manual entry with id: null. is_mapped is false when the provider is not mapped to this warehouse; such a provider cannot be saved as a rule target.

Returns 404 when the warehouse does not exist.

Authentication: Requires Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type