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

The Document API from Cargomatic — 2 operation(s) for document.

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

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

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

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

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.

Document 2
POST
/create-documents
endpoint for uploading documents
createDocuments body → 200400500
POST
/get-documents
Retrive document on a specified entity
getDocuments body → 200400500

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are GetDocumentRequest (4 properties), GetDocumentResponse (2 properties), InternalServerErrorResponse (1 property), BadRequestResponse (1 property). Each schema is shown below with its type and property counts.

BadRequestResponse
object
1 property
GetDocumentRequest
object
4 properties
UploadDocumentRequest
array
InternalServerErrorResponse
object
1 property
GetDocumentResponse
object
2 properties
UploadDocumentResponse
array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cargomatic-document-api-openapi.yml Raw ↑

Other APIs Cargomatic publishes across the network.

Cargomatic Authorization API
Cargomatic Carrier API
Cargomatic Shipper API
Cargomatic Stops API