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

Cargomatic Shipper API

Endpoints for Cargomatic Shippers

Cargomatic Shipper API is one of 5 APIs that Cargomatic publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Shipper. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 9 operations across 8 paths, and defines 21 schemas. It is described by OpenAPI 3.0.0, at version 3.0.0.

Requests are made against a single base URL, https://api-acceptance.cargomatic.com.

9 operations 8 paths 21 schemas 2 GET7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
3.0.0
Base URL
https://api.cargomatic.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Cargomatic Shipper API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth).

Paths & Operations 9

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

Shipper 9

Endpoints for Cargomatic Shippers

POST
/quotes
Creates a quote
createQuote body → 200400500
POST
/orders
Creates an order
createOrder body → 200400500
POST
/shipments
Create a shipment/offer
createShipment body → 200400500
GET
/shipments
Lists all shipments with a pagination option
listShipments 2 params → 200400500
GET
/shipments/status
Returns a shipment with status info
shipmentStatus 1 param → 200400500
POST
/webhooks/loads
Process loads
processLoads body → 204
POST
/stops/complete
Mark a stop as complete
completeStop body → 200400500
POST
/stops/transition
Mark a stop as "arrived"
arriveAtStop body → 200400500
POST
/stops/add
Add additional stops to a shipment
addStop body → 200400500

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are OrderRequest (19 properties), QuoteRequestLoads (13 properties), QuoteRequest (11 properties), OrderRequestShipmentsStagingStops (7 properties). Each schema is shown below with its type and property counts.

QuoteRequestStops
object
2 properties 2 required
AddStopRequest
object
2 properties 2 required
OrderRequestShipmentsStagingStops
object
7 properties
InternalServerErrorResponse
object
1 property
QuoteResponse
object
2 properties
OrderRequestShipmentsStaging
object
2 properties
QuoteRequest
object
11 properties 3 required
CompleteStopResponse
object
2 properties
OrderRequestLocation
object
2 properties 2 required
AddStopResponse
object
2 properties
OfferResponse
object
2 properties
BadRequestResponse
object
1 property
QuoteRequestLoads
object
If fulltruckload is false, loads data are required: loads must contain at least one entry and the required data for each entry is quantity, length, width, heig…
13 properties 7 required
ArriveAtStopResponse
object
2 properties
ArriveAtStopRequest
object
4 properties 3 required
CompleteStopRequest
object
3 properties 2 required
OrderRequest
object
19 properties 9 required
OrderRequestEquipments
object
2 properties 2 required
OfferRequest
object
2 properties 2 required
ShipmentResponse
object
2 properties
OrderResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cargomatic-shipper-api-openapi.yml Raw ↑

Other APIs Cargomatic publishes across the network.

Cargomatic Authorization API
Cargomatic Carrier API
Cargomatic Document API
Cargomatic Stops API