Skip to main content

API summary

The Ordering API uses project-scoped URLs with this general structure:

https://apiv4.ordering.co/{version}/{language}/{project}/{resource}
SegmentPurpose
versionSelects the API version.
languageSelects the response language.
projectIdentifies the Ordering project.
resourceIdentifies the API resource and any nested identifiers.

Query capabilities vary by operation. Common patterns include:

ParameterPurpose
paramsSelects supported fields or relations as a comma-separated list.
limitLimits the number of records returned when supported.
offsetSkips records before the returned result when supported.
orderBySelects supported ordering fields and directions when documented.
whereApplies 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.