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

Endpoints for managing shipment stops

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

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

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

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

Paths & Operations 3

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

Stops 3

Endpoints for managing shipment stops

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 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are ArriveAtStopRequest (4 properties), CompleteStopRequest (3 properties), ArriveAtStopResponse (2 properties), CompleteStopResponse (2 properties). Each schema is shown below with its type and property counts.

ArriveAtStopResponse
object
2 properties
CompleteStopResponse
object
2 properties
BadRequestResponse
object
1 property
AddStopRequest
object
2 properties 2 required
InternalServerErrorResponse
object
1 property
ArriveAtStopRequest
object
4 properties 3 required
CompleteStopRequest
object
3 properties 2 required
AddStopResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cargomatic-stops-api-openapi.yml Raw ↑

Other APIs Cargomatic publishes across the network.

Cargomatic Authorization API
Cargomatic Carrier API
Cargomatic Document API
Cargomatic Shipper API