List Shipments
GET/api/shiprush/instances/:integration_instance/shipments
Paginated, filterable list of ShipRush shipments (one row per parcel) for the integration instance. Each shipment carries the carrier/service (free text as received), cost, tracking number and URL, ship date, voided flag, the writeback outcome (writeback_status / writeback_error), a "View in ShipRush" portal link, and a cross-link to the SalesOrderFulfillment it produced. Shipments belonging to another instance are not returned.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Every filter[<column>] parameter also accepts an operator suffix as filter[<column>.<operator>]=<value>; a bare filter[<column>]=<value> is treated as "is". filter[search] does a fuzzy partial match across tracking_number, external_shipment_id, carrier_code, and service_code.
Sort field. Prefix with - for descending. Allowed: id, external_shipment_id, tracking_number, carrier_code, service_code, shipment_cost, ship_date, voided, writeback_status, created_at, updated_at. Default: -id (newest first).
Results are paginated; per_page defaults to 10.
Authenticate with a 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.