Skip to main content
GET
Requires the consignments:read scope.
​
integer
default:"25"
Number of consignments to return per page.
​
integer
default:"0"
Number of consignments to skip.
​
string
Free-text search across references (shipment ref, external code, order ref, invoice number), parties, and every tracking number or barcode a parcel carries — including each carrier leg’s tracking and master tracking number (first, middle and last mile).
​
string
Comma-separated list of references to match exactly (case-insensitive). Matches a consignment’s shipment_ref, external_code, or any of its orders’ order_ref.
​
string
Filter by consignment status.
​
number
Only consignments whose total item value (unit amount × quantity, summed over items declared in total_value_ccy) is at least this. Requires total_value_ccy.
​
number
Only consignments whose total item value in total_value_ccy is at most this.
​
string
ISO 4217 currency for the total-value filter. Items in other currencies are not converted or counted.
​
string
default:"between"
over (greater than total_value_min), below (less than total_value_max), equal (equal to total_value_min) or between (inclusive min–max).
​
integer
Number of item lines on the consignment. Use with item_count_op.
​
integer
Upper bound for the item-line count.
​
string
default:"between"
over, below, equal or between — same semantics as total_value_op.
​
array
The page of consignments, newest first.
​
integer
Total consignments matching the filter.