List the purchase orders sent to vendors (stage, vendor, warehouse, search; cursor pagination)

One card per purchase order: its stage, vendor, ship-to warehouse, ETA, whether it is late, units ordered, shipped, received and still to come (openUnits), its total, what it costs in the end (payableTotal: see the detail) and what is still owed. stage takes a comma-separated list of stages, open (sent and not fully received) or all. q searches the PO number, the PO id, the vendor reference, the vendor name, line SKUs and, of each vendor shipment, its tracking number, container number and bill of lading (the values only: nothing else a shipment stores is searched). arrivingWithinDays keeps the open purchase orders whose ETA lies between now and that many days from now (1 to 365): with 14 it lists exactly the purchase orders the summary counts in arrivingSoon. The filters combine. The stage is derived, never stored: cancelled, received, draft (also a PO waiting for approval), receiving, arrived (a shipment arrived), shipped, confirmed (the vendor confirmed), ordered. Archived purchase orders are left out.

Scope: outgoing-purchase-orders:read, outgoing-purchase-orders:write, channel:write or admin. A permission group made before the Channel API scopes existed grants it as inventory:read or supply-chain:read.

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
length between 1 and 512

The nextCursor of the previous page.

integer
1 to 200

Default 50.

string
length ≤ 200

Comma-separated: draft, ordered, confirmed, shipped, arrived, receiving, received, cancelled, open, all. Default all.

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})$

A uuid, or the record's 24-hex id.

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})$

A uuid, or the record's 24-hex id.

string
length ≤ 100

PO number, PO id, vendor reference, vendor name, SKU, or a vendor shipment's tracking number, container number or bill of lading.

boolean

Only POs whose ETA (or, before anything shipped, ready-to-ship date) has passed.

integer
1 to 365

Only open POs (sent and not fully received) with an ETA between now and that many days from now. 14 lists exactly the POs the summary counts in arrivingSoon.

enum
Responses

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