API Reference
Cabify BusinessAPI Support

Ship the specified parcels.

post
https://logistics.api.cabify-sandbox.com/v1/parcels/ship

Marks the given parcels as ready to ship using the specified shipping type.

The available shipping types for your account and location can be retrieved from the
GET /v1/shipping_types/available endpoint.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
parcel_ids
array of uuids
required

IDs of the parcels to ship.

parcel_ids*
string
required

Identifier of the shipping type to use, as returned for the pickup location by GET /v1/shipping_types/available. Opaque and environment-dependent: send it back exactly as it was returned.

date-time

Desired pickup time. Only applicable for the express modality. Formatted according to RFC 3339, section 5.6.

boolean
Defaults to false

Request a return leg: after the delivery, the rider goes back to the pickup point in the same journey. Returns must be enabled for the shipping type; asking for one on a shipping type without it fails with shipping type not enabled for return.

Responses

401

Unauthorized. Missing or invalid authentication token.

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.

Updated 5 months ago

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

Updated 5 months ago

Did this page help you?