Orders
List orders
Retrieve a paginated list of orders for your organization.
Supports filtering by order status:
- `pending` - Awaiting approval
- `confirmed` - Approved and in progress
- `completed` - Fulfilled
- `cancelled` - Cancelled by customer
- `refused` - Refused by organization
The `created_after` parameter (ISO-8601 datetime) enables incremental polling:
pass the `created_at` of the last order you received to get only newer ones.
Orders are returned in reverse chronological order (newest first) by default.
**Response shape note:** `data` is an object `{items, total, limit, offset}` for
backward compatibility. The top-level `meta` object `{limit, offset, total_items}`
is the standard pagination envelope and is always present.
Authentication:
- API key with READ or READ_WRITE permission
get/orders
Request
- Base URL: https://api.yourang.ai/v1
- URL: https://api.yourang.ai/v1/orders
- Auth: API Key (a scheme the document does not define)
Query parameters
statusstring nullable
Filter by order status
limitinteger
Number of items to return
offsetinteger
Number of items to skip
sortstring nullable
Sort field. Prefix with '-' for descending order. Available: created_at, status, total_amount. A deterministic id tiebreaker is always appended. Example: '-created_at' (newest first, default), 'total_amount' (cheapest first).
created_afterstring date-time nullable
Return only orders created strictly after this ISO-8601 datetime (exclusive). Useful for incremental polling: pass the created_at of the last received order. Example: '2024-01-30T10:00:00Z'.
Response
Successfully retrieved orders list
Changes
No recorded changes to this endpoint across all 8 revisions of this API.