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

CargoDocs Transactions API

Endpoints for finding and managing transactions

CargoDocs Transactions API is one of 7 APIs that CargoDocs publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 5 JSON Schema definitions.

Tagged areas include Transactions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and 5 JSON Schemas.

This API exposes 1 operation across 1 path, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 3.0.0.

Requests are made against 3 base URLs: https://api-test.cargodocs.com/v3, https://api.uat.cargodocs.com/v3, https://api.cargodocs.com/v3.

1 operations 1 paths 2 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

CargoDocs Transactions API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Transactions 1

Endpoints for finding and managing transactions

GET
/customer/transactions
CargoDocs Find Transactions
findTransactions 3 params → 200401403

Schemas 2

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

TransactionList
object
4 properties
Transaction
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cargodocs-transactions-api-openapi.yml Raw ↑

Other APIs CargoDocs publishes across the network.

CargoDocs Common API
CargoDocs Documents API
CargoDocs Exchange API
CargoDocs Import API
CargoDocs Issuance API
CargoDocs Surrender API