Subscribe to Tracking

Developing

Testing Env

https://demo.modaltrans.com

POST

/api/v1/trackings

Subscribe to tracking by Container number or Bill of Lading (MBL) number.

If you are tracking using BL+CT, please use the following format ;

{    
    "tracking_master": {
      "carrier_code": "WECU",
      "tracking_by": "BL+CT", 
      "mbl_no": "WEC12345",
      "container_no": "CDU123213213"
    }
}

Not all SCAC codes are supported. Please refer to the Supported SCAC Code list for a complete overview of the compatible codes and ensure you're using the correct one.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

tracking_master

object

required

carrier_code

string

required

Standard Carrier Alpha Code (SCAC)

tracking_by

enum<string>

required

Specifies whether to track by Container (CT) number or MBL (BL) number.

Allowed values:

CTBLBL+CT

tracking_num

string

optional

The container number or MBL number of loading.

mbl_no

string

optional

Bill of Lading number of loading.

container_no

string

optional

Container number of loading.

Example

{    
    "tracking_master": {
      "carrier_code": "MEDU",
      "tracking_by": "BL", 
      "tracking_num": "MEDU123456"
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://demo.modaltrans.com/api/v1/trackings' \
--header 'Content-Type: application/json' \
--data-raw '{    
    "tracking_master": {
      "carrier_code": "MEDU",
      "tracking_by": "BL", 
      "tracking_num": "MEDU123456"
    }
}'

Responses

🟢200Success

application/json

Body

tracking_created

string

required

Example

{"tracking_created":"Tracking has been successfully initiated."}

🟠403Forbidden

🟠400Bad Request

🟠422Unprocessable Entity

Modified at 2025-01-22 11:23:41

Retrieve a Tracking Data

Retrieve a Shipment