List Shipments
GET/api/shiphero/integration-instances/:integration_instance/shipments
Server-side paginated + filterable ShipHero shipments. Filters: carrier (exact), shipping_method (exact), has_order_link (true/false), search (tracking_number / order_number / shiphero_shipment_id / carrier). Sortable: id, order_number, tracking_number, carrier, shipping_method, cost, created_date, created_at, updated_at (default -created_date).
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
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.