SAsafecube
Shipment Format

Retrieve shipment tracking data in a Searates-compatible format

Changed on

Returns the same tracking data as GET /shipment, formatted to be compatible with the Searates "Tracking by any number" response.

Enables a field-by-field comparison with Searates formatted data.

By default the payload follows the Searates format. Set safecubeFields=true to additionally expose SafeCube-specific fields (currently metadata.warnings); those fields are omitted from the response when null.

get/shipment-format/searates

Request

  • Base URL
    api.sinay.ai/container-tracking/api/v2 (relative, and the document’s source URL is not known)
  • URL
    api.sinay.ai/container-tracking/api/v2/shipment-format/searates
  • Auth
    API key in header API_KEY

Query parameters

shipmentNumberstring required

Bill of Lading Number, Booking number or Container Tracking Number

sealinestring
<p>Sealine 4 letters scac code. Find the code corresponding to your sealine using the GET /sealines endpoint</p> <p>This parameter is strongly recommended to improve response time and avoid wrong sealine detection</p>
shipmentType'CT' | 'BL' | 'BK'

Shipment type. CT for container, BL for Booking and BL for Bill of Lading

routeboolean
<p>Set this to true if you wish to receive the route segments or AIS data</p> <p>Using this option will increase the response time</p>
aisboolean
<p>Set this to true if you wish to receive AIS data - will only work if route is also set to true</p> <p>Using this option will increase the response time</p>
safecubeFieldsboolean
<p>Set to true to include SafeCube-specific fields in addition to the Searates-compatible format.</p> <p>These fields have no equivalent in the native Searates response (currently metadata.warnings) and are omitted when null.</p>

Response

OK

status'success' | 'error'

Request status (success on completion, error otherwise)

message'OK' | 'SEALINE_HASNT_PROVIDE_INFO' | 'NO_CONTAINERS' | 'NO_EVENTS' | 'WRONG_PARAMETERS' | 'WRONG_NUMBER' | 'WRONG_SEALINE' | 'WRONG_TYPE' | 'SEALINE_NO_RESPONSE' | 'SEALINE_NOT_SUPPORTED' | 'SEALINE_TEMPORARY_DISABLED' | 'SEALINE_UNDER_MAINTENANCE' | 'AUTO_CANT_DETECT_SEALINE' | 'AUTO_CANT_DETECT_TYPE' | 'AUTO_CANT_FIND_INFO' | 'SEALINE_CANCELED_SHIPMENT' | 'UNEXPECTED_ERROR'

Request status description (see Searates request statuses)

Example response

{
  "data": {
    "metadata": {
      "updated_at": "2023-06-06 08:15:15"
    },
    "route": {
      "prepol": {
        "date": "2023-05-24 13:25:00"
      },
      "pol": {
        "date": "2023-05-24 13:25:00"
      },
      "pod": {
        "date": "2023-07-09 22:30:00"
      },
      "postpod": {
        "date": "2023-05-24 13:25:00"
      }
    },
    "containers": [
      {
        "events": [
          {
            "date": "2023-05-24 13:25:00"
          }
        ]
      }
    ]
  }
}

Changes