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

Endpoints for Cargomatic Carriers and Drivers

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

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

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

4 operations 4 paths 10 schemas 4 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 Carrier API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth).

Paths & Operations 4

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

Carrier 4

Endpoints for Cargomatic Carriers and Drivers

POST
/shipments/appointment
Updates an existing appointment with a new status, start time, and/or end time. Requires the client to send at least one of new windowStart time, new windowEnd time, or appointmentConfirmed.
updateAppointment body → 200400500
POST
/shipments/accept
Accepts a Shipment
acceptShipment body → 200400500
POST
/carrier/{carrierid}/driver
Creates a new Driver
createDriver 1 param body → 200400500
POST
/shipment/assign
Assigna a Driver to a Shipment
assignDriver body → 200400500

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are CreateDriverRequest (9 properties), UpdateShipmentRequest (5 properties), AcceptShipmentResponse (4 properties), UpdateShipmentResponse (2 properties). Each schema is shown below with its type and property counts.

AcceptShipmentRequest
object
1 property
AssignDriverRequest
object
2 properties
BadRequestResponse
object
1 property
InternalServerErrorResponse
object
1 property
UpdateShipmentRequest
object
5 properties
CreateDriverResponse
object
2 properties
AssignDriverResponse
object
2 properties
CreateDriverRequest
object
9 properties
UpdateShipmentResponse
object
2 properties
AcceptShipmentResponse
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cargomatic-carrier-api-openapi.yml Raw ↑

Other APIs Cargomatic publishes across the network.

Cargomatic Authorization API
Cargomatic Document API
Cargomatic Shipper API
Cargomatic Stops API