v1.0.0
Request Access

Commercial Shipping Documents

Download OpenAPI Document

Retrieve commercial shipping documents for a booking reference.

Overview

Returns all documents linked to the provided booking reference.

  • bookingReference — A unique booking reference provided by the carrier.
Scope: documents: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 documents.

Returns all documents 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

DocumentModel
object6 fields
Description

A document linked to a booking reference.

Fields
document_type
string

The type of document (e.g., Booking Copy).

file_link
string

Direct link to download the document.

file_metadata
object

File metadata for the document.

file_name
string

The filename of the document.

id
string

Opaque document identifier (use for download URL).

memo
string

Optional memo associated with the document.

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 commercial shipping document retrieval.