List Orders
GET/api/shiphero/integration-instances/:integration_instance/orders
List ShipHero orders for the integration instance, newest first. Canonical list view endpoint (Spatie QueryBuilder); returns a paginated list of lightweight order rows.
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
Quick search (filter[search]): matches ID (exact), order number (partial), and ShipHero ID (partial). Restrict which columns are searched with search_columns (allowed: id, order_number, shiphero_id); force exact matching on a column with search_strict_columns.
Filters (all optional):
- filter[fulfillment_status]: exact ShipHero fulfillment_status (pending, fulfilled, canceled).
- filter[has_fulfillment]: true/1 = linked to a SKU.io fulfillment; false/0 = unlinked; omit for all.
- filter[sku_fulfillment_id]: exact linked SalesOrderFulfillment id.
- Per-column advanced filters with operators: filter[id], filter[order_number], filter[shiphero_id], filter[fulfillment_status], filter[created_at], filter[updated_at].
Sort (sort): id, order_number, fulfillment_status, created_at, updated_at. Prefix with - for descending. Default: -id. Pagination: page, per_page (default 10).
Authentication: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.