Sign in
Proxy

Schedule a pickup

Schedule one or many parcels pickup

post/v1/proxy/pickups/{carrier_name}

Path parameters

carrier_name'allied_express' | 'allied_express_local' | 'amazon_shipping' | 'aramex' | 'asendia_us' | 'australiapost' | 'boxknight' | 'bpost' | 'canadapost' | 'canpar' | 'chronopost' | 'colissimo' | 'dhl_express' | 'dhl_parcel_de' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'easyship' | 'eshipper' | 'fedex' | 'fedex_ws' | 'freightcom' | 'generic' | 'geodis' | 'hay_post' | 'laposte' | 'locate2u' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sapient' | 'seko' | 'sendle' | 'tge' | 'tnt' | 'ups' | 'usps' | 'usps_international' | 'usps_wt' | 'usps_wt_international' | 'zoom2u' required

Request body

pickup_datestring required

The expected pickup date.<br/> Date Format: YYYY-MM-DD

ready_timestring required

The ready time for pickup.<br/> Time Format: HH:MM

closing_timestring required

The closing or late time of the pickup.<br/> Time Format: HH:MM

instructionstring nullable

The pickup instruction.<br/> eg: Handle with care.

package_locationstring nullable

The package(s) location.<br/> eg: Behind the entrance door.

optionsobject nullable

Advanced carrier specific pickup options

Response

Changes

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