Sign in
Pickups

Cancel a pickup

Cancel a pickup of one or more shipments.

post/v1/pickups/{id}/cancel

Path parameters

idstring required

Request body

reasonstring

The reason of the pickup cancellation

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.