Pickups

The pickup object and the allowed CRUD operations on the related resource endpoint

By creating a pickup associated with a shipment you can schedule a pickup from a carrier at your customer's residence or place of business and define a dedicated pickup time window. Pickup availability and price may be heavily based on location, day of the week, service level, and specific carrier.

For any information and restrictions on how to create a pickup, please check the specific pickup type endpoint. At the moment the following types of pickup are available (more to come):

• EasyPost — leverage our out-of-the-box integration with EasyPost, featuring 100+ carriers.

Data model

Check the related ER diagram and explore the flowchart that illustrates how the pickup resource relates to the other API entities.

This is an immutable API, meaning that create, update, and delete operations are not allowed on this endpoint. You can only fetch a list of pickups or a single pickup object. For the full set of available CRUD actions, refer to the specific pickup type endpoints.