Easypost pickups
The EasyPost pickup object and the allowed CRUD operations on the related resource endpoint
Last updated
The EasyPost pickup object and the allowed CRUD operations on the related resource endpoint
Last updated
Create an EasyPost pickup and associate it with an to from the related carrier by leveraging our out-of-the-box integration with . Once a pickup is successfully created, the pickup rates of the carrier are automatically available for the given time frame and location. One of those pickup rates must then be selected and purchased to successfully schedule the pickup.
You can create a pickup associated with a shipment if:
The shipment status is ready_to_ship
.
The shipment is associated with at least one parcel.
A shipping label is already been purchased on EasyPost.
If the selected shipment is associated with multiple parcels, only the first one will be considered to create the related pickup. All the information about the total number of associated parcels (if any) and the related package size are available in the instructions
attribute.
To schedule a pickup you need to:
a pickup object. As minimum requirement you need to associate a shipment and set the pickup time window by passing a datetime value for the min_datetime
and max_datetime
attributes. If the selected shipment is the pickup is created in the unknown
status and the rates
array is populated with the available pickup rates of the related carrier.
the created pickup passing one of those rate IDs as the value of the selected_rate_id
attribute to select the desired pickup rate.
the created pickup passing the _purchase
trigger attribute to purchase the selected pickup rate and move the pickup to the scheduled
status.
Steps 2. and 3. can be executed within one single PATCH
request.
When you a pickup object on Commerce Layer, an attempt to cancel the corresponding pickup on EasyPost is performed. If the operation isn't successful (e.g. because the carrier is already on its way to pick up the package) the API will return an error.