Create a Pickup

Schedule a pickup.

Required authorization scope: public.pickup:write

Only available if your courier provides pickup options.

Select a pickup time

After retrieving a courier's pickup slots, you can specify a pickup time in time_slot_id or in selected_from_time and selected_to_time.

Body Params
uuid
required

The unique identifier for the courier service.

uuid | null

Time Slot ID from Courier List Available Pickup Slots API. Optional if selected_from_time and selected_to_time are provided.

date
required

Selected date for pickup

string | null

Selected from time for pickup. Optional if a time_slot_id is provided.

string | null

Selected to time for pickup. Optional if a time_slot_id is provided.

easyship_shipment_ids
array of strings
required

All shipments to be requested. Shipments must have the same courier and their labels must be pending or generated.

easyship_shipment_ids*
Responses

Language
Credentials
Bearer
token
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json