---
title: "List customer orders (status)"
method: GET
path: "/api/v1/rest/ordini/orders/status"
tags: ["Orders"]
---

# List customer orders (status)

`GET /api/v1/rest/ordini/orders/status`

## Request

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

Polling snapshot: the same current record or collection as the corresponding read endpoint, including its state and progress. List filters, defaults and pagination also apply here. This is not an event history or a changes-since feed. Poll at a sensible interval (start with 30 seconds), respect Retry-After on 429 and stop when the required terminal state is reached.

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/status?open=true`
- Orders from Rossi
  `GET /api/v1/rest/ordini/orders/status?q=Rossi`

## Query parameters

- `limit` integer
- `cursor` string
- `status` 'draft' | 'review' | 'confirmed' | 'processing' | 'partially_shipped' | 'shipped' | 'cancelled'
- `open` boolean
- `party_id` string, uuid
- `q` string

## Headers

- `X-Tenant-Id` string, uuid

## Response `200`

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.

- object
  - `ok` true, required
  - `data` OrdiniListOrdersResult, required
    - `items` object[], required
      - `id` string, required
      - `number` string, nullable, required: Null until the order is confirmed.
      - `year` number, nullable, required
      - `status` 'draft' | 'review' | 'confirmed' | 'processing' | 'partially_shipped' | 'shipped' | 'cancelled', required
      - `partyId` string, nullable, required
      - `partyName` string, nullable, required
      - `customerRef` string, nullable, required: The customer’s own order number.
      - `orderDate` string, required
      - `requestedDeliveryDate` string, nullable, required
      - `sourceChannel` 'manual' | 'email' | 'whatsapp' | 'document' | 'api', required
      - `receivedAt` string, nullable, required
      - `confirmedAt` string, nullable, required
      - `exportedAt` string, nullable, required
      - `extractionStatus` 'none' | 'queued' | 'running' | 'done' | 'failed' | 'limit', required
      - `lineCount` number, required
      - `reviewCount` number, required: Lines still waiting for a person to check them.
      - `totalNet` string, required: Decimal string, computed by the database.
      - `totalGross` string, required
      - `currency` string, required
      - `createdAt` string, required
      - `createdBy` string, nullable, required
      - `createdByName` string, nullable, required
    - `total` number, required
    - `nextCursor` string, nullable, required: Pass it back as `cursor` for the next page; null on the last one.

## Other responses

- `400`: The arguments did not validate: `error.message` names the field, what it expects and what arrived.
- `401`: No API key, or one that is malformed, unknown, revoked or expired.
- `403`: The call never ran: the module is off for this organisation, the credential lacks the permission or the module, the tier does not cover it, or the tool is destructive and the key was not minted for that.
- `422`: The tool ran and refused, in a sentence of its own (`TOOL_REFUSED`): the message says what to change. Retrying the same call will not help.
- `429`: The API key has spent its minute, or its day. Every request a key makes counts. See `Retry-After`.

---

[API](https://skmtc.dev/custodo/apis/custodo-integrazioni.md) · [All operations](https://skmtc.dev/custodo/apis/custodo-integrazioni/llms.txt) · [OpenAPI document](https://skmtc.dev/custodo/apis/custodo-integrazioni/revisions/16d336d3ec2a?raw)