CargoSmart Documents API
Shipping documentation
CargoSmart Documents API is one of 5 APIs that CargoSmart publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.
This API exposes 1 operation across 1 path, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against a single base URL, https://api.cargosmart.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
CargoSmart Documents API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as X-API-Key (apiKey).
It supports OAuth 2.0 (oauth2) using the clientCredentials flow, exposing 4 scopes.
By default, every request must be authenticated.
Paths & Operations 1
Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.
Shipping documentation
Schemas 4
The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are BillOfLading (16 properties), Party (5 properties), Port (4 properties), Error (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 CargoSmart 4
Other APIs CargoSmart publishes across the network.