Skip to content
Documentation sections

Retrieve shipment tracking data in a Searates-compatible format

GET /shipment-format/searates on the Container Tracking API. Base URL: https://api.sinay.ai/container-tracking/api/v2.

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.

Query parameters

stringrequired

Bill of Lading Number, Booking number or Container Tracking Number

string

Sealine 4 letters scac code. Find the code corresponding to your sealine using the GET /sealines endpoint. This parameter is strongly recommended to improve response time and avoid wrong sealine detection

stringenum

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

Allowed:
booleanDefaults to true

Set this to true if you wish to receive the route segments or AIS data. Using this option will increase the response time

booleanDefaults to true

Set this to true if you wish to receive AIS data - will only work if route is also set to true. Using this option will increase the response time

booleanDefaults to false

Set to true to include SafeCube-specific fields in addition to the Searates-compatible format. These fields have no equivalent in the native Searates response (currently metadata.warnings) and are omitted when null.

Responses

Body: application/json, object.

FieldTypeRequiredDescription
statusstringNoRequest status (success on completion, error otherwise). One of: success, error.
messagestringNoRequest status description (see Searates request statuses). One of: 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.
dataobjectNoData on request.
data.metadataobjectNoAdditional data on request.
data.metadata.typestringNoOne of: CT, BL, BK.
data.metadata.numberstringNoShipment number.
data.metadata.sealinestring, nullableNoStandard Carrier Alpha Code (SCAC).
data.metadata.sealine_namestring, nullableNoCarrier name.
data.metadata.statusstringNoShipping status. One of: PLANNED, IN_TRANSIT, DELIVERED, UNKNOWN, CANCELLED. Default: UNKNOWN.
data.metadata.updated_atstring, nullableNoThe date the data was received from the carrier (UTC), format 'yyyy-MM-dd HH:mm:ss'.
data.metadata.api_callsobjectNoData on the number of api calls (Searates account metrics, not populated by SafeCube).
data.metadata.api_calls.totalinteger (int32), nullableNo—
data.metadata.api_calls.usedinteger (int32), nullableNo—
data.metadata.api_calls.remaininginteger (int32), nullableNo—
data.metadata.unique_shipmentsobjectNoData on the number of unique shipments (Searates account metrics, not populated by SafeCube).
data.metadata.unique_shipments.totalinteger (int32), nullableNo—
data.metadata.unique_shipments.usedinteger (int32), nullableNo—
data.metadata.unique_shipments.remaininginteger (int32), nullableNo—
data.metadata.warningsarray of string, nullableNoSafeCube-specific field, not part of the native Searates format. Data-quality warnings computed by SafeCube. Present only when safecubeFields=true; omitted from the response when null.
data.locationsarray of object, nullableNo—
data.locations[].idinteger (int32)NoUnique identifier referenced by events and route.
data.locations[].namestringNo—
data.locations[].statestring, nullableNo—
data.locations[].countrystring, nullableNo—
data.locations[].country_codestring, nullableNo—
data.locations[].locodestring, nullableNo—
data.locations[].latnumber (float), nullableNo—
data.locations[].lngnumber (float), nullableNo—
data.locations[].timezonestring, nullableNo—
data.routeobjectNoInformation on the route.
data.route.prepolobjectNo—
data.route.prepol.locationinteger (int32), nullableNoUnique identifier (id) from the locations array.
data.route.prepol.datestring, nullableNo—
data.route.prepol.actualboolean, nullableNo—
data.route.polobjectNo—
data.route.pol.locationinteger (int32), nullableNoUnique identifier (id) from the locations array.
data.route.pol.datestring, nullableNo—
data.route.pol.actualboolean, nullableNo—
data.route.podobjectNo—
data.route.pod.locationinteger (int32), nullableNoUnique identifier (id) from the locations array.
data.route.pod.datestring, nullableNo—
data.route.pod.actualboolean, nullableNo—
data.route.pod.predictive_etastring, nullableNoIf the carrier did not provide an arrival date, SafeCube may calculate it.
data.route.postpodobjectNo—
data.route.postpod.locationinteger (int32), nullableNoUnique identifier (id) from the locations array.
data.route.postpod.datestring, nullableNo—
data.route.postpod.actualboolean, nullableNo—
data.vesselsarray of object, nullableNo—
data.vessels[].idinteger (int32)NoUnique identifier referenced by events.
data.vessels[].namestringNo—
data.vessels[].imointeger (int32), nullableNo—
data.vessels[].call_signstring, nullableNo—
data.vessels[].mmsiinteger (int32), nullableNo—
data.vessels[].flagstring, nullableNo—
data.containersarray of object, nullableNo—
data.containers[].numberstringNo—
data.containers[].iso_codestring, nullableNo—
data.containers[].size_typestring, nullableNo—
data.containers[].statusstringNoShipping status. One of: PLANNED, IN_TRANSIT, DELIVERED, UNKNOWN, CANCELLED. Default: UNKNOWN.
data.containers[].eventsarray of object, nullableNo—
data.containers[].events[].order_idinteger (int32)NoThe sequence number of the event.
data.containers[].events[].locationinteger (int32), nullableNoUnique identifier (id) from the locations array.
data.containers[].events[].facilityinteger (int32), nullableNoUnique identifier (id) from the facilities array.
data.containers[].events[].descriptionstringNo—
data.containers[].events[].event_typestring, nullableNoOne of: SHIPMENT, TRANSPORT, EQUIPMENT.
data.containers[].events[].event_codestring, nullableNoOne of: ARRI, DEPA, LOAD, DISC, GTIN, GTOT, STUF, STRP, PICK, AVPU, DROP, AVDO, INSP, RSEA, RMVD, CUSS, CUSI, CUSR, CROS, RECE, DRFT, PENA, PENU, PENC, CONF, REJE, APPR, ISSU, SURR, SUBM, VOID, REQS, CMPL, HOLD, RELS, CANC.
data.containers[].events[].statusstringNoOne of: CEP, CPS, CGI, CLL, VDL, VAT, CDT, TSD, CLT, VDT, VAD, CDD, CGO, CDC, CER, LTS, BTS, UNK. Default: UNK.
data.containers[].events[].datestringNoEvent date, format 'yyyy-MM-dd HH:mm:ss'.
data.containers[].events[].actualboolean, nullableNo—
data.containers[].events[].is_additional_eventbooleanNoTrue if the event was calculated by SafeCube rather than provided by the carrier.
data.containers[].events[].typestringNosea for sea-related events, land for land-related events. One of: sea, land.
data.containers[].events[].transport_typestring, nullableNoOne of: VESSEL, BARGE, FEEDER, TRUCK, RAIL, AIR.
data.containers[].events[].vesselinteger (int32), nullableNoUnique identifier (id) from the vessels array.
data.containers[].events[].voyagestring, nullableNo—
data.facilitiesarray of object, nullableNo—
data.facilities[].idinteger (int32)NoUnique identifier referenced by events.
data.facilities[].namestringNo—
data.facilities[].country_codestring, nullableNo—
data.facilities[].locodestring, nullableNo—
data.facilities[].bic_codestring, nullableNo—
data.facilities[].smdg_codestring, nullableNo—
data.facilities[].latnumber (float), nullableNo—
data.facilities[].lngnumber (float), nullableNo—
data.route_dataobject, nullableNo—
data.route_data.routearray of object, nullableNoArray of route segments.
data.route_data.route[].patharray of array of number (float)NoArray of route coordinates, each item being a latitude, longitude pair.
data.route_data.route[].typestringNoOne of: SEA, LAND.
data.route_data.pinarray of number (float), nullableNoCurrent container position latitude, longitude.
data.route_data.aisobjectNo—
data.route_data.ais.statusstringNoOne of: OK, NOT_ON_BOARD, NO_AIS_DATA.
data.route_data.ais.dataobject, nullableNo—
data.route_data.ais.data.last_eventobjectNoThe latest event provided by the shipping line.
data.route_data.ais.data.last_event.descriptionstringNo—
data.route_data.ais.data.last_event.datestringNo—
data.route_data.ais.data.last_event.voyagestringNo—
data.route_data.ais.data.discharge_portobjectNo—
data.route_data.ais.data.discharge_port.namestring, nullableNo—
data.route_data.ais.data.discharge_port.country_codestring, nullableNo—
data.route_data.ais.data.discharge_port.codestring, nullableNo—
data.route_data.ais.data.discharge_port.datestring, nullableNo—
data.route_data.ais.data.discharge_port.date_labelstring, nullableNoOne of: ETA, ATA.
data.route_data.ais.data.vesselobjectNo—
data.route_data.ais.data.vessel.namestringNo—
data.route_data.ais.data.vessel.imointeger (int32), nullableNo—
data.route_data.ais.data.vessel.call_signstring, nullableNo—
data.route_data.ais.data.vessel.mmsiinteger (int32), nullableNo—
data.route_data.ais.data.vessel.flagstring, nullableNo—
data.route_data.ais.data.last_vessel_positionobjectNoAIS data of the vessel position.
data.route_data.ais.data.last_vessel_position.latnumber (float), nullableNo—
data.route_data.ais.data.last_vessel_position.lngnumber (float), nullableNo—
data.route_data.ais.data.last_vessel_position.updated_atstring, nullableNo—
data.route_data.ais.data.departure_portobjectNo—
data.route_data.ais.data.departure_port.country_codestring, nullableNo—
data.route_data.ais.data.departure_port.codestring, nullableNo—
data.route_data.ais.data.departure_port.datestring, nullableNo—
data.route_data.ais.data.departure_port.date_labelstring, nullableNoOne of: ETD, ATD.
data.route_data.ais.data.arrival_portobjectNo—
data.route_data.ais.data.arrival_port.country_codestring, nullableNo—
data.route_data.ais.data.arrival_port.codestring, nullableNo—
data.route_data.ais.data.arrival_port.datestring, nullableNo—
data.route_data.ais.data.arrival_port.date_labelstring, nullableNoOne of: ETA, ATA.
data.route_data.ais.data.updated_atstring, nullableNo—