Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cabify parcels API

A parcel is the package you need to ship. Each parcel is identified by a unique ID and contains a pickup point (where the driver collects the package) and a drop-off point (the destination). Parcels must be created before they can be shipped.

Cabify parcels API is one of 13 APIs that Cabify publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include parcels. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and a changelog.

This API exposes 11 operations across 7 paths, and defines 20 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against 2 base URLs: https://logistics.api.cabify.com, https://logistics.api.cabify-sandbox.com.

11 operations 7 paths 20 schemas 5 GET5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://cabify.com/api/v4
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Cabify parcels API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearer_token).

Paths & Operations 11

Across 7 paths, the API surfaces 11 operations — 5 GET, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

parcels 11

A parcel is the package you need to ship. Each parcel is identified by a unique ID and contains a pickup point (where the driver collects the package) and a drop-off point (the de…

POST
/v1/parcels
Create new parcels.
addParcels body → 200400401409422
GET
/v1/parcels
List parcels filtered by state.
getParcels 2 params → 200400401
POST
/v1/parcels/{parcel_id}/proof_configuration
Set proof of delivery configuration for a parcel.
createProofConfigurationParcel 1 param body → 200401404
GET
/v1/parcels/{parcel_id}/proof_configuration
Get proof of delivery configuration for a parcel.
proofConfigurationParcel 1 param → 200401404
POST
/v1/parcels/delete
Delete parcels by ID.
deleteParcels body → 202401404
GET
/v1/parcels/{parcel_id}
Get a parcel by ID.
getParcel 1 param → 200401404
PUT
/v1/parcels/{parcel_id}
Update a parcel by ID.
updateParcel 1 param body → 200400401403409422
GET
/v1/parcels/{parcel_id}/tip
Get the tip for a parcel.
getTipParcel 1 param → 200204401403404
POST
/v1/parcels/{parcel_id}/tip
Add a tip for a parcel delivery.
tipParcel 1 param body → 200401403404409429
GET
/v1/parcels/{parcel_id}/label
Get the shipping label for a parcel.
labelParcel 1 param → 200401403404
POST
/v1/parcels/{parcel_id}/notify
Notify an event for the given parcel.
notifyParcel 1 param body → 202400403404409422500

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are Parcel (9 properties), NewParcel (8 properties), UpdateParcel (8 properties), ParcelPointPickupInfo (6 properties). Each schema is shown below with its type and property counts.

Tip
object
3 properties
NewParcelPickupContact
object
2 properties
Price
object
Price information for the parcel, used in cash-on-delivery scenarios.
3 properties
Point
object
A geographic coordinate expressed as latitude and longitude.
2 properties 2 required
ParcelPointPickupInfo
object
Information about the pickup point. You must provide exactly one of the following location fields: loc (coordinates), addr (address string), or hubexternalid (…
6 properties 1 required
NewParcelDropoffContact
object
2 properties
ProofConfiguration
object
The proof of delivery methods configured for a parcel.
2 properties 2 required
CreateProofConfiguration
object
Request body for creating or replacing proof of delivery configuration for a parcel.
1 property
DeleteParcels
object
1 property 1 required
NewParcels
object
1 property 1 required
PaginatedParcels
object
4 properties 4 required
CreateTip
object
1 property 1 required
ParcelWeight
object
Weight of the parcel.
2 properties
UpdateParcel
object
Fields that can be updated on an existing parcel. Only fields included in the request will be modified.
8 properties
ParcelDimensions
object
Physical dimensions of the parcel.
4 properties
ParcelPointDropoffInfo
object
Information about the drop-off (destination) point. You must provide exactly one of the following location fields: loc (coordinates), addr (address string), or…
5 properties 1 required
Parcels
object
1 property 1 required
Parcel
object
9 properties
RequestError
object
Standard error response body returned when a request fails.
1 property 1 required
NewParcel
object
8 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cabify-parcels-api-openapi.yml Raw ↑

Other APIs Cabify publishes across the network.

Cabify delivery API
Cabify Estimates API
Cabify hubs API
Cabify Journeys API
Cabify label API
Cabify Labels API
Cabify Sales API
Cabify shipment API
Cabify shipping_types API
Cabify status API
Cabify users API
Cabify webhooks API