Hapag-Lloyd (v1.0)

Download OpenAPI description
openapi.json
openapi.yaml
Overview
Licencia

Khipu Open Data API

Languages
Servers
Production

https://api.khipu.com/

Tracing By Booking Number

Request

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.

Security
JWT or Api-Key
Bodyapplication/jsonRequerido
RequestDataobjectrequerido

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.

BookingNumberstringrequerido

Número de booking.

Ejemplo: "11111111"
CallbackUrlstring<= 255 characters

URL para enviar el mensaje de respuesta utilizando un método POST.

Ejemplo: "https://my-api.my-business.com/api/open-data-response"
curl -i -X POST \
  https://api.khipu.com/v1/com/services/hapag-lloyd.com/tracing/by-booking-number \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "RequestData": {
      "BookingNumber": "11111111"
    }
  }'

Responses

Operación exitosa. Retorna un objeto JSON con los datos solicitados.

Bodyapplication/json
OperationIdstring<= 36 charactersrequerido

Identificador único de la operación.

Ejemplo: "6baf6c19-e485-463b-ae24-a821b025c8a4"
Statusstringrequerido

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.

Enum"OK""ERROR"
Ejemplo: "OK"
Dataobject or nullrequerido

Contenedor para TracingData.

TracingDataArray of objectsnon-emptyrequerido
AdditionalInformationstring or nullrequerido

Este campo puede utilizarse para mostrar información relevante específica de la respuesta, por ejemplo indicando que el campo Data está incompleto.

Ejemplo: null
Errorobject or nullrequerido

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

Ejemplo: null
Codestring

Código interno del sistema que identifica el error.

Ejemplo: "E201"
Typestring

Indica cómo tratar este código de error específico, en función del tipo de error.

Enum"RETRY_IMMEDIATELY""DO_NOT_RETRY""WAIT_4_HOURS_BEFORE_RETRY""RETRY_AFTER_NOTIFICATION"
Ejemplo: "RETRY_IMMEDIATELY"
Descriptionstring

Descripción asociada al código de error.

Ejemplo: "El servicio destino utilizado para la extracción de datos no se encuentra disponible."
LifeSpanstring or nullrequerido

null en peticiones sincrónicas.

Ejemplo: null
Response
application/json
{
  "OperationId": "6baf6c19-e485-463b-ae24-a821b025c8a4",
  "Status": "OK",
  "Data": {
    "TracingData": [
      {
        "reg_date": "2023-06-12",
        "booking": 11111111,
        "cntr_number": "HLXU  1111111",
        "cntr_type": "11GP",
        "cntr_description": "HIGH CUBE CONT.",
        "cntr_size": "40' X 8' X 9'6\"",
        "tare_kg": 3900,
        "max_payload_kg": 28600,
        "status": "Gate out empty",
        "place_of_activity": "SANTIAGO DE CHILE",
        "date": "2023-03-21",
        "time": "11:23",
        "transport": "Truck",
        "voyage_number": "3208N"
      }
    ]
  },
  "AdditionalInformation": null,
  "Error": null,
  "LifeSpan": null
}