Skip to content

List orders

Request

Paginate through your orders, most-recent first. Use cursor for keyset pagination and optionally filter by the order's created_at with created_after and created_before.

Security
api_key
Query
created_afterstring, (date-time)

Only return orders whose created_at is at or after this time. Must be a valid ISO 8601 / RFC 3339 timestamp with a trailing Z or a numeric offset such as -08:00.

Example:created_after=2024-11-01T00:00:00Z
created_beforestring, (date-time)

Only return orders whose created_at is at or before this time. Must be a valid ISO 8601 / RFC 3339 timestamp with a trailing Z or a numeric offset such as -08:00.

Example:created_before=2024-11-30T23:59:59Z
cursorinteger, (int64)

Return orders that come after this cursor. Pass the next_cursor from the previous response to fetch the next page. Omit to start from the most recent order.

Headers
Acceptstringrequired

Accept must be application/json

Example:application/json
curl -i -X GET \
  'https://app.useonward.com/api/v1/orders?created_after=2024-11-01T00%3A00%3A00Z&created_before=2024-11-30T23%3A59%3A59Z&cursor=0' \
  -H 'Accept: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

A page of orders

Bodyapplication/json
ordersArray of objects(OrderSummary)
next_cursorinteger or null, (int64)

Cursor to pass as cursor on the next request to fetch the following page. null when there are no more orders to page through.

Example:8842
Response
{
  "orders": [
    { … }
  ],
  "next_cursor": 8842
}