The orders waiting to ship, with their shippable fulfillment orders (cursor; never a count)

An order is in the queue when it is pending or partly fulfilled, not canceled, not hidden from the queue, not escalated, has no shipment confirmation in flight and was created within a year, and when it has either no fulfillment order (mode direct) or at least one shippable one (tenant-portal, pending or partly fulfilled, open or in progress). Priority first, then oldest first (order=newest flips the second key). warehouseId matches the order ship-from warehouse, or an order with no warehouse of its own whose shippable fulfillment order sits at that warehouse. A caller bound to channels sees only its channels.

Scope: channel:read, channel:write, fulfillment:write, shipments:write or admin. A permission group made before the Channel API scopes existed grants it as fulfillment-orders:manage.

Idempotency: not keyed; the request itself is safe to repeat.

Rate limit: read class, 6,000 requests per minute per tenant by default (write class 1,200). Every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset; a refusal is 429 rate_limited with Retry-After.

Query Params
string
^(?:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}|[0-9a-fA-F]{24})$

The warehouse's queue: orders shipping from it, or with no warehouse of their own whose shippable fulfillment order sits at it.

string
^(?:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}|[0-9a-fA-F]{24})$

Sales channel id: a uuid, or a legacy 24-hex id.

enum
string
^(?:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}|[0-9a-fA-F]{24})$

The preselected carrier adapter (or the carrier of record) of the order.

enum

show-fully-and-partly-in-stock (default): orders whose backorder status is not backorder; show-only-fully-in-stock: neither backorder nor partial-backorder; show-all-pending: every order.

date-time

ISO-8601, UTC.

date-time

ISO-8601, UTC.

date-time

Narrows the one-year window the queue reads; never widens it.

Matches the order number, the external order number or id, and the ship-to name (case-insensitive, anywhere).

enum

Within a shipping priority, oldest first (default) or newest first. Priority always comes first.

string
length between 1 and 512

The nextCursor of the previous page.

integer
1 to 200

Default 50.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json