v1.0.0 DCSA 3.0.0
Request Access

Ocean Booking Service

Download OpenAPI Document

Retrieve a list of ocean bookings.

Overview

Returns a list of bookings using pagination parameters.

  • limit — Maximum number of results to return in the response.
  • offset — Zero-based offset of the first result to return.
  • static_filter — Filter names (default: all). Allowed values:
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

List bookings.

Returns a list of bookings using pagination parameters.

Query Parameters

limit integer25
Maximum number of results to return in the response.
offset integer0
Zero-based offset of the first result to return.
static_filter arrayinprogress
Filter names (default: all). Allowed values:
Allowed:allinprogressonWaterinTransitatDestinationPortdeliveredrequestReceivedconfirmedcancelledflaggedblAmendmentPendingbookingAmendmentPendingcancellationRequestedbyBookingOrHblbyContainerIdgateInCutoffPendingdelayedrailIntermodalportPickupPendingrailPickupPendingawaitingDeparturedemurragestorageperDiemlfdPostedlfdExpiredpastExceptionsreleasePending

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
400060100

Release Notes

Version Date Notes
1.0.02025-01-06Initial release of ocean booking list retrieval.