Bulk Fulfill Sales Orders
POST/api/sales-orders/fulfill
Fulfills multiple sales orders at once by submitting each order's pending fulfillment work to the shipping provider or fulfillment service configured for its warehouse(s). This is an operator-initiated action, so warehouse auto-dispatch eligibility rules are bypassed.
orders:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
Request body fields (one of ids or filters is required):
- ids (array of integers, required without
filters): Sales order IDs to fulfill. - filters (object, required without
ids): Filter set that resolves to a list of sales order IDs (same shape used by the sales-orders listing endpoint).
Behavior:
- Orders on hold (a
hold_until_datein the future) are skipped and reported in the result errors. - No shipment record is created at submit time — the provider's ship confirmation records the shipment later.
- Per-order failures do not abort the batch; they are collected and returned.
- Returns a summary with
total,success,errors, and an overallstatusofsuccessorerror. When some orders fail, the response is returned as a warning with the per-order errors listed underwarnings.
Requires permission: sales_orders.fulfill
Request
Responses
- 200
- 401
- 403
- 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.
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.