ShipEngine includes the ability to schedule carrier pickups for supported carriers. For shipments created with non-supported carriers, you must schedule pickups with the carrier directly.
At this time, you can schedule pickups with ShipEngine for the following carriers:
Schedule a Pickup
Schedule pickups via the /v1/pickups endpoint. To schedule pickups, you will need a list of label IDs.
The pickup location will be the Ship From location or the warehouse ID’s origin address that you used when creating the specified labels.
NOTE: All label IDs must have the same carrier and warehouse ID for the pickup to be scheduled successfully.
Cancel a Pickup
There may be times when you need to cancel previously scheduled pickups. 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. 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"
}]
}
You can also list your pickups to find pickup IDs.
NOTE: Some carriers have rules pertaining to how close to the pickup window a pickup can be cancelled. Please check with the carrier for more information.