Cargoson Shipments API
Create shipment queries and direct bookings, retrieve labels.
Cargoson Shipments API is one of 5 APIs that Cargoson publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Shipments. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 2 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.0.1, at version 1.
Requests are made against a single base URL, https://www.cargoson.com/api/v1.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Cargoson Shipments API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
By default, every request must be authenticated.
bearerAuth— API key passed as a Bearer token in the Authorization header (Authorization: Bearer YOURAPIKEY). Requests must also send Accept: application/vnd.api.v1.
Paths & Operations 2
Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.
Create shipment queries and direct bookings, retrieve labels.
Schemas 4
The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are QueryRequest (17 properties), ShipmentRow (4 properties), BookingResponse (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Cargoson 4
Other APIs Cargoson publishes across the network.