The SVMP APIs allow you to utilize a variety of data provided within SVMP, including vessel and cargo location tracking and historical and forecasted voyages. This document describes the parameters for calling each API and the properties of the objects returned. If you have any questions, please contact [email protected].

API

1) User authentication

SVMP API uses the Basic Auth (account/password) authentication method for API user authentication. Please send the issued user account and password in the request header and you can use it immediately.

2) Ship Tracking

Below are the steps to track your vessel:

Retrieve ship information

Request URL

GET /api/v2/ship/search?keyword={ImoNo-ShipName}

Response body

{
  "code": 200,
  "message": "OK",
  "error": false,
  "timestamp": "2021-12-09T09:57:41Z",
  "response": [
    {
      "shipId": "b794428e-8b3a-11e9-b34d-54802853d888", //{SVMP Ship ID}
      "imoNo": "9769295",
      "mmsi": "538007476",
      "callSign": "V7PO8",
      "shipType": "CONTAINER",
      "shipTypeCargo": "fully cellular containership",
      "shipImage": null,
      "built": 2017,
      "dwt": 197106, //{DeadWeight}
      "hullType": "Single",
      "gt": 210678, //{GrossTonnage}
      "destination": "Hong Kong",
      "eta": null,
      "shipStatusType": "Active",
      "builtBy": "Samsung Shipbuilding & Heavy Industries Company Limited",
      "builtAt": "South Korea",
      "loa": 400,
      "engineBuiltBy": null,
      "designedBy": "MAN Diesel AS",
      "serviceSpeed": null,
      "nationCode": "MH",
      "useYn": "Y",
      "position": {
        "imoNo": "9769295",
        "mmsi": "538007476",
        "mmsiProcess": null,
        "imoNoProcess": null,
        "mmsiOrigin": null,
        "imoNoOrigin": null,
        "aisProcessStatus": null,
        "clusterTotalCount": null,
        "deviceType": "AIS",
        "aisShipType": 72,
        "aisDimA": 34,
        "aisDimB": 257,
        "aisDimC": 25,
        "aisDimD": 34,
        "aisEta": "{ETA announced by the ship}",
        "aisDestination": "{Destination announced by the ship}",
        "aisClass": "A",
        "nvgStatus": 15,
        "longitude": 110.30814,
        "latitude": 13.95823167,
        "elapsed": 0,
        "utcSecond": 60,
        "dte": 1,
        "specialManeuverIndicator": "0",
        "raimFlag": "0",
        "staticMessageNo": 5,
        "locationMessageNo": 1,
        "callsSign": "V7PO8",
        "shipName": "MOL TRIBUTE",
        "staticDateTime": "2021-12-08T12:45:34Z",
        "timestamp": "2021-12-09T09:26:18Z",
        "rateOfTurn": 128,
        "speedOverGround": 16.6,
        "positionAccuracy": 0,
        "courseOverGround": 197,
        "trueHeading": 195,
        "aisMaxDraught": 15.1
      },
      "siteShip": {
        "siteId": "4a88d1f3-9913-4d09-8686-b13837b3baf6",
        "shipId": "b794428e-8b3a-11e9-b34d-54802853d888",
        "registerId": "{your-account-id}",
        "registDateTime": "2021-05-10T09:29:14Z"
      },
      "shipName": "{ship-name}",
      "shipAliasName": null,
      "shipTypeBySize": "CONTAINER01",
      "depth": 32.8,
      "maxDraught": 17
    }
  ]
}

3) Cargo Tracking(Cargo location tracking)

Below are the steps to track your shipment

Send basic information for cargo tracking

Request URL

POST /api/v2/cargo?bookingNo={your-booking-No}&carrierCode={SCAC-code}
POST /api/v2/cargo?mblNo={your-master-bl-No}&carrierCode={SCAC-code}

{
  "bookingRegno": "{Booking Registration No}",
  "hbls": [
    {
      "ciNo": "{Commercial Invoice No}",
      "consigneeCode": "{Your Consignee Code}",
      "consigneeName": "{Your Consignee Name}",
      "containers": [
        {
          "commodify": "{Your Commodity}",
          "containerNo": "{Your Container No}",
          "gw": {Your Gross weight},
          "hscode": "{Your hscode}",
          "qty": {Your Container Qty},
          "sealNo1": "{SealNo#1}",
          "sealNo2": "{SealNo#2}",
          "sealNo3": "{SealNo#3}",
          "size": "{Your container size}",
          "type": "{Your container type}"
        }
      ],
      "hblNo": "{Your house BL}",
      "ownerCode": "{Your Cargo Owner Code}",
      "ownerName": "{Your Cargo Owner Name}",
      "shipperCode": "{Your Cargo Shipper Code}",
      "shipperName": "{Your Cargo Shipper Name}"
    }
  ],
  "srNo": "{Shipping Request No}"
}