Schedule Pickup

Use this endpoint to schedule a pickup for shipments that have already been booked.

Only one pickup may be scheduled at a time, so the endpoint will return an error if you attempt to schedule pickups for shipments of more than one carrier at the same time. The endpoint will also return an error if you attempt to book a pickup for FedEx Ground shipments at the same time as FedEx Express shipments.

REST Endpoint

POST /restapi/v1/customers/:customerId/pickups

Request Content Type

application/json

Request JSON Example

{
  "carrierCode": "ups",
  "pickupDate": "2015-06-16",
  "readyTime": "09:00:00",
  "closeTime": "17:00:00",
  "bookNumbers": ["2317948", "2317949", "2317950"],
  "name": "Albert Jones",
  "company": "Jones Co.",
  "address1": "123 Some Street",
  "address2": "#54",
  "city": "Holladay",
  "state": "UT",
  "zip": "84117",
  "country": "US",
  "phone": "8015042351",
  "residential": false,
  "specialInstructions": "...",
  "packageLocation": "Front Desk"
}

Explanation of Request Fields

Field	Type	Required	Description
carrierCode	string	true	The carrier code (must match the carrier code of shipments listed in bookNumbers)
pickupDate	string	true	Desired pickup date (YYYY-MM-DD)
readyTime	string	true	Beginning of pickup window (HH:MM:SS)
closeTime	string	true	End of pickup window (HH:MM:SS)
bookNumbers	array of strings	true	Book numbers of the shipments that are to be picked up
name	string	true	Name of sender
company	string	true	Company name of sender
address1	string	true	Sender street address line 1
address2	string	true	Sender street address line 2
city	string	true	Sender city
state	string	true	Sender state/province (must be two-character code for US and CA)
zip	string	true	Sender zip or postal code
country	string	true	ISO two-character country code
phone	string	true	10-digit phone number
residential	boolean	false	Set to true if the pickup address is residential
specialInstructions	string	false	Special instructions for pickup driver
packageLocation	string	false	Specific location of package (Only applicable for DHL pickups)

Response Status Code

201 Created

Response Content Type

application/json

Response JSON Example

{
  "pickupId": "1234"
}

Explanation of Response Fields

Field	Type	Description
pickupId	string	Unique ID for this pickup