Create a pickup. Applicable for FedEx, UPS, DHL Express, Purolator.
Content-Type
Create a pickup object.
Pickup Date should be provided in YYYY-MM-DD format. If it is not provided, it will default to today's date in the shipper account's timezone
Preferred start time for pickup in HH:mm:ss
Preferred end time for pickup in HH:mm:ss
Address object: the description of address information
address_line1 of address
Country in ISO 3166-1 alpha 3 code
contact_name of address
contact_phone of address
fax_number of address
email of address
company_name of address
address_line2 of address
address_line3 of address
city of address
state of address
postal_code of address
type of address
tax id
tax id type. Only applies to DHL Express, DHL eCommerce US, DHL eCommerce UK.
identification number
identification type
eori number
Address object: the description of address information
The id of labels that need to pickup. If label_ids are present, pickup_parcels should not be present
Parcel detail information which to be pickup. If label_ids are not present, pickup_parcels are required. When pickup_parcels are present, shipper_account is required
Weight object: unit weight of the item
The quantity of the packages. Minimum: 1
Service Type. Required for UPS and DHL Express
Dimension object: the description of width/height/depth information
Shipper Account which register in Shipping. If pickup_parcels are present, shipper_account is required
id of referring object
Enum of shipments location which provided by the carrier. For more detailed information, please refer to the help article.
If you have any instructions for the pickup, they can be used as a note for some carriers
Create a pickup object.
Meta data object.
Code of Meta
Message of Meta
Details of Meta
Whether this request will be retryable or not
Pickup object: the description of pickup information
Pickup ID
The confirmation numbers dispatch from carrier when pickup success
The pickup location code dispatch from carrier when pickup success
Pickup Date in YYYY-MM-DD
A formatted date
A formatted date
Address object: the description of pickup address information
Address object: the description of address information
Labels array, it contains all the label need to pickup
Parcel detail information
Reference object: the description of reference information
A formatted date
A formatted date
{
"pickup_date": "2023-09-21",
"pickup_start_time": "09:00:00",
"pickup_end_time": "18:00:00",
"pickup_from": {
"contact_name": "AfterShip Shipping",
"company_name": "AfterShip Shipping",
"street1": "230 W 200 S LBBY",
"city": "Salt Lake City",
"state": "UT",
"postal_code": "84101",
"country": "USA",
"phone": "123456789",
"email": "[email protected]"
},
"label_ids": [
"00000000-0000-0000-0000-000000000000"
],
"pickup_instructions": "instructions"
}{ "meta": { "code": 200, "type": "OK", "message": "Everything worked as expected." }, "data": { "id": "00000000-0000-0000-0000-000000000000", "status": "created", "pickup_confirmation_numbers": [ "3012" ], "pickup_date": "2023-09-21", "pickup_start_time": "09:00:00", "pickup_end_time": "18:00:00", "pickup_from": { "contact_name": "AfterShip Shipping", "company_name": "AfterShip Shipping", "street1": "230 W 200 S LBBY", "city": "Salt Lake City", "state": "UT", "postal_code": "84101", "country": "USA", "phone": "123456789", "email": "[email protected]" }, "ship_to": null, "label_ids": [ "00000000-0000-0000-0000-000000000000" ], "shipper_account": { "id": "00000000-0000-0000-0000-000000000000", "slug": "fedex" }, "pickup_parcels": [ { "weight": { "value": 1, "unit": "lb" }, "quantity": 1 } ], "created_at": "2023-09-21T07:54:13.024Z", "updated_at": "2023-09-21T07:54:13.024Z" } }