Skip to main content

List Instance Trackings

GET 
/api/integrations/17track/instances/:instance/trackings

Paginated list of shipment tracking rows belonging to one 17TRACK integration instance.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Filters (filter[...]):

  • search — contains match on tracking number or carrier name
  • tracking_number, delivery_status, carrier_name — text filters; the bare key is an exact match (comma-separated values match any of them), and filter[<field>.<operator>] takes any of 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
  • carrier_code — numeric filter (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)
  • trackable_type — one type slug: sales_order_fulfillment (or fulfillment), inbound_shipment, warehouse_transfer_shipment (or transfer), rma, vendor_credit_shipment (or vendor_credit)
  • created_at, last_event_at, delivered_at, estimated_delivery_at — date filters, filter[<field>.<operator>] with is, is_not, before, after, on_or_before, on_or_after, between, is_empty, is_not_empty, today, yesterday, past_week, past_month, past_year, past_days, days_ago, .... Dates are Y-m-d in the account timezone; between takes two comma-separated dates.

filter_groups accepts a base64-encoded JSON filter tree for AND/OR combinations: {"conjunction": "and", "children": [{"type": "condition", "condition": {"column": "<field>.<operator>", "operator": "<operator>", "value": "..."}}, {"type": "group", "group": {"conjunction": "or", "children": [...]}}]}. When it is present it takes precedence over the flat filter[...] parameters.

Unknown filter names are rejected with 400 Bad Request.

Allowed sorts: id, created_at, last_event_at, delivered_at (default: -created_at).

Responses:

  • 200 OK — paginated tracking rows
  • 400 Bad Request — a filter name that is not allowed
  • 404 Not Found — instance id does not exist

Authentication: Bearer token (Personal Access Token).

Request​

Responses​

OK

Response Headers
    Content-Type