Skip to main content

International Shipping Real-time Arrival API

This API allows you to process the real-time arrival of international shipments provided by the Willog platform. You can use this API to mark an ongoing international shipment as arrived.

Request​

POST ext/v1/ocean/reference-numbers/:referenceNumber/arrival​

Path Variable​

NameDescription
referenceNumberReference Number

Example Request​

POST /ext/v1/ocean/reference-numbers/:referenceNumber/arrival
Authorization: Bearer token

Response​

Response Body​

HTTP/1.1 200 OK

  • success: BOOLEAN - Success status
  • message: STRING - Message or remarks
  • data: OBJECT - Information of the arrived international shipment
    • referenceNumber: STRING - Reference number
    • uuid: STRING - Shipment uuid
    • departureTime: NUMBER - Departure time (Unix timestamp in ms)
    • arrivalTime: NUMBER - Arrival time (Unix timestamp in ms)

Example Success Response​

- When the arrival is processed successfully​

HTTP/1.1 200 OK

{
    "success": true,
    "message": "Success", 
    "data": {
        "referenceNumber": "REF123456",
        "uuid": "550e8400-e29b-41d4-a716-446655440000",
        "departureTime": 1738665219000,
        "arrivalTime": 1738751619000
    }
}

Example Error Response​

- When the international shipment is not in the departed state​

HTTP/1.1 200 OK

{
    "success": false,
    "message": "Only Departed or Fetched transport groups can be marked as Arrived", 
    "data": null
}