v1
latestOpenAPI 3.0.32026-07-26170311887.2 KBPickups
List all Pickups
Retrieve a list of pickups.
Required authorization scope: public.pickup:read
get/2024-09/pickups
Query parameters
pageinteger
Page number to fetch, default: 1
per_pageinteger
Number of records per page to fetch, default: 20
pickup_datestring date
Selected pickup date. Only accept YYYY-MM-DD format.
courier'USPS' | 'Australia Post eParcel' | 'StarTrack' | 'Royal Mail' | 'DHL eCommerce' | 'Canada Post' | 'Quantium'
Courier name
pickup_state'cancelled' | 'completed' | 'partially-completed' | 'pending-confirmation' | 'pending-delayed-api-request' | 'pending-drop-off' | 'pending-handover' | 'request-failed' | 'request-pickup-window-failed' | 'request-technical-failed' | 'requested'
Pickup state
shipment_idstring
Shipment ID
Response
list of pickups