Create new parcels.

Create one or more parcels to be shipped. Note that creating a parcel does not trigger a delivery — you must call /v1/parcels/ship afterwards to schedule the pickup.

Each parcel requires a pickup and a drop-off location. You can provide a location using at least one of the following fields in the pickup_info or dropoff_info schemas: loc (coordinates), addr (address string), or hub_external_id (reference to a registered hub). They may be combined; coordinates take precedence.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

List of parcels you want to create.

parcels
array of objects
required
parcels*
Responses

401

Unauthorized. Missing or invalid authentication token.

409

Conflict. A parcel with the provided external_id already exists.

429

Too many requests. This API is rate limited per account and per endpoint. A 429 is an expected condition rather than a failed request: back off and retry it. The limits are not the same for every endpoint and can change, so handle the status instead of hard-coding a rate. See the Limits and reliability guide.

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json