Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.shipstream.io/llms.txt

Use this file to discover all available pages before exploring further.

When querying collections, the default sort order will typically be by id in descending order. However, you can choose a different sort order by specifying the sort query parameter with one of the field names listed in the endpoint description. You may specify a secondary sort order by specifying the sort value as a comma-separated list of the field names to use for sorting. Field names prefixed with - will be sorted in descending order by the given field, otherwise the result will be sorted in ascending order by the given field. Example: To sort first by priority in descending order and then by name in ascending order:
Request Query
?sort=-priority,name
The paging cursor parameters (cursor_start and cursor_end) are designed to provide consistent results and response times and so they only support sorting by either id (ascending) or -id (descending).
Request Query
?sort=id&cursor_start=38712

Paging

See paging parameters for more information on paging large result sets.