openapi: 3.0.1
info:
  license:
    name: Khipu Open Data API
    url: https://khipu.com
  title: Hapag-Lloyd
  description: ''
  version: v1.0
servers:
  - url: https://api.khipu.com
    description: Production
security:
  - JWT: []
  - Api-Key: []
paths:
  /v1/com/services/hapag-lloyd.com/tracing/by-booking-number:
    post:
      summary: Tracing By Booking Number
      description: >-
        Este método retorna los datos de rastreo para el número de booking
        especificado, utilizando el motor de búsqueda "Rastrear por Booking" del
        sitio web de **Hapag-Lloyd**.


        El uso del campo `CallbackUrl` desencadenará un proceso asíncrono y los
        datos resultantes se enviarán más tarde al webhook especificado. Esta es
        la forma preferida de interactuar con nuestros servicios, ya que asegura
        que se harán todos los esfuerzos para extraer los datos y cumplir  con
        su solicitud dentro de un plazo razonable. Si desea la respuesta de
        inmediato, omita el campo `CallbackUrl` pero tenga en cuenta que puede
        provocar tiempos de espera dependiendo del tamaño del resultado de los
        datos y las condiciones de la red.
      operationId: TracingByBookingNumber
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TracingByBookingNumberRequest'
        required: true
      responses:
        '200':
          description: Operación exitosa. Retorna un objeto JSON con los datos solicitados.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TracingByBookingNumberResponseSyncOk'
        '202':
          description: >-
            Operación exitosa. Retorna un mensaje JSON informando el resultado
            de la operación solicitada. La respuesta completa, con el mismo
            esquema que la versión síncrona, se enviará al URL de callback
            proporcionado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TracingByBookingNumberResponseAsync'
        '400':
          description: Solicitud incorrecta
        '401':
          description: No autorizado - Credenciales inválidas o faltantes
        '404':
          description: No encontrado - Recurso no disponible
        '500':
          description: Error en el servicio remoto :(
components:
  securitySchemes:
    JWT:
      type: http
      scheme: bearer
      bearerFormat: JWT
    Api-Key:
      type: apiKey
      in: header
      name: x-api-key
  schemas:
    TracingByBookingNumberRequest:
      additionalProperties: false
      description: Objeto para realizar una solicitud al servicio OpenData.
      properties:
        RequestData:
          additionalProperties: false
          description: >-
            Información necesaria para conectarse a la cuenta del usuario en el
            sitio web y extraer datos. Los campos obligatorios indican los
            valores necesarios para identificar la cuenta deseada.
          properties:
            BookingNumber:
              type: string
              description: Número de booking.
              example: '11111111'
          required:
            - BookingNumber
          type: object
        CallbackUrl:
          description: URL para enviar el mensaje de respuesta utilizando un método POST.
          example: https://my-api.my-business.com/api/open-data-response
          type: string
          maxLength: 255
      required:
        - RequestData
      type: object
    TracingByBookingNumberResponseSyncOk:
      additionalProperties: false
      description: >-
        Objeto con la respuesta desde el servicio OpenData, en modo Sincrónico,
        cuando `Status` es "OK"
      properties:
        OperationId:
          description: Identificador único de la operación.
          example: 6baf6c19-e485-463b-ae24-a821b025c8a4
          type: string
          maxLength: 36
        Status:
          description: >-
            Estado de la operación. `OK` significa que el servicio se ha
            ejecutado correctamente aunque no devuelva datos. `ERROR` indica que
            ha ocurrido algo que ha impedido la finalización con éxito del
            proceso.
          example: OK
          type: string
          enum:
            - OK
            - ERROR
        Data:
          type: object
          description: Contenedor para TracingData.
          additionalProperties: false
          required:
            - TracingData
          properties:
            TracingData:
              type: array
              minItems: 1
              items:
                type: object
                additionalProperties: false
                required:
                  - reg_date
                  - booking
                  - cntr_number
                  - cntr_type
                  - cntr_description
                  - cntr_size
                  - tare_kg
                  - max_payload_kg
                  - status
                  - place_of_activity
                  - date
                  - time
                  - transport
                  - voyage_number
                properties:
                  reg_date:
                    type: string
                    format: date
                    description: Fecha de creación del recurso.
                    example: '2023-06-12'
                  booking:
                    type: integer
                    description: Número de reserva.
                    example: 11111111
                  cntr_number:
                    type: string
                    description: Número de contenedor.
                    example: HLXU  1111111
                  cntr_type:
                    type: string
                    description: Tipo de contenedor.
                    example: 11GP
                  cntr_description:
                    type: string
                    description: Descripción del contenedor.
                    example: HIGH CUBE CONT.
                  cntr_size:
                    type: string
                    description: Dimensión del contenedor.
                    example: 40' X 8' X 9'6"
                  tare_kg:
                    type: integer
                    description: Tara del contenedor en Kg.
                    example: 3900
                  max_payload_kg:
                    type: integer
                    description: Carga útil máxima del contenedor en Kg
                    example: 28600
                  status:
                    type: string
                    description: Estado.
                    example: Gate out empty
                  place_of_activity:
                    type: string
                    description: Lugar de actividad.
                    example: SANTIAGO DE CHILE
                  date:
                    type: string
                    description: Date.
                    example: '2023-03-21'
                  time:
                    type: string
                    description: Hora.
                    example: '11:23'
                  transport:
                    type: string
                    description: Transporte.
                    example: Truck
                  voyage_number:
                    type: string
                    description: Número de viaje. Puede ser una cadena vacía.
                    example: 3208N
          nullable: true
        AdditionalInformation:
          description: >-
            Este campo puede utilizarse para mostrar información relevante
            específica de la respuesta, por ejemplo indicando que el campo
            `Data` está incompleto.
          example: null
          type: string
          nullable: true
        Error:
          description: >-
            Objeto con los detalles del error, utilizado cuando `Status=ERROR`.
            Si `Status=OK` este campo será nulo. Puede leer una explicación
            completa de este objeto visitando [este
            enlace](https://docs.khipu.com/portal/en/errors/)
          example: null
          properties:
            Code:
              description: Código interno del sistema que identifica el error.
              example: E201
              type: string
            Type:
              description: >-
                Indica cómo tratar este código de error específico, en función
                del tipo de error.
              example: RETRY_IMMEDIATELY
              type: string
              enum:
                - RETRY_IMMEDIATELY
                - DO_NOT_RETRY
                - WAIT_4_HOURS_BEFORE_RETRY
                - RETRY_AFTER_NOTIFICATION
            Description:
              description: Descripción asociada al código de error.
              example: >-
                El servicio destino utilizado para la extracción de datos no se
                encuentra disponible.
              type: string
          required: []
          type: object
          nullable: true
        LifeSpan:
          description: '`null` en peticiones sincrónicas.'
          example: null
          type: string
          nullable: true
      required:
        - OperationId
        - Status
        - Data
        - AdditionalInformation
        - Error
        - LifeSpan
      type: object
    TracingByBookingNumberResponseAsync:
      type: object
      description: Objeto con la respuesta del servicio OpenData, en modo asíncrono.
      required:
        - OperationId
        - Status
        - Data
        - AdditionalInformation
        - Error
        - LifeSpan
      properties:
        OperationId:
          maxLength: 36
          type: string
          description: Identificador único de la operación.
          example: 6baf6c19-e485-463b-ae24-a821b025c8a4
        Status:
          type: string
          description: >-
            Estado de la operación. Al realizar solicitudes asíncronas, siempre
            devolverá `OK`.
          example: OK
        Data:
          type: object
          description: '`null` en solicitudes asíncronas.'
          example: null
        AdditionalInformation:
          type: string
          description: >-
            Mensaje de la operación, puede usarse para mostrar información
            adicional.
          example: Data will be sent to the callback URL.
        Error:
          type: object
          description: '`null` en solicitudes asíncronas.'
          example: null
        LifeSpan:
          type: string
          format: date-time
          description: >-
            Fecha máxima estimada de entrega para solicitudes asíncronas, en
            formato de fecha y hora ISO 8601, zona horaria UTC.
          example: 2017-07-22T00:00:00-0400
