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.

Search options are optional and can be used for safe paging.

​
Options

​
sort_field
string
{ "sort_field" : "status" }
The “Sort Field” option. Default: “order_id”.
​
sort_dir
string
{ "sort_dir" : "desc" }
The “Sort Direction” option. Allowed: “asc” or “desc”. Default: “asc”.
​
page
integer
{ "page" : 5 }
The “Page” numeric option. Default: 1.
​
limit
integer
{ "limit" : 100 }
The “Limit” numeric option. Default: 50. Max value: 100.
​
skip_totals
integer
{ "skip_totals" : 1 }
Set to 1 to omit totalCount and numPages from the response. Since computing totals requires an additional counting query, it is recommended to request totals only on the first page to build pagination and use skip_totals for subsequent page requests or when only the data is needed.
Currently supported only by shipment.search.