# Cabify Developer Hub Documentation > Cabify API provides an interface to interact with our services as well as to automate operations that will allow you to scale up your operations. ## Guides: GETTING STARTED - [Welcome](https://cabify-api.readme.io/docs/getting-started.md) - [Quickstart](https://cabify-api.readme.io/docs/quickstart.md) - [1. Create or login](https://cabify-api.readme.io/docs/create-or-login.md) - [2. Get your API key](https://cabify-api.readme.io/docs/get-your-api-key.md) - [3. Get your Access Token](https://cabify-api.readme.io/docs/get-your-access-token.md) - [Sandbox Environment](https://cabify-api.readme.io/docs/sandbox-environment.md) - [Commercial use and billing model](https://cabify-api.readme.io/docs/billing-model.md) ## Guides: ride-hailing - [Introduction to Cabify Ride Hailing API](https://cabify-api.readme.io/docs/ride-hailing.md) - [Users Management](https://cabify-api.readme.io/docs/users.md) - [Pricing & Estimates](https://cabify-api.readme.io/docs/estimates.md) - [Polyline Algorithm](https://cabify-api.readme.io/docs/polyline-algorithm.md) - [Journeys Booking](https://cabify-api.readme.io/docs/journeys.md) - [Journey States](https://cabify-api.readme.io/docs/journey-states.md) - [Journey Labels](https://cabify-api.readme.io/docs/labels.md) - [Journey Sales](https://cabify-api.readme.io/docs/sales.md) - [Rectified sale](https://cabify-api.readme.io/docs/rectified-sale.md) - [Flexible Rides](https://cabify-api.readme.io/docs/flexible-rides.md) - [Webhooks](https://cabify-api.readme.io/docs/webhooks.md) - [Webhook Headers](https://cabify-api.readme.io/docs/webhook-headers.md) - [Asynchronous Jobs](https://cabify-api.readme.io/docs/asynchronous-jobs.md) - [Journey Real-time Updates](https://cabify-api.readme.io/docs/journey-updates-webhook.md) - [Journey State Updates](https://cabify-api.readme.io/docs/journey-events.md) - [Journey Location Updates](https://cabify-api.readme.io/docs/location-updates.md) - [Journey Public Info Updates](https://cabify-api.readme.io/docs/public-info-updates.md) - [Flexible Rides State Updates](https://cabify-api.readme.io/docs/flexible-rides-events.md) - [Journey Creation Use Cases](https://cabify-api.readme.io/docs/use-cases.md) - [Ride-Hailing API Changelog](https://cabify-api.readme.io/docs/ride-hailing-changelog.md) ## Guides: logistics - [Getting started with Logistics API](https://cabify-api.readme.io/docs/getting-started-1.md) - [Introduction to Cabify Logistics API](https://cabify-api.readme.io/docs/introduction.md) - [Sandbox](https://cabify-api.readme.io/docs/sandbox.md) - [How interact with us](https://cabify-api.readme.io/docs/how-to-interact-with-us.md) - [Cabify Logistics DMS](https://cabify-api.readme.io/docs/dms.md) - [Parcel tracker](https://cabify-api.readme.io/docs/parcel-tracker.md) - Logistics API - [How to get your Logistics API key](https://cabify-api.readme.io/docs/logistics-steps.md) - [Get your Logistics API key](https://cabify-api.readme.io/docs/get-logistics-api-key.md) - [Main entities](https://cabify-api.readme.io/docs/main-entities.md) - [Parcel](https://cabify-api.readme.io/docs/parcel.md) - [Shipping type](https://cabify-api.readme.io/docs/shipping-type.md) - [Parcels life cycle](https://cabify-api.readme.io/docs/parcels-life-cycle.md) - [Parcel life cycle for express](https://cabify-api.readme.io/docs/parcel-life-cycle-for-express.md) - [Parcel life cycle for cross-dock](https://cabify-api.readme.io/docs/parcel-life-cycle-for-cross-dock.md) - [Proofs](https://cabify-api.readme.io/docs/proofs.md) - [Ecommerce integrations](https://cabify-api.readme.io/docs/ecommerce-integrations.md) - [Shopify](https://cabify-api.readme.io/docs/shopify.md) - [Tiendanube](https://cabify-api.readme.io/docs/tiendanube.md) - [VTEX](https://cabify-api.readme.io/docs/vtex.md) - [Error handling](https://cabify-api.readme.io/docs/error-handling.md) - [API error messages](https://cabify-api.readme.io/docs/api-error-messages.md) - [Coverage and availability](https://cabify-api.readme.io/docs/coverage-and-availability.md) - [Limits and reliability](https://cabify-api.readme.io/docs/limits-and-reliability.md) - [MCP server](https://cabify-api.readme.io/docs/mcp-server.md) - [Shipment options](https://cabify-api.readme.io/docs/shipment-options.md) ## API Reference: Ride-hailing API - Labels - [Get labels paginated](https://cabify-api.readme.io/reference/getlabels.md): Fetch labels paginated - [Update label](https://cabify-api.readme.io/reference/updatelabel.md): Modify an existing label - [Create a Label](https://cabify-api.readme.io/reference/createlabel.md): Creates a new label. - [Get label by Id](https://cabify-api.readme.io/reference/getlabelbyid.md): Fetch the label with the given Id - Estimates - [Create estimation](https://cabify-api.readme.io/reference/getestimation.md): Obtain prices, product IDs, and all the information for products that are available at the origin point. > ❗️ Important > > You **must** call this endpoint before creating a Journey. The response… - Journeys - [Create a journey](https://cabify-api.readme.io/reference/createjourney.md): Creates a new journey request for a ride. > ❗️ Prerequisites > > Before creating a journey, you **must** call the `/estimates` endpoint and use the returned > `product.id` as `product_id` in this… - [Keep searching drivers for a journey](https://cabify-api.readme.io/reference/keepsearching.md): If there are no drivers available after having created a journey (meaning you receive a 'not found' state via webhooks or via the GET journey/state endpoints), with this endpoint, you can continue… - [Get Journey State](https://cabify-api.readme.io/reference/getjourneystate.md): Returns the real-time operational state of an active journey: assigned driver, vehicle, and the route waypoints collected so far. Use this endpoint for live tracking while a journey is in progress.… - [Cancel Journey](https://cabify-api.readme.io/reference/canceljourney.md): Cancels an active journey. Journeys can only be cancelled free of charge before a driver has been assigned. After assignment, cancellation fees may apply if the courtesy period has elapsed (this… - [Get Journey details](https://cabify-api.readme.io/reference/getjourney.md): Returns the booking-level details of a journey: stops, pricing, timestamps, and lifecycle status. Use this endpoint to check whether a journey is finished, retrieve its cost breakdown, or read the… - Sales - [Get journey's sales](https://cabify-api.readme.io/reference/getjourneysales.md): Fetch the sales of the journey - [Fetch client's sales paginated](https://cabify-api.readme.io/reference/getsales.md): Get sales paginated - [Get user's sales paginated](https://cabify-api.readme.io/reference/getusersales.md): Fetch user's sales paginated - Flexible Rides - [Lists Flexible Rides](https://cabify-api.readme.io/reference/listflexiblerides.md): Returns a paginated list of flexible rides, that can be filtered by status. - [Create a Flexible Ride](https://cabify-api.readme.io/reference/createflexibleride.md): Creates a new Flexible Ride. > ❗️ Prerequisites > > Before creating a flexible ride, you should call the `/estimates` endpoint and use the returned > `product.id` as `product_id` in this request.… - [Cancel a Flexible Ride](https://cabify-api.readme.io/reference/cancelflexibleride.md): Cancels and returns a Flexible Ride. - [Get a Flexible Ride](https://cabify-api.readme.io/reference/getflexibleride.md): Returns a flexible ride. - [Update a Flexible Ride](https://cabify-api.readme.io/reference/updateflexibleride.md): Updates a Flexible Ride. Only a Flexible Ride that is on `pending` status can be updated. > ⚠️ Claimable Since and Expiration > > Take care that if the `claimable_since` field is updated, the… - Hubs - [Get Hub by coordinates](https://cabify-api.readme.io/reference/gethub.md): Look up hub meeting-point data for a given set of coordinates. A **hub** is a large venue (e.g. airport, train station) with designated pick-up/drop-off meeting points. Use this endpoint to… - Users - [Get Users in bulk](https://cabify-api.readme.io/reference/getusers-1.md): Gets multiple Users - [Update Users in bulk](https://cabify-api.readme.io/reference/updateusers.md): Update Users in bulk - [Create Users in bulk](https://cabify-api.readme.io/reference/createusers.md): Create Users in bulk - [Get User by email](https://cabify-api.readme.io/reference/getuserbyemail.md): Gets a User by email - [Get User by ID](https://cabify-api.readme.io/reference/getuserbyid.md): Get User by id ## API Reference: Logistics API - parcels - [Create new parcels.](https://cabify-api.readme.io/reference/addparcels.md): 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… - [List parcels filtered by state.](https://cabify-api.readme.io/reference/getparcels.md): Returns a paginated list of parcels that match the specified states. - [Get a parcel by ID.](https://cabify-api.readme.io/reference/getparcel.md): Returns the full details of a parcel identified by its UUID. - [Update a parcel by ID.](https://cabify-api.readme.io/reference/updateparcel.md): Update editable fields of an existing parcel. The set of fields that can be modified depends on the parcel's current state: **All fields** can be updated when the parcel is in one of these states:… - [Delete parcels by ID.](https://cabify-api.readme.io/reference/deleteparcels.md): Permanently deletes the specified parcels. Only parcels that have not yet been shipped can be deleted. This is an **all-or-nothing** operation — if any parcel cannot be deleted, none of the parcels… - [Notify an event for the given parcel.](https://cabify-api.readme.io/reference/notifyparcel.md): Sends an event notification for the specified parcel. Currently, only the `ready_to_pickup` event is supported. This event is typically used in food delivery workflows to signal that an order is… - [Add a tip for a parcel delivery.](https://cabify-api.readme.io/reference/tipparcel.md): > **Note:** This feature is not available to all clients. Please contact us before using it. Adds a tip for the driver in the event of a successful delivery. The tip can be set at any point before… - [Get the tip for a parcel.](https://cabify-api.readme.io/reference/gettipparcel.md): > **Note:** This feature is not available to all clients. Please contact us before using it. Returns the tip configured for the specified parcel, if one exists. - [Get proof of delivery configuration for a parcel.](https://cabify-api.readme.io/reference/proofconfigurationparcel.md): Returns the proof of delivery methods currently configured for the specified parcel. - [Set proof of delivery configuration for a parcel.](https://cabify-api.readme.io/reference/createproofconfigurationparcel.md): Creates or replaces the proof of delivery methods configured for the specified parcel. - [Get the shipping label for a parcel.](https://cabify-api.readme.io/reference/labelparcel.md): Returns the shipping label for the specified parcel as a PDF. This label is scanned by the driver during pickup and delivery operations. - delivery - [Cancel the delivery of the specified parcels.](https://cabify-api.readme.io/reference/cancelparcels.md): Cancels an in-progress delivery for the given parcels, when cancellation is still permitted. Delivery cannot be cancelled once the parcel has been picked up. Cancellation is allowed in the following… - status - [Get the current status of a parcel.](https://cabify-api.readme.io/reference/statusparcel.md): Returns the current state and tracking information for the specified parcel. - [Get the state history of a parcel.](https://cabify-api.readme.io/reference/timelineparcel.md): Returns the ordered list of state-change events for the specified parcel. Only parcels updated within the last 30 days can be queried. - [Getting started with Logistics API](https://cabify-api.readme.io/reference/getting-started-1.md) - label - [Get the warehouse label for a parcel (deprecated).](https://cabify-api.readme.io/reference/warehouselabelparcel.md): **This endpoint is deprecated.** Please use [GET /v1/parcels/{parcel_id}/label](https://developers.cabify.com/reference/labelparcel) instead. - shipment - [Ship the specified parcels.](https://cabify-api.readme.io/reference/shipparcels.md): 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… - [Estimate the cost and timing of a shipment.](https://cabify-api.readme.io/reference/estimateshipparcels.md): Calculates the estimated price, pickup time, and delivery time for the given parcels using the specified shipping type. The response also includes the `asset_kind` (vehicle type) that would be… - [Sandbox](https://cabify-api.readme.io/reference/sandbox.md) - shipping_types - [List available shipping types for a location.](https://cabify-api.readme.io/reference/shippingtypesavailable.md): Returns the shipping types available to your account for a given pickup location. The available options are determined by your account configuration and the geographic region of the provided… - hubs - [Create a new client hub.](https://cabify-api.readme.io/reference/post_v1-hubs.md): Creates a new hub associated with your account. Hubs represent physical locations (such as stores or warehouses) from which parcels can be picked up or delivered to. - [List all client hubs.](https://cabify-api.readme.io/reference/get_v1-hubs.md): Returns all hubs associated with your account. - [Get a client hub by its external ID.](https://cabify-api.readme.io/reference/get_v1-hubs-none-hub-external-id.md): Returns the details of a specific hub identified by your external ID. - [Update a client hub by its external ID.](https://cabify-api.readme.io/reference/put_v1-hubs-none-hub-external-id.md): Updates the details of a specific hub identified by your external ID. - [Error handling](https://cabify-api.readme.io/reference/error-handling.md) - webhooks - [Subscribe to parcel update notifications.](https://cabify-api.readme.io/reference/subscribewebhook.md): Register a webhook to receive real-time notifications when parcels are updated. **Securing your webhook endpoint:** 1. Include a custom authorization header in the subscription request. Our API will… - [List your active webhook subscriptions.](https://cabify-api.readme.io/reference/getwebhook.md): Returns all active webhook subscriptions registered for your account. - [Unsubscribe from a webhook.](https://cabify-api.readme.io/reference/deletewebhook.md): Removes the webhook subscription for the specified event type. - users - [List users belonging to your account.](https://cabify-api.readme.io/reference/getusers.md): Returns all Cabify users associated with your account. ## API Reference: Cabify Logistics API - parcels - [Get a parcel by external ID.](https://cabify-api.readme.io/reference/getparcelbyexternalid.md): Returns the full details of a parcel identified by the external ID you assigned when creating it. Only parcels belonging to the authenticated account are matched. ## Pages - [Cabify API Support](https://cabify-api.readme.io/page/cabify-api-support.md) - [Subscribe to updates](https://cabify-api.readme.io/page/subscribe-to-updates.md)