List Sales Orders
Retrieve a paginated list of sales orders.
Endpoint
GET /sales-orders?size=2
Authentication
X-API-Key (passed in the Authorization header)
Request Parameters
Query Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
size | integer | No | 20 | The number of sales orders to return per page. |
page | integer | No | 0 | The page number to retrieve (zero-indexed). |
sort | string | No | — | The field to sort by. Prefix with - for descending order. |
status | string | No | — | Filter by sales order status. |
customerId | string | No | — | Filter by customer unique identifier. |
fromDate | string (date) | No | — | Filter sales orders created on or after this date (ISO 8601 format). |
toDate | string (date) | No | — | Filter sales orders created on or before this date (ISO 8601 format). |
Request Headers
| Header | Value | Required | Description |
|---|---|---|---|
Authorization | X-API-Key: {{apiKey}} | Yes | X-API-Key for authentication. |
Example Request
curl -X GET "https://api.example.com/sales-orders?size=2" \
-H "X-API-Key: {{apiKey}}"
Request Schema
No request body is required for this endpoint.