naftiko: 1.0.0-alpha2
info:
  label: Maersk Ocean Booking API — Bookings
  description: >
    Create, retrieve, amend and cancel ocean shipment bookings using the
    DCSA-compliant Maersk Ocean Booking v2 API.
  tags:
    - Maersk
    - Booking
    - DCSA
    - Ocean
  created: '2026-05-25'
  modified: '2026-05-25'
binds:
  - namespace: env
    keys:
      MAERSK_CONSUMER_KEY: MAERSK_CONSUMER_KEY
capability:
  consumes:
    - type: http
      namespace: ocean-booking
      baseUri: https://api.maersk.com
      description: Maersk Ocean Booking v2 (DCSA).
      resources:
        - name: bookings
          path: /dcsa/bkg/v2/bookings
          operations:
            - name: createBooking
              method: POST
              description: Submit a booking request.
              inputParameters:
                - name: body
                  in: body
                  type: object
                  required: true
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
        - name: booking
          path: /dcsa/bkg/v2/bookings/{carrierBookingReference}
          operations:
            - name: getBooking
              method: GET
              description: Retrieve a booking.
              inputParameters:
                - name: carrierBookingReference
                  in: path
                  type: string
                  required: true
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
            - name: amendBooking
              method: PATCH
              description: Amend a booking.
              inputParameters:
                - name: carrierBookingReference
                  in: path
                  type: string
                  required: true
                - name: body
                  in: body
                  type: object
                  required: true
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
            - name: cancelBooking
              method: DELETE
              description: Cancel a booking.
              inputParameters:
                - name: carrierBookingReference
                  in: path
                  type: string
                  required: true
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
      authentication:
        type: apikey
        in: header
        name: Consumer-Key
        valueFrom: env.MAERSK_CONSUMER_KEY