Introduction to Cabify Logistics API

Welcome to the Cabify Logistics Platform User Guide!

In this guide, you will find all the necessary information to interact with our system and easily, efficiently, and securely make your shipments using our platform.

We have divided the guide into different sections so you can quickly and easily find the information you need.

How to interact with us: Here you will find a guide to the different methods of interacting with our platform.
Main entities: Here you will find a guide to the main entities you can perform on our platform.
Main operations: Here you will find a guide to the main operations you can perform on our platform.
Parcels life cycle: Here you will find a guide to the different statuses a parcel goes through on our platform.
Proofs: Here you will find a guide to the different types of delivery or pickup proofs you can obtain for your shipments.
Notifications: Here you will find a guide to the different types of notifications the shipment recipient will receive.
Ecomerce integrations: Here you will find a guide on how to integrate our platform with some of the leading ecommerce platforms in the market.

If you have any questions or need additional help, don’t hesitate to contact us sending an email to [email protected]. We will be happy to assist you with whatever you need.

Basic concepts

Our logistics platform has some basic concepts you need to understand before starting. Here you have a brief explanation of them:

Order: An order is a buying request from a customer. It can contain one or more parcels.
Fullfilment: A fullfilment is the process of preparing orders into parcels.
Parcel: A parcel is the main entity in our platform. It represents a box that contains something to be shipped.
Shipping type: A shipping type is the way the parcel will be shipped. It can be express, same day, next day...
Shipment: A shipment is a group of parcels requested to be sent with the same shipping type.
Proof of delivery: A proof of delivery is the necessary data that certifies that the recipient has received the parcel like a signature, a photo or a code.
Proof of pickup: A proof of pickup is the necessary data that certifies that the sender has delivered the parcel to the carrier like a signature, a photo or a code.
Proof of non delivery: A proof of non delivery is the necessary data that certifies that the driver has tried to deliver the parcel but can not be done for several reasons, could be photo, location, etc.
Tracking number: A tracking number is a unique identifier that allows you to track the status of a shipment.
Notification: A notification is a message that is sent to the recipient with the access to the parcel tracking web page.
Ecommerce integration: An ecommerce integration is the process of connecting our platform with an ecommerce platform to automate the shipment process.

And we handle three main stakeholders in our platform:

Sender: The sender is the person who sends the parcel.
Recipient: The recipient is the person who receives the parcel.
Requester: The requester is the person who creates and ship the parcel in our platform.

Note that in some cases, the sender can be the same as the requester, the recipient can be the same as the requester, or the three of them can be different persons.

Basic flow of a shipment:

The sender/requester receives an order from a customer.
The sender prepares the order into parcel(s).
The sender/requester creates a parcel in our platform.
The sender/requester selects the shipping type for the parcel(s).
The sender/requester creates a shipment in our platform with the parcel(s).
The sender/requester prints the shipping label and attaches it to the parcel(s) (only for shipping types that requires an intermediate warehouse).
We pick up the parcel(s) and delivers it to the recipient.
The recipient receives the notification with the tracking.
The driver fills all necessary proofs of delivery or non delivery in case of any issue.
The recipient receives the parcel.