You can schedule pickups in ShipEngine via the Schedule a Carrier Pickup endpoint for the following carriers:
For shipments created with non-supported carriers, you must schedule pickups with the carrier directly.
To schedule a pickup via the Schedule a Carrier Pickup endpoint, you will need to list the label IDs for the shipments you want to be picked up. Learn more about making a List Labels call to retrieve your label IDs.
The pickup location will be your account Ship From location or the origin address of the warehouse_id used when creating the specified labels.
Important
All label IDs must have the same carrier and warehouse_id for the pickup to be scheduled successfully.
To cancel a previously scheduled pickup, you will need the pickup_id. The pickup_id will be included in the response data when scheduling a pickup. You can also make a call to List Your Pickups to retrieve the pickup_id.
Below is an example response where you can find the pickup_id:
{
"pickup_id": "pik_3YcKU5zdtJuCqoeNwyqqbW",
"label_ids": [
"se-28529731"
],
"created_at": "2018-09-23T15:00:00.000Z",
"cancelled_at": "2018-09-23T15:00:00.000Z",
"carrier_id": "se-28529731",
"warehouse_id": "se-28529731",
"confirmation_number": "292513CL4A3",
"contact_details": {
"name": "string",
"email": "john.doe@example.com",
"phone": "strings"
},
"pickup_notes": "string",
"pickup_window": [{
"start_at": "2019-11-11T15:00:00.000Z",
"end_at": "2018-11-11T15:00:00.000Z"
}]
}
Note
Some carriers have rules pertaining to how close to the pickup window a pickup can be canceled. Please check with the carrier for more information.
