CargoDocs Exchange API

Partner Exchange API endpoints for customer and employee data

Operations 2

GET /exchange/customers CargoDocs Get Partner Customer Ids #
GET /exchange/employees CargoDocs Get Partner Customer Employee Ids #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/cargodocs-exchange-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

cargodocs-exchange-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: CargoDocs Partner Exchange API
  description: The CargoDocs Partner API enables partners and platform providers to embed CargoDocs DocEx functionality into their trade or trade finance platforms, handling original electronic bills of lading (eBoL) and warehouse warrants (eWW). The Partner Exchange API retrieves customer and partner data to perform specific actions, with endpoints to retrieve data based on conditions and filters and Action endpoints to action over transactions.
  version: 3.0.0
  contact:
    name: ICE Digital Trade (essDOCS)
    url: https://www.essdocs.com
  license:
    name: Proprietary
    url: https://www.essdocs.com
servers:
- url: https://api-test.cargodocs.com/v3
  description: Sandbox / Test Environment
- url: https://api.uat.cargodocs.com/v3
  description: UAT Environment
- url: https://api.cargodocs.com/v3
  description: Production Environment
security:
- bearerAuth: []
tags:
- name: Exchange
  description: Partner Exchange API endpoints for customer and employee data
paths:
  /exchange/customers:
    get:
      operationId: getPartnerCustomerIds
      summary: CargoDocs Get Partner Customer Ids
      description: Allows a Partner to collect the Customer IDs which they have permission to access in CargoDocs Exchange.
      tags:
      - Exchange
      responses:
        '200':
          description: Successful response with list of customer IDs
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Customer'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
  /exchange/employees:
    get:
      operationId: getPartnerCustomerEmployeeIds
      summary: CargoDocs Get Partner Customer Employee Ids
      description: Allows the Partner to collect the Employee IDs for parties to action a set of electronic documents and for auditing purposes.
      tags:
      - Exchange
      responses:
        '200':
          description: Successful response with list of employee IDs
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Employee'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
components:
  schemas:
    Customer:
      type: object
      properties:
        customerId:
          type: string
          description: The unique identifier for the customer
        customerName:
          type: string
          description: The name of the customer
    Employee:
      type: object
      properties:
        employeeId:
          type: string
          description: The unique identifier for the employee
        employeeName:
          type: string
          description: The name of the employee
        customerId:
          type: string
          description: The customer ID associated with this employee
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT