v1.0.0 DCSA 3.0.0

Ocean Booking

Download OpenAPI Document

Retrieve ocean booking details for a booking reference.

Overview

Returns booking details linked to the provided booking reference.

bookingReference — A unique booking reference provided by the carrier.

Scope: bookings:read

Getting started

Access to this API is limited to approved customers currently doing business with Airlift.

Getting Started Guide

OAuth 2.0

Bearer Token

Get an OAuth 2.0 access token using client credentials before calling the APIs.

Open Authorization Guide

Get booking details.

Returns booking details linked to the provided booking reference.

Query Parameters

bookingReference stringAIRLAMD132196

A unique booking reference provided by the carrier.

Headers

Authorization stringBearer YOUR_TOKEN

Bearer token issued for your registered application must be provided with every request.

Responses

200Successful operation.
400Bad request; the request is unacceptable often due to a missing or invalid parameter.
401The client cannot be authenticated by the system.
403The client does not have permissions to access this endpoint.
404The requested resource cannot be found.
500Internal server error.

Models

BookingModel

object22 fields

Description

Ocean booking details.

Fields

cargoMovementTypeAtDestination

string

Cargo movement type at destination.

cargoMovementTypeAtOrigin

string

Cargo movement type at origin.

carrierExportVoyageNumber

string

Carrier export voyage number.

carrierServiceCode

string

Carrier service code.

contractQuotationReference

string

Contract quotation reference.

deliveryTypeAtDestination

string

Delivery type at destination.

destinationChargesPaymentTerm

object

Destination charges payment terms.

documentParties

object

Document parties in the booking.

expectedDepartureDate

string

Expected departure date.

freightPaymentTermCode

string

Freight payment term code.

incoTerms

string

Incoterms.

isEquipmentSubstitutionAllowed

boolean

Indicates if equipment substitution is allowed.

isExportDeclarationRequired

boolean

Indicates if export declaration is required.

isPartialLoadAllowed

boolean

Indicates if partial load is allowed.

originChargesPaymentTerm

object

Origin charges payment terms.

partyContactDetails

array

Top-level contact details for the booking.

receiptTypeAtOrigin

string

Receipt type at origin.

references

array

Reference pairs for the booking.

requestedEquipments

array

Requested equipment details.

serviceContractReference

string

Service contract reference.

shipmentLocations

array

Shipment locations for the booking.

vessel

object

Vessel details.

ErrorResponseModel

object1 fields

Fields

error

object

Properties

code

string

Error code

message

string

Human-readable error message

Rate limits

Per Hour	Per Minute	Burst
4000	60	100

Release Notes

Version	Date	Notes
1.0.0	2025-01-06	Initial release of ocean booking details.

Server

https://api.airliftusa.com/api/v1/api-service/externalEnvironment

Authentication

Bearer TokenOAuth 2.0

Bearer token for authentication

Bearer Token

Operations

GET/booking

Client Libraries

Request

GET/bookingcURL

curl 'https://api.airliftusa.com/api/v1/api-service/external/booking?bookingReference=AIRLAMD132196' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

Show Schema

{
  "cargoMovementTypeAtDestination": "FCL",
  "cargoMovementTypeAtOrigin": "FCL",
  "carrierExportVoyageNumber": "403W",
  "carrierServiceCode": "TA1",
  "contractQuotationReference": "HHL1401",
  "deliveryTypeAtDestination": "CY",
  "destinationChargesPaymentTerm": {
    "haulageChargesPaymentTermCode": "COL",
    "otherChargesPaymentTermCode": "PRE",
    "portChargesPaymentTermCode": "PRE"
  },
  "documentParties": {
    "bookingAgent": {
      "address": {
        "city": "Bremerhaven",
        "countryCode": "DE",
        "postCode": "27568",
        "street": "Amerikaring",
        "streetNumber": "40"
      },
      "partyContactDetails": [
        {
          "name": "Export operations department",
          "phone": "+49 471 945410"
        }
      ],
      "partyName": "KN Bremerhaven"
    }
  },
  "expectedDepartureDate": "2024-01-20",
  "freightPaymentTermCode": "PRE",
  "incoTerms": "EXW",
  "isEquipmentSubstitutionAllowed": false,
  "isExportDeclarationRequired": false,
  "isPartialLoadAllowed": false,
  "originChargesPaymentTerm": {
    "haulageChargesPaymentTermCode": "PRE",
    "portChargesPaymentTermCode": "PRE"
  },
  "partyContactDetails": [
    {
      "name": "Diane",
      "phone": "+49 471 945410"
    }
  ],
  "receiptTypeAtOrigin": "CY",
  "references": [
    {
      "type": "CR",
      "value": "KN-00103004"
    }
  ],
  "requestedEquipments": [
    {
      "ISOEquipmentCode": "42G1",
      "commodities": [
        {
          "cargoGrossWeight": {
            "unit": "KGM",
            "value": 36000
          },
          "commodityType": "Dry cargo, Freight all kinds"
        }
      ],
      "isShipperOwned": false,
      "units": 3
    }
  ],
  "serviceContractReference": "HHL51800000",
  "shipmentLocations": [
    {
      "location": {
        "UNLocationCode": "DEBRV",
        "locationName": "Bremerhaven"
      },
      "locationTypeCode": "POL"
    },
    {
      "location": {
        "UNLocationCode": "USORF",
        "locationName": "Norfolk"
      },
      "locationTypeCode": "POD"
    }
  ],
  "vessel": {
    "name": "MAERSK IOWA",
    "vesselIMONumber": "9298686"
  }
}