Bounded counts of the queue: pending, partly fulfilled, total, shipped today

Every count stops at 10000 and says so (capped: true). The filters are the list's. shippedToday counts the shipments recorded on the caller day (timezone, default UTC), canceled ones excluded. No navigation: the portal has it in admin-api.

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

string
length between 1 and 64

IANA zone for "today" (shippedToday); default UTC.

Responses

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