Create a pickup

POST {{baseUrl}}/pickups

This endpoint allows you to schedule a pickup with a supporting carrier. You can schedule the pickup to take place from a location and time of your choosing, and include any additional instructions to the driver by including the special_instructions parameter. When a pickup is successfully scheduled a pickup id will be returned.

If you have more than one added active contracts for specific carrier, you must fill contract attribute with your desired contract's ID in your request. You can get your contracts ID from Retrieve a list of contracts.

Request Body

{"0"=>{"discriminator"=>{"propertyName"=>"carrier", "mapping"=>{"dhl_express"=>"#/components/schemas/DHLExpressPickupCreate", "fedex"=>"#/components/schemas/FedExPickupCreate", "correos_express"=>"#/components/schemas/CorreosExpressPickupCreate", "dhl"=>"#/components/schemas/DHLPickupCreate", "dpd"=>"#/components/schemas/DPDPickupCreate", "poste_it_delivery"=>"#/components/schemas/PosteITDeliveryPickupCreate", "correos"=>"#/components/schemas/CorreosPickupCreate", "ups"=>"#/components/schemas/UPSPickupCreate", "dhl_parcel_iberia"=>"#/components/schemas/DHLParcelIberiaPickupCreate"}}}, "1"=>{"discriminator"=>{"propertyName"=>"carrier", "mapping"=>{"dhl_express"=>"#/components/schemas/DHLExpressPickupCreate", "fedex"=>"#/components/schemas/FedExPickupCreate", "correos_express"=>"#/components/schemas/CorreosExpressPickupCreate", "dhl"=>"#/components/schemas/DHLPickupCreate", "dpd"=>"#/components/schemas/DPDPickupCreate", "poste_it_delivery"=>"#/components/schemas/PosteITDeliveryPickupCreate", "correos"=>"#/components/schemas/CorreosPickupCreate", "ups"=>"#/components/schemas/UPSPickupCreate", "dhl_parcel_iberia"=>"#/components/schemas/DHLParcelIberiaPickupCreate"}}}}

HEADERS

Key	Datatype	Required	Description
`Content-Type`	string
`Accept`	string

RESPONSES

status: Created

[{&quot;discriminator&quot;:{&quot;propertyName&quot;:&quot;carrier&quot;,&quot;mapping&quot;:{&quot;dhl_express&quot;:&quot;#/components/schemas/DHLExpressPickup&quot;,&quot;fedex&quot;:&quot;#/components/schemas/FedExPickup&quot;,&quot;correos_express&quot;:&quot;#/components/schemas/CorreosExpressPickup&quot;,&quot;dhl&quot;:&quot;#/components/schemas/DHLPickup&quot;,&quot;dpd&quot;:&quot;#/components/schemas/DPDPickup&quot;,&quot;poste_it_delivery&quot;:&quot;#/components/schemas/PosteITDeliveryPickup&quot;,&quot;correos&quot;:&quot;#/components/schemas/CorreosPickup&quot;,&quot;ups&quot;:&quot;#/components/schemas/UPSPickup&quot;,&quot;dhl_parcel_iberia&quot;:&quot;#/components/schemas/DHLParcelIberiaPickup&quot;}}},{&quot;discriminator&quot;:{&quot;propertyName&quot;:&quot;carrier&quot;,&quot;mapping&quot;:{&quot;dhl_express&quot;:&quot;#/components/schemas/DHLExpressPickup&quot;,&quot;fedex&quot;:&quot;#/components/schemas/FedExPickup&quot;,&quot;correos_express&quot;:&quot;#/components/schemas/CorreosExpressPickup&quot;,&quot;dhl&quot;:&quot;#/components/schemas/DHLPickup&quot;,&quot;dpd&quot;:&quot;#/components/schemas/DPDPickup&quot;,&quot;poste_it_delivery&quot;:&quot;#/components/schemas/PosteITDeliveryPickup&quot;,&quot;correos&quot;:&quot;#/components/schemas/CorreosPickup&quot;,&quot;ups&quot;:&quot;#/components/schemas/UPSPickup&quot;,&quot;dhl_parcel_iberia&quot;:&quot;#/components/schemas/DHLParcelIberiaPickup&quot;}}}]