Skip to main content

List Orders

GET 
/api/shippit/instances/:integration_instance/orders

Paginated, filterable list of Shippit orders for the integration instance.

Every filter[<column>] parameter also accepts an operator suffix as filter[<column>.<operator>]=<value>; a bare filter[<column>]=<value> is treated as "is".

  • Text columns support: contains, does_not_contain, is, is_not, is_one_of, is_not_one_of, starts_with, does_not_start_with, ends_with, does_not_end_with, is_empty, is_not_empty.
  • Numeric columns support: is, is_not, is_one_of, is_not_one_of, greater_than, less_than, greater_than_or_equal, less_than_or_equal, between, is_empty, is_not_empty.
  • Date columns support: is, is_not, before, after, on_or_before, on_or_after, between, today, yesterday, tomorrow, past_week, past_month, past_year, next_week, next_month, next_year, days_ago, days_from_now, past_days, next_days, is_empty, is_not_empty.

filter[search] does a fuzzy partial match across tracking_number, retailer_order_number, retailer_reference, receiver_name and courier_name.

Sort with the sort parameter (prefix - for descending). Allowed sort fields: id, shippit_id, state, courier_type, courier_name, tracking_number, receiver_name, retailer_order_number, retailer_reference, price, expected_delivery_date, details_last_updated, created_at, updated_at. The default sort is -id (newest first).

Results are paginated; per_page defaults to 10.

Authentication: requires a Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type