API Docs

Open Track Restful API and webhooks allow developers of online stores and marketplaces in any sizes to add tracking capability easily.


This Public API key can be used for local (localhost/127.0.0.1) development machine only :
Registration of your production key may difference from display as is :
uu6HsahEMwa1m0IsYeOV+K89aP6WYU6p53Hc4YUx24k=

Register Tracking Number (AutoGen)

Request Type: POST
API Url: https://opentracks.net/api/Tracking/v1/RegisterTrackId/auto
Parameter Descripton Type Require
publicAPIKey Public API Key String(50) Yes
checksumKey Private Checksum String(50) Yes
ReferDocumentCode Attach Document
Shipping No/Invoice No
String(20) No
ReferDocumentDate Attached document date
Fomat: yyyy-MM-dd
String(10) No
Slug Transport Provider Name String(100) Yes
ExpectedDeliveryDate Date of Expected Delivery
Fomat: yyyy-MM-dd
String(10) Yes
Location ISO Country Location
THA/USA/SGP
String(3) Yes
Message Status message String(200) Yes
AlertMail e-mail to update alert String(50) Yes
State Short message for state String(20) No
ArriveLatitude Latitude of Arrive Decimal(3,10) No
ArriveLongitude Longitude of Arrive Decimal(3,10) No
DestinationLatitude Latitude of Destination Decimal(3,10) No
DestinationLongitude Longitude of Destination Decimal(3,10) No

Return Code Descripton Type
200 Success Info
500 Blocked host request Error
501 Duplicate tracking number Error
502 Not allow register Error

Ajax Post:
https://opentracks.net/api/Tracking/v1/RegisterTrackId/auto
{
    "publicAPIKey": "uu6HsahEMwa1m0IsYeOV+K89aP6WYU6p53Hc4YUx24k=",
    "checksumKey": "== YOUR CHECKSUM ==",
    "ReferDocumentCode": "INV1808030001THA",
    "ReferDocumentDate": "2018-08-01",
    "Slug": "Kerry Express THA",
    "ExpectedDeliveryDate": "2018-08-03",
    "Location": "THA",
    "Message": "Register tacking form www.n2nplatform.com",
    "AlertMail": "info@n2nplatform.com",
    "State": "Vender approved order"
}

Result

JSON Result:
{
      "status", "200",
      "id": "b5dcc936283449e18f43d07891c29da4",
      "trackNumber": "EA110200000TH"
}

JSON Error Result:
{
      "status", "500",
      "message": "Blocked host request",
}
{
      "status", "501",
      "message": "Duplicate tracking number",
      "id": "b5dcc936283449e18f43d07891c29da4"
}
{
      "status", "502",
      "message": "Not allow register"
}


Register Tracking Number (Manual Number)

Request Type: POST
API Url: https://opentracks.net/api/Tracking/v1/RegisterTrack/{tracknumber}
Parameter Descripton Type Require
{tracknumber} Your Tracking Number String(20) Yes
publicAPIKey Public API Key String(50) Yes
checksumKey Private Checksum String(50) Yes
ReferDocumentCode Attach Document
Shipping No/Invoice No
String(20) No
ReferDocumentDate Attached document date
Fomat: yyyy-MM-dd
String(10) No
Slug Transport Provider Name String(100) Yes
ExpectedDeliveryDate Date of Expected Delivery
Fomat: yyyy-MM-dd
String(10) Yes
Location ISO Country Location
THA/USA/SGP
String(3) Yes
Message Status message String(200) Yes
AlertMail e-mail to update alert String(50) Yes
State Short message for state String(20) No
ArriveLatitude Latitude of Arrive Decimal(3,10) No
ArriveLongitude Longitude of Arrive Decimal(3,10) No
DestinationLatitude Latitude of Destination Decimal(3,10) No
DestinationLongitude Longitude of Destination Decimal(3,10) No

Return Code Descripton Type
200 Success Info
500 Blocked host request Error
501 Duplicate tracking number Error
502 Not allow register Error

Ajax Post:
https://opentracks.net/api/Tracking/v1/RegisterTrack/{tracknumber}
{
    "publicAPIKey": "uu6HsahEMwa1m0IsYeOV+K89aP6WYU6p53Hc4YUx24k=",
    "checksumKey": "== YOUR CHECKSUM ==",
    "ReferDocumentCode": "INV1808030001THA",
    "ReferDocumentDate": "2018-08-01",
    "Slug": "Kerry Express THA",
    "ExpectedDeliveryDate": "2018-08-03",
    "Location": "THA",
    "Message": "Register tacking form www.n2nplatform.com",
    "AlertMail": "info@n2nplatform.com",
    "State": "Vender approved order"
}

Result

JSON Result:
{
      "status", "200",
      "id": "b5dcc936283449e18f43d07891c29da4",
      "trackNumber": "EA110200000TH"
}

JSON Error Result:
{
      "status", "500",
      "message": "Blocked host request",
}
{
      "status", "501",
      "message": "Duplicate tracking number",
      "id": "b5dcc936283449e18f43d07891c29da4"
}
{
      "status", "502",
      "message": "Not allow register"
}


Modify Tracking Info

Request Type: POST
API Url: https://opentracks.net/api/Tracking/v1/ModifyTrack/{trackingid}
Parameter Descripton Type Require
{TrackingId} Your Track Unique ID String(50) Yes
publicAPIKey Public API Key String(50) Yes
checksumKey Private Checksum String(50) Yes
ReferDocumentCode Attach Document
Shipping No/Invoice No
String(20) No
ReferDocumentDate Attached document date
Fomat: yyyy-MM-dd
String(10) No
Slug Transport Provider Name String(100) Yes
ExpectedDeliveryDate Date of Expected Delivery
Fomat: yyyy-MM-dd
String(10) Yes
Location ISO Country Location
THA/USA/SGP
String(3) Yes
TrackState
EnumValue
InfoReceived
Preparing
Packing
Ready
Pickup
InTransit
DistributionCenter
OutForDelivery
Delivered
Cancel
AttemptFail
Exception
Return
---
ModifyTrack
Disabled
0
1
2
3
4
5
6
7
9
10
11
12
99
 
100
-1
String(Enum) Yes
Message Status message String(200) Yes
AlertMail e-mail to update alert String(50) Yes
State Short message for state String(20) No
ArriveLatitude Latitude of Arrive Decimal(3,10) No
ArriveLongitude Longitude of Arrive Decimal(3,10) No
DestinationLatitude Latitude of Destination Decimal(3,10) No
DestinationLongitude Longitude of Destination Decimal(3,10) No

Return Code Descripton Type
200 Success Info
500 Blocked host request Error
505 Not allow modify Error

Ajax Post:
https://opentracks.net/api/Tracking/v1/ModifyTrack/b5dcc936283449e18f43d07891c29da4
{
    "publicAPIKey": "uu6HsahEMwa1m0IsYeOV+K89aP6WYU6p53Hc4YUx24k=",
    "checksumKey": "== YOUR CHECKSUM ==",
    "ReferDocumentCode": "INV1808030001THA",
    "ReferDocumentDate": "2018-08-01",
    "Slug": "Kerry Express THA",
    "ExpectedDeliveryDate": "2018-08-03",
    "Location": "THA",
    "TrackState", "InTransit",
    "Message": "Your traking in transit state",
    "AlertMail": "info@n2nplatform.com",
    "State": "Vender approved order"
}

Result

JSON Result:
{
      "status", "200",
      "id": "b5dcc936283449e18f43d07891c29da4",
      "trackNumber": "EA110200000TH"
}

JSON Error Result:
{
      "status", "500",
      "message": "Blocked host request",
}
{
      "status", "505",
      "message": "Not allow modify"
}


Get Tracking Number

Request Type: POST
API Url: https://opentracks.net/api/Tracking/v1/GetData/{trackingnumber}
Parameter Descripton Type Require
{trackingnumber} Your Tracking Number String(20) Yes
publicAPIKey Public API Key String(50) Yes
checksumKey Private Checksum String(50) Yes

Return Code Descripton Type
200 Success Info
506 Tracking not found Error

Ajax Post:
https://opentracks.net/api/Tracking/v1/GetData/EA110200000TH
{
    "publicAPIKey": "uu6HsahEMwa1m0IsYeOV+K89aP6WYU6p53Hc4YUx24k=",
    "checksumKey": "== YOUR CHECKSUM =="
}

Result

JSON Result:
{
    "status" : "200",
    "Tracking": {
        "Id": "b5dcc936283449e18f43d07891c29da4",
        "TrackingNumber": "EA110200000TH",
        "ReferDocumentCode": "IB1808300001TH",
        "ReferDocumentDate": null,
        "Slug": "Kerry Express THA",
        "Active": true,
        "ExpectedDeliveryDate": "2018-08-03",
        "TrackState": "InTransit",
        "SourceCode": "N2NPLATFORM",
        "SourceName": "N2N Business Platform Co., Ltd.",
        "SourceCountryName": "Thailand, THA",
        "Website": "https://www.n2nplatform.com",
        "ArriveLatitude": 0.0000000000,
        "ArriveLongitude": 0.0000000000,
        "DestinationLatitude": 0.0000000000,
        "DestinationLongitude": 0.0000000000,
        "CheckPoints": [
            {
                "Slug": "kerry-transports",
                "Location": "US",
                "Message": "Order Processed: Ready for deliver",
                "CountryName": "USA",
                "TrackState": "InfoReceived",
                "CheckpointTime": "2016-09-26T19:40:00",
                "State": null,
                "Latitude": 0.0000000000,
                "Longitude": 0.0000000000
            },
            {
                "Slug": "kerry-transports",
                "Location": "US",
                "Message": "Departure Scan",
                "CountryName": "USA",
                "TrackState": "InTransit",
                "CheckpointTime": "2016-09-27T10:13:13",
                "State": "QC",
                "Latitude": 0.0000000000,
                "Longitude": 0.0000000000
            }
        ]
    }
}

Update Tracking Number

Request Type: POST
API Url: https://opentracks.net/api/Tracking/v1/UpdateTrack/{trackingnumber}
Parameter Descripton Type Require
{trackingnumber} Your Tracking Number String(50) Yes
publicAPIKey Public API Key String(50) Yes
checksumKey Private Checksum String(50) Yes
Slug Transport Provider Name String(100) Yes
Location ISO Country Location
THA/USA/SGP
String(3) Yes
Message Status message String(200) Yes
TrackState
EnumValue
InfoReceived
Preparing
Packing
Ready
Pickup
InTransit
DistributionCenter
OutForDelivery
Delivered
Cancel
AttemptFail
Exception
Return
---
ModifyTrack
Disabled
0
1
2
3
4
5
6
7
9
10
11
12
99
 
100
-1
String(Enum) Yes
State Short message for state String(20) No
Latitude Latitude of Checkpoint Decimal(3,10) No
Longitude Longitude of Checkpoint Decimal(3,10) No

Return Code Descripton Type
200 Success Info
500 Blocked host request Error
503 Not allow update Error
504 Track not actived Error

Ajax Post:
https://opentracks.net/api/Tracking/v1/UpdateTrack/EA110200000TH
{
    "publicAPIKey": "uu6HsahEMwa1m0IsYeOV+K89aP6WYU6p53Hc4YUx24k=",
    "checksumKey": "== YOUR CHECKSUM ==",
    "Slug": "Kerry Express THA",
    "Location": "THA",
    "Message": "Transport pickup your order",
    "TrackState": "InTransit"
    "State": null,
    "Latitude": 0.0000000000,
    "Longitude": 0.0000000000
}

Result

JSON Result:
{
      "status", "200",
      "id": "b5dcc936283449e18f43d07891c29da4"
}

JSON Error Result:
{
      "status", "500",
      "message": "Blocked host request",
}
{
      "status", "503",
      "message": "Not allow update track",
}
{
      "status", "504",
      "message": "Track not actived",
}


Developer Intro Compare Feature