List Orders
Purpose: Retrieves a list of orders associated with a specific client, optionally filtered by status or date range.
Endpoint Details
- HTTP Verb: GET
- URL Segment: /v3/clients/{clientid}/orders
- OpenAPI Spec: View in Swagger UI
- Notes: Defaults to listing orders from the past 30 days if
fromDateandtoDateare not provided.
Query Parameters
This method uses parameters passed in the URL query string to filter the list.
| Field Name | Description | Type | Additional Information |
|---|---|---|---|
clientId | The unique ID of the client whose orders are to be listed. | string ($uuid) | Required. |
orderStatus | Filters the list to orders matching this status. | string | Optional. Enum values are defined in the OrderResponse Schema. |
fromDate | The start date to filter orders by their createDate. | string ($date-time) | Optional. Defaults to 30 days prior to toDate if toDate is present. |
toDate | The end date to filter orders by their createDate. | string ($date-time) | Optional. Defaults to the current date/time if fromDate is present. |
Request Body
No Request Body Required.
Successful Response (200 OK)
The API returns an array of OrderResponse objects. Each OrderResponse object in
the array contains a retrieved Order entity
For schema and examples, see the OrderResponse Schema page.
Error Responses
The following HTTP status codes are explicitly documented for this method:
| Status Code | Description |
|---|---|
| 400 Bad Request | The request was invalid (e.g., date formats are incorrect, or the combination of date filters is illogical). |
| 401 Unauthorized | Authentication failure (e.g., missing or invalid API key/credentials). |
| 404 Not Found | The specified clientId exists, but no orders were found that match the provided criteria. |