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 Sales API

Sales objects are created once a journey transitions into the terminated state and they are associated with the user who requested the journey (which not necessarily is the rider). The transition to terminated happens automatically after 2 hours in production(10 minutes in sandbox environment). You can request them per user (requester of the journey), the client (all ofyour sales), or journey (all Sales associated to a specific journey which in most cases is just one).

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

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

This API exposes 3 operations across 3 paths, and defines 14 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.

3 operations 3 paths 14 schemas 3 GET

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 Sales API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearer_token).

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Sales 3

Sales objects are created once a journey transitions into the terminated state and they are associated with the user who requested the journey (which not necessarily is the rider)…

GET
/api/v4/journey/{journey_id}/sales
Get journey's sales
getJourneySales 1 param → 200400401404500
GET
/api/v4/sales
Fetch client's sales paginated
getSales 5 params → 200400401500
GET
/api/v4/user/{user_id}/sales
Get user's sales paginated
getUserSales 6 params → 200400401404500

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are StopResponse (13 properties), TypeObjectSale (9 properties), Expense (5 properties), Sale (5 properties). Each schema is shown below with its type and property counts.

MeetingPoint
object
A specific meeting point within a hub location (e.g. a terminal at an airport). Obtained from the hub data returned in the estimates response.
3 properties 3 required
StopResponse
object
Stop of a journey. A journey needs to have at least 2 stops: the first one is considered the pickup point the last one the destination.
13 properties 1 required
TypeObjectRectification
object
2 properties
Contact
object
Contact details on each Stop. Include this object if you want the Driver to see additional Contact details on each Stop.
4 properties
NotFound
object
The server did not find a current representation for the target resource
1 property
TypeObject
object
TypeObjectSale
object
Entity description in a Sale.
9 properties
UnauthorizedRequest
object
The token used is invalid either because it is expired or because it is incorrect.
1 property
PriceDetail
object
4 properties
InternalServerError
object
indicates that an internal server error occurred
1 property
Sale
object
5 properties
Concept
object
Prices of the Sale detailed.
2 properties
BadRequest
object
Indicates that the server cannot or will not process the request due to something that is perceived to be a client error (for example, malformed request syntax…
1 property
Expense
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cabify-sales-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 parcels API
Cabify shipment API
Cabify shipping_types API
Cabify status API
Cabify users API
Cabify webhooks API