Schedule a Pickup

HTTP Request

POST /api/v1/pickups

Parameters

Attribute	Required	Type	Specification
carrier	`required`	string	The Carrier `pickup_carrier` key from the previous step
company	`required`	string	Name of the organization
contact_name	`required`	string	Name of the person.
phone	`optional`	string	Phone number to reach the person or organization
address_1	`required`	string	First line of the address
address_2	`optional`	string	Second line of the address
city	`required`	string	City the address is located in
zip_postal	`required`	string	ZIP or postal code the address is located in
province_state	`required`	string	For Canadian Provinces and US states use two letter abbreviation.
country	`required`	string	Two-letter ISO 3166 country code.
min_datetime	`required`	datetime	Expecting in the following format Y-m-d H:i:s
max_datetime	`required`	datetime	Same format as `min_datetime`. Has to later than the `min_datetime`.
pickup_instructions	`optional`	string	For example: Please use side door
number_of_boxes	`required`	numeric	Number of boxes to be picked-up
total_weight	`required`	numeric	First line of the address
weight_unit	`required`	string	LB or KG

Example

  carrier: 'FedEx'
  company: 'LABELNSHIP CORP'
  contact_name: 'LABELNSHIP CORP'
  phone: '514-555-5555'
  address_1: '22 ATLAS AVE'
  city: 'YORK'
  province_state: 'ON'
  country: 'CA'
  zip_postal: 'L4J3J8'
  min_datetime: '2021-10-20 12:00:00'
  max_datetime: '2022-10-20 17:00:00'
  pickup_instructions: 'Please use side door'
  number_of_boxes: 1
  total_weight: 1
  weight_unit: 'LB'

  {
      "success": true,
      "pickup_id": 1324,
      "pickup_confirmation_number": "YKZA-131"
  }

  {
    "success": false,
    "errors": [
      "Severity: ERROR",
      "Source: disp",
      "Code: 508C",
      "Message: Cannot schedule a pickup request for a previous day",
      "LocalizedMessage: Cannot schedule a pickup request for a previous day"
    ]
  }