Query orders

Returns the internal order listing using filters, pagination, and sorting options.

POST/api/orders/query

Returns the internal order listing using filters, pagination, and sorting options.

Request Body

application/json

Request payload for Query orders.

TypeScript Definitions

Use the request body type in TypeScript.

limit?|||||

Maximum number of results to return.

offset?|||||

Number of results to skip before returning data.

filters?array<>|

Structured order filters.

orderBy?array<>|

Explicit order-by clauses applied in sequence.

Response Body

`application/json`

curl -X POST "https://example.com/api/orders/query" \  -H "Content-Type: application/json" \  -d '{}'

[  {    "id": "ord_123",    "workspaceId": "ws_123",    "number": "Q-1024",    "orderType": "quote",    "status": "draft",    "createdAt": "string",    "updatedAt": "string",    "customerId": "cust_123",    "customer": {      "id": "cust_123",      "name": "Acme Ltd.",      "email": "buyer@acme.com",      "website": "https://acme.com",      "type": "company",      "customFields": {        "priority": "high",        "approved": true      }    },    "owner": {      "id": "wu_123",      "name": "Ana Torres",      "email": "ana@example.com"    },    "createdBy": {      "id": "wu_123",      "name": "Ana Torres",      "email": "ana@example.com"    },    "relatedDocuments": [      {        "id": "string",        "direction": "source",        "associationType": "quote_to_sales_order",        "orderId": "string",        "orderNumber": "string",        "orderType": "quote",        "lineCount": 0,        "quantity": 0,        "createdAt": "string"      }    ],    "data": {      "priority": "high",      "approved": true    },    "customFields": {      "priority": "high",      "approved": true    }  }]

{  "_tag": "ApiBadRequestError",  "code": "PRICE_IMPORT_DUPLICATE_SKUS",  "message": "The request payload is invalid.",  "description": "Remove duplicate SKU rows before importing the file.",  "details": null}

{  "_tag": "Unauthorized"}

{  "_tag": "ApiForbiddenError",  "message": "You do not have permission to perform this action."}

{  "_tag": "ApiNotFoundError",  "message": "The requested resource was not found."}

{  "_tag": "ApiConflictError",  "message": "A resource with this handle already exists."}

{  "_tag": "ApiUnprocessableEntityError",  "message": "The order cannot be submitted without items."}

{  "_tag": "ServiceUnavailable"}

{  "_tag": "ApiTimeoutError",  "message": "The upstream operation timed out."}

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`