CargoDocs Common API

openapi: 3.1.0
info:
  title: CargoDocs Customer Data/Docs Common API
  description: The CargoDocs Customer Data/Docs API enables exporters to draft trade and shipping documents, including tanker, bulker, or barge bills of lading from data imported from an ERP system, CTRM, TMS, WMS, etc. It also enables any party using CargoDocs to download copy docs and data to automate various back-office steps.
  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: Common
  description: Common API endpoints shared across partner operations
paths:
  /common/counterparties:
    get:
      operationId: getCounterparties
      summary: CargoDocs Get Counterparties
      description: Allows a Partner to retrieve all available counterparties.
      tags:
      - Common
      responses:
        '200':
          description: Successful response with list of counterparties
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Counterparty'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
components:
  schemas:
    Counterparty:
      type: object
      properties:
        counterpartyId:
          type: string
          description: The unique identifier for the counterparty
        counterpartyName:
          type: string
          description: The name of the counterparty
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT