Orders

List customer orders

One page of customer orders («Ordini»), newest first: number (null until confirmed), status, customer, the customer’s own reference, dates, totals as decimal strings, and how many lines still wait for a person (reviewCount). open: true lists only what is waiting to be checked or confirmed.

Examples

  • Which orders are waiting to be checked? GET /api/v1/rest/ordini/orders?open=true
  • Orders from Rossi GET /api/v1/rest/ordini/orders?q=Rossi
get/api/v1/rest/ordini/orders

Request

  • Base URL: https://api.custodo.ai
  • URL: https://api.custodo.ai/api/v1/rest/ordini/orders
  • Auth: HTTP bearer

Query parameters

limitinteger

Rows to return, 1–100. Default 20.

cursorstring

Opaque cursor from a previous call’s nextCursor, to continue.

status'draft' | 'review' | 'confirmed' | 'processing' | 'partially_shipped' | 'shipped' | 'cancelled'
openboolean

Only orders still waiting for a person (draft, review).

party_idstring uuid
qstring

Words to find in the number, customer, reference or notes.

Headers

X-Tenant-Idstring uuid

The organisation to act in. An API key is bound to exactly one, so this is optional for a key and must match the one it was minted for.

Response

Done. data is the tool’s answer, as described here. Its objects may carry fields this description does not name yet: read the ones you need and ignore the rest.

oktrue required

Changes

No recorded changes to this operation across all 1 revision of this API.