Sign in
Pickups

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.

post/2024-09/pickups

Request body

courier_service_idstring uuid required

The unique identifier for the courier service.

time_slot_idstring uuid nullable

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

selected_datestring date required

Selected date for pickup

selected_from_timestring nullable

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

selected_to_timestring nullable

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

easyship_shipment_idsstring[] required

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

Response

pickup successfully created

Changes

No recorded changes to this endpoint across all 1 revision of this API.