CargoDocs Exchange API
Partner Exchange API endpoints for customer and employee data
CargoDocs Exchange API is one of 7 APIs that CargoDocs publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 5 JSON Schema definitions.
Tagged areas include Exchange. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and 5 JSON Schemas.
This API exposes 2 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 3.0.0.
Requests are made against 3 base URLs: https://api-test.cargodocs.com/v3, https://api.uat.cargodocs.com/v3, https://api.cargodocs.com/v3.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
CargoDocs Exchange API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (bearerAuth).
By default, every request must be authenticated.
Paths & Operations 2
Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.
Partner Exchange API endpoints for customer and employee data
Schemas 2
The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Employee (3 properties), Customer (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from CargoDocs 6
Other APIs CargoDocs publishes across the network.