Maersk Bookings API

openapi: 3.1.0
info:
  title: Maersk Air Booking AirBookings Bookings API
  description: 'Submit air freight booking requests via Maersk Air Cargo. Covers consolidation, charter, and forwarder bookings between supported origin and destination airports.

    '
  version: '1.0'
  contact:
    name: Maersk Developer Support
    url: https://developer.maersk.com/support
servers:
- url: https://api.maersk.com
  description: Production Gateway
security:
- ConsumerKey: []
tags:
- name: Bookings
  description: Create and manage ocean shipment bookings.
paths:
  /dcsa/bkg/v2/bookings:
    post:
      summary: Create Ocean Booking
      description: 'Submit a booking request for an ocean shipment. The request body follows the DCSA Booking 2.0 schema covering parties, cargo, equipment, routing, and references.

        '
      operationId: createBooking
      tags:
      - Bookings
      parameters:
      - name: Consumer-Key
        in: header
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BookingRequest'
      responses:
        '201':
          description: Booking created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Booking'
        '400':
          description: Invalid booking request.
        '401':
          description: Unauthorized.
  /dcsa/bkg/v2/bookings/{carrierBookingReference}:
    get:
      summary: Retrieve Ocean Booking
      description: Retrieve an existing booking by carrier booking reference.
      operationId: getBooking
      tags:
      - Bookings
      parameters:
      - name: carrierBookingReference
        in: path
        required: true
        schema:
          type: string
      - name: Consumer-Key
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Booking returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Booking'
        '404':
          description: Booking not found.
    patch:
      summary: Amend Ocean Booking
      description: Submit an amendment to an existing booking.
      operationId: amendBooking
      tags:
      - Bookings
      parameters:
      - name: carrierBookingReference
        in: path
        required: true
        schema:
          type: string
      - name: Consumer-Key
        in: header
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BookingRequest'
      responses:
        '200':
          description: Amendment accepted.
        '404':
          description: Booking not found.
    delete:
      summary: Cancel Ocean Booking
      description: Cancel an existing booking.
      operationId: cancelBooking
      tags:
      - Bookings
      parameters:
      - name: carrierBookingReference
        in: path
        required: true
        schema:
          type: string
      - name: Consumer-Key
        in: header
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Booking cancelled.
components:
  schemas:
    Booking:
      allOf:
      - $ref: '#/components/schemas/BookingRequest'
      - type: object
        properties:
          carrierBookingReference:
            type: string
          bookingStatus:
            type: string
            enum:
            - RECEIVED
            - PENDING_UPDATE
            - UPDATE_CONFIRMED
            - CONFIRMED
            - REJECTED
            - CANCELLED
            - COMPLETED
          bookingRequestDateTime:
            type: string
            format: date-time
    RequestedEquipment:
      type: object
      properties:
        ISOEquipmentCode:
          type: string
          example: 22GP
        units:
          type: integer
        isShipperOwned:
          type: boolean
    BookingRequest:
      type: object
      required:
      - carrierServiceCode
      - receiptTypeAtOrigin
      - deliveryTypeAtDestination
      - cargoMovementTypeAtOrigin
      - cargoMovementTypeAtDestination
      - requestedEquipments
      properties:
        carrierServiceCode:
          type: string
        receiptTypeAtOrigin:
          type: string
          enum:
          - CY
          - SD
          - CFS
        deliveryTypeAtDestination:
          type: string
          enum:
          - CY
          - SD
          - CFS
        cargoMovementTypeAtOrigin:
          type: string
          enum:
          - FCL
          - LCL
          - BBK
        cargoMovementTypeAtDestination:
          type: string
          enum:
          - FCL
          - LCL
          - BBK
        serviceContractReference:
          type: string
        commodities:
          type: array
          items:
            $ref: '#/components/schemas/Commodity'
        requestedEquipments:
          type: array
          items:
            $ref: '#/components/schemas/RequestedEquipment'
        partyContactDetails:
          type: array
          items:
            $ref: '#/components/schemas/PartyContact'
    Commodity:
      type: object
      properties:
        commodityType:
          type: string
        HSCodes:
          type: array
          items:
            type: string
        cargoGrossWeight:
          type: number
        cargoGrossWeightUnit:
          type: string
          enum:
          - KGM
          - LBR
    PartyContact:
      type: object
      properties:
        name:
          type: string
        email:
          type: string
        phone:
          type: string
  securitySchemes:
    ConsumerKey:
      type: apiKey
      in: header
      name: Consumer-Key