Ovrsea API Documentation home pagelight logodark logo
  • Support
  • Dashboard
  • Dashboard
API Reference
  • Discover Ovrsea
  • Tech @ Ovrsea
  • Getting Started
    • Introduction
    • Authentication
    • Pagination
    Endpoints
    • Shipments
    • Invoices
    • Locations
    • Documents
    • Tracking
    • Purchase Orders
    • Users
    • Reporting
    Data Models
    • Shipment
    • Container
    • Coordinates
    • DateWithTime
    • Document
    • Invoice
    • Load
    • Location
    • Port
    • Price
    • Product
    • PurchaseOrder
    • Quantity
    • SimpleDate
    • Size
    • Tracking
    • TrackingDate
    • TrackingEvent
    • TrackingStep
    • User
    • Volume
    • Weight
    Copy
    {
      "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"
      }
    }
    Data Models

    Shipment

    The schema is of type object.

    Fetch products delivery overview reportingContainer
    linkedinmedium
    Powered by Mintlify
    Assistant
    Responses are generated using AI and may contain mistakes.