API summary
The Ordering API uses project-scoped URLs with this general structure:
https://apiv4.ordering.co/{version}/{language}/{project}/{resource}
| Segment | Purpose |
|---|---|
version | Selects the API version. |
language | Selects the response language. |
project | Identifies the Ordering project. |
resource | Identifies the API resource and any nested identifiers. |
Query capabilities vary by operation. Common patterns include:
| Parameter | Purpose |
|---|---|
params | Selects supported fields or relations as a comma-separated list. |
limit | Limits the number of records returned when supported. |
offset | Skips records before the returned result when supported. |
orderBy | Selects supported ordering fields and directions when documented. |
where | Applies supported filters when documented. |
Do not assume that every operation accepts every parameter or returns the same pagination shape. Check each operation in the API Reference. See Welcome to the Ordering API, Pagination, and Filtering for more detail.