Documentation

Guides by role, by module,
by resource.

Operating guides follow the roles on your team, configuration guides follow the modules, and the API reference follows the resources. If something is not covered yet, ask your contact on our side.

Onboarding

Bringing CargOxygen live.

For the IT and finance staff bringing CargOxygen live on your side. These guides cover only the steps your team carries out and can be forwarded as is; deployment and configuration are handled by our operations team.

Guides

More guides in preparation.

Each topic below will get its own pages here as it is written. Until then, the manuals ship with your deployment.

Getting started

Your first job, step by step.

Create a customer, open a booking, and follow the work toward loading, with shortcuts close at hand.

In preparation
Module guides

Find the detail you need.

Work through Bookings, Shipments, Consolidations, Customs, Accounting, and Mail, field by field.

In preparation
Agent configuration

Put each agent in its place.

Registration, SOP mounting, reviewers, staged rollout, budgets, and fallback rules.

In preparation
Process configuration

Shape the way work moves.

Stages, nodes, entry conditions, red lines, drafts, and publishing.

In preparation
Access & organization

Keep responsibility clear.

Companies, branches, departments, roles, action codes, and semantic review roles.

In preparation
API & EDI

Plan the connection.

REST resources, token authentication, webhook events, and carrier EDI mapping.

API overview ↓
API & EDI

Read by resource,
push by event.

Bookings, shipments, consolidations, container events and invoices each have a resource. Auth is by token, rights follow the same action codes as the UI, and fields come back named as on screen.

  • Webhooks: status change, red line fired, proposal created
  • EDI: booking confirmation, load confirmation, schedule change
  • Rate limits and pagination are documented
GET/api/v1/shipments/S00003736
{
  "shipment_no": "S00003736",
  "stage": "settlement",
  "transport": "AIR",
  "origin": "CNPVG",
  "destination": "USJFK",
  "packs": 10,
  "weight_kg": 850.0,
  "volume_m3": 4.2,
  "red_lines": 1,
  "proposals": [{
    "agent": "mbl-draft-verify",
    "mode": "suggest",
    "state": "awaiting_review"
  }]
}

The docs site is still being assembled.

For now the manuals ship with the deployment. Tell us which part you need and we will send it to you.

Request the manuals Changelog