CargoDocs Exchange API

openapi: 3.1.0
info:
  title: CargoDocs Customer Data/Docs Common Exchange 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: 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:
    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
    Customer:
      type: object
      properties:
        customerId:
          type: string
          description: The unique identifier for the customer
        customerName:
          type: string
          description: The name of the customer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT