Skip to main content

List Orders

GET 
/api/shippo/instances/:integration_instance/orders

Paginated Shippo orders for the instance. An order is created at Shippo for each fulfillment order pushed to it (or imported by the order sync). Each row includes the recipient address, totals, status (raw order_status plus a readable order_status_label), the label count (transactions_count), tracking_numbers (tracking numbers of the order's live labels — bought and not refunded), a "View in Shippo" link (external_url) and cross-link fields to the originating fulfillment order and sales order.

Not yet available to API tokens

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

Filtering: every filter[<column>] param below accepts an operator suffix, filter[<column>.<operator>]=<value>; list operators take a comma-separated value. Alternatively pass a nested AND/OR tree in filter_groups (base64-encoded JSON) — see that param.

Sorting: id, shippo_object_id, order_number, order_status, receiver_name, receiver_city, receiver_state, total_price, placed_at, details_last_updated, created_at, updated_at, transactions_count (default -id). Pagination: per_page defaults to 10.

Returns a standard paginated envelope: data[] plus current_page, from, to, per_page, total, last_page, first_page_url, last_page_url, next_page_url, prev_page_url, path and links. Returns 404 for an unknown instance.

Authentication: Requires a Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type