Kuehne+Nagel Events API

openapi: 3.2.0
info:
  title: OceanEventInbox Events API
  description: The Ocean Event Inbox API enables service providers to seamlessly submit container event data for shipments booked with Kuehne+Nagel, following the Digital Container Shipping Association standards. This API facilitates real-time, interoperable status updates by allowing providers to share equipment events directly with Kuehne+Nagel systems.
  contact:
    name: Kuehne+Nagel's Shipment Tracking Services Support
    email: rgs.st.ops@kuehne-nagel.com
  version: v1
  x-api-id: 3eecb7c2-4675-44ba-85a8-6ed60c0b901c
  x-api-version: 1.0.0
  x-api-guideline-version: 1.11.2
servers:
- url: https://internal.api.kuehne-nagel.com/integration/external/event/container/v1
security:
- default: []
tags:
- name: Events
  description: Event operations
paths:
  /events:
    post:
      tags:
      - Events
      summary: Publish events.
      description: 'Publish one or more Equipment Events This endpoint allows clients to submit new `EquipmentEvent`s to Kuehne+Nagel''s system. These events provide updates on equipment status as defined by the DCSA standard. **Note: In the current version, only one event at a time is accepted.**

        '
      operationId: postEquipmentEvent
      parameters:
      - name: partyName
        in: header
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: 'The request body must contain an `EquipmentEvent` object, which represents a single event.  Each event captures: - **Event Metadata**  - **Equipment Details**  - **Related Documents** - **Event-Specific Attributes** Events must conform to the DCSA schema to ensure interoperability across systems.  Invalid or incomplete events will be rejected.

          '
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/equipmentEventRequest'
            examples:
              pickExample:
                $ref: '#/components/examples/pickExample'
              gateInExample:
                $ref: '#/components/examples/gateInExample'
              loadExample:
                $ref: '#/components/examples/loadExample'
              departedExample:
                $ref: '#/components/examples/departedExample'
              arrivedExample:
                $ref: '#/components/examples/arrivedExample'
              discExample:
                $ref: '#/components/examples/discExample'
              gateOutExample:
                $ref: '#/components/examples/gateOutExample'
              dropExample:
                $ref: '#/components/examples/dropExample'
        required: true
      responses:
        '201':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/equipmentEvent'
        default:
          description: Unexpected error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/error'
      security:
      - default: []
      - default: []
      x-auth-type: Application & Application User
      x-throttling-tier: 10KPerMin
components:
  schemas:
    universalServiceReference:
      maxLength: 8
      pattern: ^SR\d{5}[A-Z]$
      type: string
      description: 'A global unique service reference, as per DCSA standard, agreed by VSA partners for the service. The service reference must match the regular expression pattern: `SR\d{5}[A-Z]`. The letters `SR` followed by `5 digits`, followed by a checksum-character as a capital letter from `A to Z`.

        '
      example: SR12345A
    carrierServiceCode:
      maxLength: 5
      type: string
      description: 'The code of the service for which the schedule details are published.

        '
      example: FE1
    error:
      required:
      - errorDateTime
      - errors
      - httpMethod
      - requestUri
      - statusCode
      - statusCodeText
      type: object
      properties:
        title:
          maxLength: 128
          type: string
          description: 'A short summary of the problem type. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized.

            '
          example: The requested container is not available.
        detail:
          maxLength: 256
          type: string
          description: 'A human readable explanation specific to this occurrence of the problem that is helpful to locate the problem and give advice on how to proceed.

            '
          example: The requested container is already in use during the requested period.
        httpMethod:
          type: string
          description: The HTTP request method type
          example: POST
          enum:
          - POST
        requestUri:
          type: string
          description: The request URI.
          example: https://dcsa.org/dcsa/tnt/v1/events
        errors:
          type: array
          items:
            $ref: '#/components/schemas/errorDetail'
        statusCode:
          type: integer
          description: The HTTP status code
          format: int32
          example: 400
        statusCodeText:
          type: string
          description: The textual representation of the response status.
          example: Bad Request
        errorDateTime:
          type: string
          description: The date and time (in ISO 8601 format) the error occurred.
          format: date-time
          example: '2019-11-12T07:41:00+08:30'
    universalExportVoyageReference:
      pattern: ^\d{2}[0-9A-Z]{2}[NEWS]$
      type: string
      description: 'A global unique voyage reference for the export Voyage, as per DCSA standard, agreed by VSA partners for the voyage. The voyage reference must match the regular expression pattern: `\d{2}[0-9A-Z]{2}[NEWS]` - `2 digits` for the year - `2 alphanumeric characters` for the sequence number of the voyage - `1 character` for the direction/haul (`N`orth, `E`ast, `W`est or `S`outh).

        '
      example: 2103N
    publisher:
      required:
      - carrierCode
      - carrierCodeListProvider
      - partyName
      type: object
      properties:
        partyName:
          maxLength: 100
          type: string
          description: Name of the party.
          example: Asseco Denmark
        carrierCode:
          maxLength: 4
          pattern: ^\S+(\s+\S+)*$
          type: string
          description: 'The code containing the SCAC code to specify the issuing carrier.  Details about the issuer can be given in the Document Parties entity using the party function code MS.

            '
          example: MMCU
        carrierCodeListProvider:
          type: string
          description: 'The provider used for identifying the issuer Code. Possible values are: - NMFTA (National Motor Freight Traffic Association) _includes SPLC (Standard Point Location Code)_

            '
          example: NMFTA
          enum:
          - NMFTA
      description: 'The party sending the event

        '
    equipmentEventMetadata:
      type: object
      description: 'The `metadata` of the `EquipmentEvent` - includes all non-business related attributes

        '
      allOf:
      - $ref: '#/components/schemas/metadata'
      - type: object
        properties:
          eventType:
            type: string
            description: 'The type of the Event - in case of a `EquipmentEvent` it must be `EQUIPMENT`

              '
            example: EQUIPMENT
            enum:
            - EQUIPMENT
    bargeTransportCall:
      title: Barge Transport Call
      required:
      - modeOfTransport
      - transportCallReference
      type: object
      properties:
        modeOfTransport:
          type: string
          description: 'The mode of transport as defined by DCSA. For the `BargeTransportCall` this needs to be `BARGE`

            '
          example: BARGE
          enum:
          - BARGE
        portVisitReference:
          $ref: '#/components/schemas/portVisitReference'
        carrierServiceCode:
          $ref: '#/components/schemas/carrierServiceCode'
        universalServiceReference:
          $ref: '#/components/schemas/universalServiceReference'
        carrierExportVoyageNumber:
          $ref: '#/components/schemas/carrierExportVoyageNumber'
        universalExportVoyageReference:
          $ref: '#/components/schemas/universalExportVoyageReference'
        carrierImportVoyageNumber:
          $ref: '#/components/schemas/carrierImportVoyageNumber'
        universalImportVoyageReference:
          $ref: '#/components/schemas/universalImportVoyageReference'
        barge:
          $ref: '#/components/schemas/barge'
      description: 'A Transport Call used for Barge

        '
    baseEquipmentEvent:
      required:
      - emptyIndicatorCode
      - equipmentEventTypeCode
      - equipmentReference
      - eventLocation
      - relatedDocumentReferences
      type: object
      properties:
        eventClassifierCode:
          type: string
          description: 'For `EquipmentEvents` the `eventClassifierCode` can be one of the following values - ACT (Actual) - <del>PLN (Planned)</del> - <del>EST (Estimated)</del>

            '
          example: ACT
          enum:
          - ACT
        equipmentEventTypeCode:
          type: string
          description: 'Unique identifier for `equipmentEventTypeCode` - can be one of the following values - LOAD (Loaded) - DISC (Discharged) - GTIN (Gated in) - GTOT (Gated out) - <del>STUF (Stuffed)</del> - <del>STRP (Stripped)</del> - PICK (Pick-up) - <del>AVPU (Available for Pick-up)</del> - DROP (Drop-off) - <del>AVDO (Available for Drop-off)</del> - <del>INSP (Inspected)</del> - <del>RSEA (Resealed)</del> - <del>RMVD (Removed)</del> - <del>CUSS (Customs Selected for Scan)</del> - <del>CUSI (Customs Selected for Inspection)</del> - <del>CUSR (Customs Released)</del> - <del>CROS (Crossed)</del> - ARRI (Arrived) --TransportEvent - DEPA (Departed) --TransportEvent More details can be found on <a href="https://github.com/dcsaorg/DCSA-Information-Model/blob/master/datamodel/referencedata.d/equipmenteventtypecodes.csv">GitHub</a>

            '
          example: LOAD
          enum:
          - LOAD
          - DISC
          - GTIN
          - GTOT
          - PICK
          - DROP
          - ARRI
          - DEPA
        equipmentReference:
          maxLength: 15
          type: string
          description: 'The unique identifier for the equipment, which should follow the BIC ISO Container Identification Number where possible. According to ISO 6346, a container identification code consists of a 4-letter prefix and a 7-digit number (composed of a 3-letter owner code, a category identifier, a serial number, and a check-digit). If a container does not comply with ISO 6346, it is suggested to follow Recommendation #2 “Container with non-ISO identification” from SMDG.

            '
          example: APZU4812090
        isoEquipmentCode:
          maxLength: 4
          type: string
          description: Unique code for the different equipment size/type used for transporting commodities. The code is a concatenation of ISO Equipment Size Code and ISO Equipment Type Code A and follows the ISO 6346 standard.
          example: 22GP
        emptyIndicatorCode:
          type: string
          description: Code to denote whether the equipment is empty or laden.
          example: EMPTY
          enum:
          - EMPTY
          - LADEN
        isTransshipmentMove:
          type: boolean
          description: 'Indicates whether this event is originated in relation to an ocean transshipment or inter terminal move. `isTransshipmentMove` can be set to true in combination with one of the following `equipmentEventTypeCodes`: - `LOAD` (Load) - `DISC` (Discharge) - `GTIN` (Gate In) - `GTOT` (Gate Out) - `PICK` (Pick-up) - `DROP` (Drop-off) - `ARRI` (Arrived) - Transport Event - `DEPA` (Departed) - Transport Event

            '
          example: true
        eventLocation:
          $ref: '#/components/schemas/unLocationLocation'
        facilityTypeCode:
          type: string
          description: 'The code to identify the specific type of facility. The code indicates which role the facility plays if this `EquipmentEvent` is related to *stuffing*/*stipping* (in case the event does not have a `transportCall`). Possible values - BORD (Border) - CLOC (Customer location) - COFS (Container freight station) - OFFD (Off dock storage) - DEPO (Depot) - INTE (Inland terminal) - POTE (Port terminal) - RAMP (Ramp) - WAYP (Waypoint)

            '
          example: POTE
          enum:
          - BORD
          - CLOC
          - COFS
          - OFFD
          - DEPO
          - INTE
          - POTE
          - RAMP
          - WAYP
        transportCall:
          $ref: '#/components/schemas/transportCall'
        relatedDocumentReferences:
          $ref: '#/components/schemas/relatedDocumentReferences'
        references:
          $ref: '#/components/schemas/references'
        seals:
          type: array
          items:
            $ref: '#/components/schemas/seal'
      description: 'The `EquipmentEvent` is a specialized event to handle all events related to transportation.

        '
    equipmentEventPayload:
      type: object
      description: 'The business attributes related to the `EquipmentEvent`.

        '
      allOf:
      - $ref: '#/components/schemas/baseEvent'
      - $ref: '#/components/schemas/baseEquipmentEvent'
    truckTransportCall:
      title: Truck Transport Call
      required:
      - modeOfTransport
      - transportCallReference
      type: object
      properties:
        modeOfTransport:
          type: string
          description: 'The mode of transport as defined by DCSA. For the `TruckTransportCall` this needs to be `TRUCK`

            '
          example: TRUCK
          enum:
          - TRUCK
        licencePlate:
          maxLength: 15
          type: string
          description: 'A license plate is a  tag that is attached to a vehicle and displays a unique number or code assigned to the vehicle. The format, design, and issuing authority for license plates vary by country, state, and province.

            '
        chassisLicencePlate:
          maxLength: 15
          type: string
          description: 'A chassis number is a unique identifying number or code assigned to the chassis of a vehicle.It may also be referred to as a "vehicle identification number" (VIN) or "frame number.

            '
      description: 'A Transport Call used for Truck

        '
    references:
      type: array
      description: 'References provided by the shipper or freight forwarder at the time of booking or at the time of providing shipping instruction. Carriers share it back when providing track and trace event updates, some are also printed on the B/L. Customers can use these references to track shipments in their internal systems. In addition to the References provided by the shipper or freight forwarder - the carrier can provide an extra `type` called `EQ` which is a reference to an Equipment.

        '
      example:
      - type: EQ
        value: APZU4812090
      items:
        required:
        - type
        - value
        type: object
        properties:
          type:
            type: string
            description: 'The reference type codes defined by DCSA.

              - FF (Freight Forwarder’s Reference)

              - SI (Shipper’s Reference)

              - PO (Purchase Order Reference)

              - CR (Customer’s Reference)

              - AAO (Consignee’s Reference)

              - EQ (Equipment Reference)

              '
            example: FF
            enum:
            - FF
            - SI
            - PO
            - CR
            - AAO
            - EQ
          value:
            maxLength: 100
            type: string
            description: The actual value of the reference.
    carrierExportVoyageNumber:
      maxLength: 50
      pattern: ^\S+(\s+\S+)*$
      type: string
      description: 'The identifier of an export voyage. The carrier-specific identifier of the export Voyage.

        '
      example: 2103S
    locationName:
      maxLength: 100
      type: string
      description: The name of the location.
      example: Eiffel Tower
    vessel:
      required:
      - vesselImoNumber
      type: object
      properties:
        vesselImoNumber:
          maxLength: 7
          type: string
          description: 'The unique reference for a registered Vessel. The reference is the International Maritime Organisation (IMO) number, also sometimes known as the Lloyd''s register code, which does not change during the lifetime of the vessel

            '
          example: '9321483'
        name:
          maxLength: 35
          type: string
          description: 'The name of the Vessel given by the Vessel Operator and registered with IMO.

            '
          example: King of the Seas
        flag:
          maxLength: 2
          type: string
          description: 'The flag of the nation whose laws the vessel is registered under. This is the ISO 3166 two-letter country code

            '
          example: DE
        callSign:
          maxLength: 10
          type: string
          description: 'A unique alphanumeric identity that belongs to the vessel and is assigned by the International Telecommunication Union (ITU). It consists of a threeletter alphanumeric prefix that indicates nationality, followed by one to four characters to identify the individual vessel. For instance, vessels registered under Denmark are assigned the prefix ranges 5PA-5QZ, OUAOZZ, and XPA-XPZ. The Call Sign changes whenever a vessel changes its flag.

            '
          example: NCVV
        operatorCarrierCode:
          maxLength: 10
          type: string
          description: 'The carrier who is in charge of the vessel operation based on either the SCAC code lists

            '
          example: MAEU
        operatorCarrierCodeListProvider:
          type: string
          description: Identifies the code list provider used for the operator and partner carriercodes.
          example: NMFTA
          enum:
          - NMFTA
      description: 'A floating, sea going structure (mother vessels and feeder vessels) with either an internal or external mode of propulsion designed for the transport of cargo and/or passengers.

        '
    relatedDocumentReferences:
      type: array
      description: 'A list of key-value (`type`-`value`) pairs representing links to objects relevant to the event. The `type`-field is used to describe where the `value`-field is pointing to.   `TRD` (Transport Document / OBL) is **mandatory**, all other documents are optional.

        '
      example:
      - type: BKG
        value: ABC123059
      - type: TRD
        value: '85943567'
      items:
        type: object
        properties:
          type:
            type: string
            description: 'The `type` is used to identify the type of information `value` points to. Can be one of the following values - CBR (Carrier Booking Request) - BKG (Booking) - SHI (Shipping Instruction) - TRD (Transport Document) - DEI (Delivery Instructions) - DEO (Delivery Order) - TRO (Transport Order) - CRO (Container Release Order) - ARN (Arrival Notice) - VGM (Verified Gross Mass) - CAS (Cargo Survey) - CUC (Customs Clearance) - DGD (Dangerous Goods Declaration) - OOG (Out of Gauge) - CQU (Contract Quotation) - INV (Invoice) - HCE (Health Certificate) - PCE (Phytosanitary Certificate) - VCE (Veterinary Certificate) - FCE (Fumigation Certificate) - ICE (Inspection Certificate) - CEA (Certificate of Analysis) - CEO (Certificate of Origin) More details can be found on [GitHub](https://github.com/dcsaorg/DCSA-Information-Model/blob/master/datamodel/referencedata.d/documenttypecodes.csv)

              '
            example: TRD
            enum:
            - CBR
            - BKG
            - SHI
            - TRD
            - DEI
            - DEO
            - TRO
            - CRO
            - ARN
            - VGM
            - CAS
            - CUC
            - DGD
            - OOG
            - CQU
            - INV
            - HCE
            - PCE
            - VCE
            - FCE
            - ICE
            - CEA
            - CEO
          value:
            maxLength: 100
            type: string
            description: 'The reference to the object described by `type`

              '
            example: 123e4567e89b
    transportCall:
      required:
      - location
      - transportCallReference
      type: object
      allOf:
      - type: object
        properties:
          transportCallReference:
            maxLength: 100
            pattern: ^\S+(\s+\S+)*$
            type: string
            description: 'A carrier definied reference to a `TransportCall`. In the case the Means of Transport is a `Vessel` and the facility is a `Port`/`Terminal` - this reference should be considered a **Terminal Call Reference**

              '
            example: 987e4567
      - type: object
        properties:
          transportCallSequenceNumber:
            type: integer
            description: Transport operator's key that uniquely identifies each individual call. This key is essential to distinguish between two separate calls at the same location within one voyage.
            format: int32
            example: 2
      - type: object
        properties:
          location:
            $ref: '#/components/schemas/unLocationLocation'
      - type: object
        properties:
          facilityTypeCode:
            type: string
            description: 'The code to identify the specific type of facility. The code indicates which role the facility plays during the `transportCall`. Possible values - BORD (Border) - CLOC (Customer location) - COFS (Container freight station) - OFFD (Off dock storage) - DEPO (Depot) - INTE (Inland terminal) - POTE (Port terminal) - RAMP (Ramp) - WAYP (Waypoint)

              '
            example: POTE
            enum:
            - BOCR
            - CLOC
            - COFS
            - OFFD
            - DEPO
            - INTE
            - POTE
            - RAMP
            - WAYP
      - type: object
        discriminator:
          propertyName: modeOfTransport
          mapping:
            VESSEL: '#/components/schemas/vesselTransportCall'
            BARGE: '#/components/schemas/bargeTransportCall'
            RAIL: '#/components/schemas/railTransportCall'
            TRUCK: '#/components/schemas/truckTransportCall'
        oneOf:
        - $ref: '#/components/schemas/vesselTransportCall'
        - $ref: '#/components/schemas/bargeTransportCall'
        - $ref: '#/components/schemas/railTransportCall'
        - $ref: '#/components/schemas/truckTransportCall'
      - type: object
        properties:
          modeOfTransport:
            type: string
            description: 'The mode of transport used for the transport call.

              '
            example: VESSEL
            enum:
            - VESSEL
            - BARGE
            - RAIL
            - TRUCK
    carrierImportVoyageNumber:
      maxLength: 50
      pattern: ^\S+(\s+\S+)*$
      type: string
      description: 'The identifier of an import voyage. The carrier-specific identifier of the import Voyage.

        '
      example: 2103N
    errorDetail:
      required:
      - detail
      - title
      type: object
      properties:
        title:
          type: string
          description: High level error message.
          example: invalidQuery
        detail:
          type: string
          description: Detailed error message.
          example: The request did not contain one of the required query parameters.
    barge:
      required:
      - name
      type: object
      properties:
        vesselImoNumber:
          maxLength: 7
          type: string
          description: 'The unique reference for a registered Vessel. The reference is the International Maritime Organisation (IMO) number, also sometimes known as the Lloyd''s register code, which does not change during the lifetime of the vessel

            '
          example: '9321483'
        name:
          maxLength: 35
          pattern: ^\S+(\s+\S+)*$
          type: string
          description: 'The name of the Barge. If the name is not known `TBD` (To Be Decided) should be used

            '
          example: King of the Seas
        flag:
          maxLength: 2
          pattern: ^[A-Z]{2}$
          type: string
          description: 'The flag of the nation whose laws the barge is registered under. This is the ISO 3166 two-letter country code

            '
          example: DE
        callSign:
          maxLength: 10
          type: string
          description: 'A unique alphanumeric identity that belongs to the barge and is assigned by the International Telecommunication Union (ITU). It consists of a three letter alphanumeric prefix that indicates nationality, followed by one to four characters to identify the individual vessel. For instance, vessels registered under Denmark are assigned the prefix ranges 5PA-5QZ, OUAOZZ, and XPA-XPZ. The Call Sign changes whenever a barge changes its flag.

            '
          example: NCVV
        operatorCarrierCode:
          maxLength: 10
          pattern: ^\S+(\s+\S+)*$
          type: string
          description: 'The carrier who is in charge of the Barge operation based on either the SCAC code lists

            '
          example: MAEU
        operatorCarrierCodeListProvider:
          type: string
          description: 'Identifies the code list provider used for the barge operator carriercodes. Possible values are: - NMFTA (National Motor Freight Traffic Association)

            '
          example: NMFTA
          enum:
          - NMFTA
      description: 'A flat-bottomed floating structure built mainly for transport of cargo/equipment at coastal areas, rivers, canals or on open sea. A barge may or may not be self-propelled.

        '
    metadata:
      required:
      - eventCreatedDateTime
      - eventId
      - eventType
      - publisher
      - publisherRole
      type: object
      description: 'The metadata of the event

        '
      allOf:
      - type: object
        properties:
          publisher:
            $ref: '#/components/schemas/publisher'
      - type: object
        properties:
          publisherRole:
            type: string
            description: 'The party function code of the publisher. The values are divided into 2 categories: #### Carrier - CA (Carrier) - AG (Carrier local agent) #### Service Provider - VSP (Visibility Service Provider) - SVP (Any other service provider) More details can be found on <a href="https://github.com/dcsaorg/DCSA-Information-Model/blob/master/datamodel/referencedata.d/publisherrole.csv">GitHub</a>

              '
            example: SVP
            enum:
            - CA
            - AG
            - VSP
            - SVP
    vesselTransportCall:
      title: Vessel Transport Call
      required:
      - modeOfTransport
      - transportCallReference
      type: object
      properties:
        modeOfTransport:
          type: string
          description: 'The mode of transport as defined by DCSA. For the `VesselTransportCall` this needs to be `VESSEL`

            '
          example: VESSEL
          enum:
          - VESSEL
        portVisitReference:
          $ref: '#/components/schemas/portVisitReference'
        carrierServiceCode:
          $ref: '#/components/schemas/carrierServiceCode'
        universalServiceReference:
          $ref: '#/components/schemas/universalServiceReference'
        carrierExportVoyageNumber:
          $ref: '#/components/schemas/carrierExportVoyageNumber'
        universalExportVoyageReference:
          $ref: '#/components/schemas/universalExportVoyageReference'
        carrierImportVoyageNumber:
          $ref: '#/components/schemas/carrierImportVoyageNumber'
        universalImportVoyageReference:
          $ref: '#/components/schemas/universalImportVoyageReference'
        vessel:
          $ref: '#/components/schemas/vessel'
      description: 'A Transport Call used for Vessels

        '
    baseEvent:
      required:
      - eventClassifierCode
      - eventDateTime
      type: object
      properties:
        eventClassifierCode:
          type: string
          description: 'Code for the event classifier. Values can vary depending on eventType

            '
        eventDateTime:
          type: string
          description: 'The local date and time, when the event took place or when the event will take place, in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) format.

            '
          format: date-time
          example: '2019-11-12T07:41:00+08:30'
      description: 'The Event entity is described as a generalization of all the specific event categories. An event always takes place in relation to a shipment and can additionally be linked to a transport or an equipment

        '
    railTransportCall:
      title: Rail Transport Call
      required:
      - modeOfTransport
      - transportCallReference
      type: object
      properties:
        modeOfTransport:
          type: string
          description: 'The mode of transport as defined by DCSA. For the `RailTransportCall` this needs to be `RAIL`

            '
          example: RAIL
          enum:
          - RAIL
        railCar:
          maxLength: 50
          type: string
          description: 'A railcar is a type of railway vehicle that is designed to transport freight or passengers on a railway track. They are also known as rail vehicles, railcars, or rolling stock. Railcars can be powered by an on-board locomotive or they can be pulled by a separate locomotive.

            '
        railService:
          maxLength: 50
          type: string
          description: 'A rail service number is a unique identifying number assigned to a specific rail service or train.

            '
        departureId:
          maxLength: 100
          type: string
          description: 'A departure ID (also known as a departure reference number) is a unique identifying number or code that is assigned to a specific departure of a rail

            '
      description: 'A Transport Call used for Rail

        '
    portVisitReference:
      maxLength: 50
      pattern: ^\S+(\s+\S+)*$
      type: string
      description: 'The unique reference that can be used to link different `transportCallReferences` to the same port visit. The reference is provided by the port to uniquely identify a port call

        '
      example: NLRTM1234589
    equipmentEventRequest:
      required:
      - metadata
      - payload
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/equipmentEventMetadata'
        payload:
          $ref: '#/components/schemas/equipmentEventPayload'
      description: 'The `EquipmentEvent` is a specialized event to handle all events related to equipment (containers).

        '
    equipmentEvent:
      required:
      - metadata
      - payload
      type: object
      description: 'The `EquipmentEvent` is a specialized event to handle all events related to equipment (containers).

        '
      allOf:
      - type: object
        properties:
          metadata:
            description: 'The `metadata` of the `EquipmentEvent` - includes all non-business related attributes

              '
            allOf:
            - $ref: '#/components/schemas/metadata'
            - type: object
              properties:
                eventId:
                  maxLength: 100
                  type: string
                  description: 'The unique identifier for this event (*the message - not the source*).

                    '
                  example: 3cecb101-7a1a-43a4-9d62-e88a131651e2
            - type: object
              properties:
                eventCreatedDateTime:
                  type: string
                  description: 'The timestamp of when the event was created.

                    '
                  format: date-time
                  example: '2021-01-09T14:12:56+01:00'
            - type: object
              properties:
                eventType:
                  type: string
                  description: 'The type of the Event - in case of a `EquipmentEvent` it must be `EQUIPMENT`

                    '
                  example: 

# --- truncated at 32 KB (47 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/kuehne-nagel/refs/heads/main/openapi/kuehne-nagel-events-api-openapi.yml