Query orders

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

POST/api/unstable/orders/query

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

Request Body

application/json

limit?number

Maximum number of orders to return.

Example25

offset?number

Number of matching orders to skip.

Example0

filters?array<>

Structured order filters.

Example

[
  {
    "id": "filter_1",
    "columnKey": "status",
    "operator": "is",
    "value": "draft"
  }
]

orderBy?array<>

Explicit order-by clauses applied in sequence.

Example

[
  {
    "field": "createdAt",
    "direction": "desc"
  }
]

[key: string]?never

Response Body

`application/json`

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

[
  {
    "id": "string",
    "workspaceId": "string",
    "number": "string",
    "status": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "customerId": "string",
    "customer": {
      "id": "string",
      "name": "string",
      "email": "string",
      "website": "string",
      "type": "company"
    },
    "owner": {
      "id": "string",
      "name": "string"
    },
    "data": {
      "priority": "high",
      "approved": true
    },
    "customFields": {
      "priority": "high",
      "approved": true
    }
  }
]

{
  "issues": [
    {
      "_tag": "Pointer",
      "path": [
        "string"
      ],
      "message": "string"
    }
  ],
  "message": "string",
  "_tag": "HttpApiDecodeError"
}

Empty

{
  "message": "string",
  "_tag": "ApiForbiddenError"
}

{
  "message": "string",
  "_tag": "ApiNotFoundError"
}

{
  "message": "string",
  "_tag": "ApiConflictError"
}

{
  "message": "string",
  "_tag": "ApiUnprocessableEntityError"
}

Empty

{
  "message": "string",
  "_tag": "ApiTimeoutError"
}

Query orders

Request Body

Response Body

200application/json

400application/json

401

403application/json

404application/json

409application/json

422application/json

503

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`