List Packages
GET/api/starshipit/integration-instances/:integration_instance/packages
Paginated list of packages across all orders for this Starshipit integration instance. Each package is promoted out of its parent order's json_object.packages[] array into its own row so packages are searchable by their per-package tracking_number (multi-package orders carry distinct tracking numbers that the order-level tracking_number drops).
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
Supports Spatie QueryBuilder filtering, sorting, and pagination.
Filters:
filter[search]— partial match across tracking_number, starshipit_package_id, carrier_service_name, and the parent order's order_numberfilter[delivery_status]— exact match on delivery status (e.g. Pending, InTransit, Delivered)filter[order_id]— exact match on the local parent order id (starshipit_orders.id)- Advanced per-column operators are available for: id, tracking_number, starshipit_package_id, name, carrier_service_name, carrier_service_code, delivery_status, packaging_type, shipment_type, weight (numeric), label_created_date, created_at, updated_at (datetime)
Allowed sorts: id, tracking_number, name, weight, delivery_status, carrier_service_name, packaging_type, shipment_type, label_created_date, created_at, updated_at, order (sorts by the related order number) (prefix with - for DESC; default -id).
Pagination: page (default 1), 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.