List Fulfillment Dispatch Settings
GET/api/warehouses/fulfillment-dispatch-settings
Returns the fulfillment dispatch configuration for every non-supplier warehouse: the fulfillment channel (order_fulfillment), whether fulfillments are automatically dispatched to the connected shipping provider (auto_dispatch_enabled) and whether partial dispatch is allowed (partial_dispatch_enabled).
warehouses:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
The response also includes shippingProviders (the available order_fulfillment values: "manual" plus the names of connected shipping-provider integrations) and shippingProviderDispatchEnabled (whether real provider dispatch is on for this account) and shippingProviderDispatchEditable (whether that setting can be toggled here — true outside production, where dispatch is a per-account opt-in; false in production, where it is always on).
Authentication: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 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.
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.