List Shipments
GET/api/shippit/instances/:integration_instance/shipments
List shipments (consignments) for the shipping-provider instance, paginated. Each shipment carries the despatch data — courier job, tracking number and URL, service level, price, parcel count, and despatch/delivery timestamps — a deep link into the Shippit portal (external_url), plus a cross-link to the fulfillment it realized (link_type_label / link_reference / link_route). Shipments belonging to another instance are not returned.
Sort field. Prefix with - for descending. Allowed: id, shippit_order_id, courier_name, tracking_number, shipping_price, number_of_parcels, despatched_at, delivered_at, created_at, updated_at. Default: -id (newest first).
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.