Sign in
Pickups

Schedule a pickup

Schedule a pickup for one or many shipments with labels already purchased.

post/v1/pickups/{carrier_name}/schedule

Path parameters

carrier_namestring 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

tracking_numbersstring[] required

The list of shipments to be picked up

metadataobject

User metadata for the pickup

Response

idstring

A unique pickup identifier

object_typestring

Specifies the object type

carrier_namestring required

The pickup carrier

carrier_idstring required

The pickup carrier configured name

confirmation_numberstring required

The pickup confirmation identifier

pickup_datestring nullable

The pickup date

ready_timestring nullable

The pickup expected ready time

closing_timestring nullable

The pickup expected closing or late time

metadataobject

User metadata for the pickup

metaobject nullable

provider specific metadata

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

test_modeboolean required

Specified whether it was created with a carrier in test mode

Changes

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