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

Cabify offers to its clients a feature where the client’s employees have to input a journey motive or a project or a dynamic cost center associated with the new journey before requesting it. This is usually used for financial budgeting and reporting purposes since every journey now comes with this data linked to it, in other words, clients can segment their invoices by these Labels. Since some companies have a lot of Labels (projects/cost centers) that need to be managed they can use our API to do so. We allow creating, modifying, and disabling them directly from, for example, the client’s ERP (SAP, NetSuite, MSDynamics, etc.).

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

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

This API exposes 4 operations across 2 paths, and defines 9 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.

4 operations 2 paths 9 schemas 2 GET1 PATCH1 POST

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

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Labels 4

Cabify offers to its clients a feature where the client’s employees have to input a journey motive or a project or a dynamic cost center associated with the new journey before req…

POST
/api/v4/labels
Create a Label
createLabel body → 200400401500
GET
/api/v4/labels
Get labels paginated
getLabels 3 params → 200400401500
PATCH
/api/v4/labels
Update label
updateLabel 1 param body → 200400401500
GET
/api/v4/labels/{id}
Get label by Id
getLabelById 1 param → 200400401404500

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Label (6 properties), PaginatedLabelResponse (5 properties), LabelRequest (3 properties), LabelUpdateRequest (2 properties). Each schema is shown below with its type and property counts.

NotFound
object
The server did not find a current representation for the target resource
1 property
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
InternalServerError
object
indicates that an internal server error occurred
1 property
UnauthorizedRequest
object
The token used is invalid either because it is expired or because it is incorrect.
1 property
LabelResponse
object
Response schema for single label
1 property
LabelRequest
object
POST body for creating a label
3 properties 1 required
LabelUpdateRequest
object
Payload for updating a label
2 properties
Label
object
6 properties 2 required
PaginatedLabelResponse
object
Response schema for a list of labels
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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