Shipment

{
  "name": "June Air Export USA",
  "ovrsea_shipment_id": "CDEF",
  "status": "booking_request",
  "created_at": "2021-09-20T10:02:09+01:00",
  "incoterm": "fob",
  "freight_mode": "air",
  "load_type": "fcl",
  "freight_type": "port_to_door",
  "route": {
    "pickup_location_id": "23",
    "origin_port_unlocode": "FR/FOS",
    "destination_port_unlocode": "US/NYC",
    "delivery_location_id": "45"
  },
  "cargo_ready_date": "2021-10-11",
  "desired_delivery_date": "2021-10-11",
  "specific_instructions": "<string>",
  "cargo": {
    "total_weight": {
      "value": 350.25,
      "unit": "kg"
    },
    "total_volume": {
      "value": 10.25,
      "unit": "cbm"
    },
    "total_teus": 5,
    "containers": [
      {
        "container_type": "twenty_foot_standard",
        "container_number": "TEMU8667058",
        "seal_number": 1332641,
        "purchase_order_references": [
          4500346155
        ]
      }
    ],
    "loads": [
      {
        "count": 3,
        "type": "pallet",
        "weight": {
          "value": 350.25,
          "unit": "kg"
        },
        "volume_unit": "cm",
        "length": {
          "value": 10.25,
          "unit": "cm"
        },
        "width": {
          "value": 10.25,
          "unit": "cm"
        },
        "height": {
          "value": 10.25,
          "unit": "cm"
        }
      }
    ]
  },
  "transported_goods": {
    "goods_description": "Description of the shipped goods",
    "is_stackable": true,
    "is_hazardous": false,
    "hazardous_description": "UN1993",
    "contains_lithium": false,
    "lithium_packaging_type": "alone",
    "contains_magnets": false,
    "needs_controlled_temperature": false,
    "temperature_range_description": "5-25°C"
  },
  "commercial_value": {
    "amount": 150357.99,
    "currency": "USD"
  },
  "needs_ad_valorem_insurance": false,
  "purchase_order_references": [
    4500346155
  ],
  "main_tracking_dates": {
    "pickup_date": {
      "date": "2021-09-20T10:02:09+01:00",
      "status": "estimated"
    },
    "departure_date": {
      "date": "2021-09-20T10:02:09+01:00",
      "status": "estimated"
    },
    "arrival_date": {
      "date": "2021-09-20T10:02:09+01:00",
      "status": "estimated"
    },
    "delivery_date": {
      "date": "2021-09-20T10:02:09+01:00",
      "status": "estimated"
    }
  },
  "booking_information": {
    "carrier": "CMA CGM",
    "master_bill": "LHV1190703558",
    "house_bill": "HOUSEREF12357",
    "ocean_booking": {
      "booking_number": "TWLEH2106004",
      "voyage": "033E",
      "vessel": "CMA CGM Jacques Saadé"
    },
    "air_booking": {
      "flight_number": "AF256",
      "chargeable_weight": {
        "value": 350.25,
        "unit": "kg"
      }
    }
  },
  "invoice_status": "available",
  "invoice_references": [
    "FAC2022-9567"
  ],
  "accepted_quote": {
    "id": "325",
    "request_date": "2021-09-20T10:02:09+01:00",
    "accepted_date": "2021-09-20T10:02:09+01:00"
  }
}

name

string

Example:

"June Air Export USA"

ovrsea_shipment_id

string

Example:

"CDEF"

status

enum<string>

Available options:

booking_request,

awaiting_booking,

booked,

draft,

in_progress,

finished,

cancelled

created_at

string

Example:

"2021-09-20T10:02:09+01:00"

incoterm

enum<string>

Available options:

exw,

fca,

fas,

fob,

cpt,

cfr,

cif,

cip,

dap,

ddp,

dpu,

dat

Example:

"fob"

freight_mode

enum<string>

Available options:

air,

ocean,

rail,

truck

load_type

enum<string>

Available options:

fcl,

lcl,

both

freight_type

enum<string>

Available options:

port_to_door,

door_to_port,

door_to_door,

port_to_port

route

object

Show child attributes

cargo_ready_date

string

Example:

"2021-10-11"

desired_delivery_date

string

Example:

"2021-10-11"

specific_instructions

string

Optional field containing specific instruction given by the client

cargo

object

Show child attributes

transported_goods

object

Show child attributes

commercial_value

object

Show child attributes

needs_ad_valorem_insurance

boolean

default:false

purchase_order_references

string[]

main_tracking_dates

object

Show child attributes

booking_information

object

Show child attributes

invoice_status

enum<string>

Available options:

available,

awaiting_invoice,

due,

paid,

partially_paid

invoice_references

string[]

accepted_quote

object

Show child attributes

Fetch products delivery overview reporting Container

⌘I

Getting Started

Endpoints

Data Models