Shipsidekick DocsList orders
Retrieve a list of orders with pagination and filtering options. Results are filtered to orders the authenticated user has access to.
Query Parameters
limitintegerMaximum number of items to return per page
Default:
10Minimum: 1Maximum: 100pageintegerPage number for pagination
Default:
1Minimum: 1searchstringSearch term to filter orders by name, alias, or customer details
cursorstringCursor for pagination (alternative to page-based pagination)
sortBystringField to sort by (e.g., orderDate, price, name)
sortOrderstringOrder to sort by
Default:
"desc"Value in: "asc" | "desc"includeArchivedbooleanWhether to include archived orders
Default:
falsefinancialStatusstringFilter orders by financial status
Value in:
"authorized" | "expired" | "paid" | "partially-paid" | "partially-refunded" | "pending" | "refunded" | "voided"fulfillmentStatusstringFilter orders by fulfillment status
Value in:
"scheduled" | "open" | "confirmed" | "on-hold" | "partially-fulfilled" | "fulfilled"dateRange[from]stringStart date for filtering orders by orderDate
Format:
"date"dateRange[to]stringEnd date for filtering orders by orderDate
Format:
"date"Successful operation