Skip to main content

List Order Shipments

GET 
/api/trackstar/integration-instances/:integration_instance/order-shipments

List outbound fulfillment shipments for a Trackstar integration instance, with pagination, filtering, and sorting.

Authentication: Requires Bearer token.

Each shipment is scoped to the integration instance through its parent order.

Search:

  • filter[search]: Partial match across tracking_number, trackstar_shipment_id, carrier, and shipping_method

Operator filters use the form filter[column.operator]=value (a bare filter[column]=value is treated as an exact 'is' match):

  • Text columns (tracking_number, trackstar_shipment_id, carrier, shipping_method): is, is_not, contains, does_not_contain, starts_with, ends_with, is_one_of, is_not_one_of, is_empty, is_not_empty
  • Numeric columns (id, shipping_cost): is, is_not, greater_than, less_than, greater_than_or_equal, less_than_or_equal, between, is_one_of, is_empty, is_not_empty
  • Date-time columns (shipped_at, created_at, updated_at): is, before, after, on_or_before, on_or_after, between, today, yesterday, past_week, past_month, past_year, past_days, is_empty, is_not_empty

Allowed sorts: id, trackstar_shipment_id, tracking_number, carrier, shipping_method, shipping_cost, shipped_at, created_at, updated_at Default sort: -shipped_at Pagination default: 10 per page

Request​

Responses​

OK

Response Headers
    Content-Type