Skip to content

Company Operations

Shipment Lifecycle

Steps

  1. Create shipment in /shipments/new
  2. Attach transport documents and metadata
  3. Progress status through allowed transitions
  4. Add shipment progress updates and track details

Core APIs

  • GET /shipments/company
  • POST /shipments/company
  • PUT /shipments/{shipmentId}
  • PATCH /shipments/{shipmentId}/status
  • GET /shipments/{shipmentId}/allowed-status-transitions
  • POST /shipments/{shipmentId}/progress-updates
  • POST /shipments/{shipmentId}/documents
  • POST /shipments/process-transport-document

Cargo Lifecycle (IDF)

Steps

  1. Upload IDF in /cargos/upload
  2. Trigger IDF extraction to create cargo
  3. Validate extracted fields and line items
  4. Attach supporting documents and finalize status

Core APIs

  • GET /cargos/company
  • POST /documents/upload
  • POST /cargos/process-idf
  • GET /cargos/{cargoId}
  • POST /cargos/{cargoId}/documents
  • PUT /cargos/{cargoId}/status

Clearing Agent One Time Password (OTP)

Steps

  1. Open /single-use-certificates
  2. Select eligible cargo and apply
  3. Generate and upload certificate artifacts
  4. Retrieve certificate/invoice/receipt links

Core APIs

  • GET /single-use-certificates
  • GET /single-use-certificates/stats
  • POST /single-use-certificates/apply
  • POST /single-use-certificates/{id}/generate-and-upload
  • GET /single-use-certificates/{id}/view-links

Common Failures

  • Status transition denied:
  • fetch allowed transitions and use valid next state
  • IDF parse failure:
  • verify document quality and parser readiness