Register ocean cargo tracking
# Endpoint
POST https://api.track123.com/gateway/open-api/tk/v1/ocean/track/import
# Interface description
Up to 100 tracking numbers can be imported at a time, the interface frequency limit is 3 requests/sec. The results include both accepted and rejected lists. The accepted list is consist of successful registered trackings and the rejected list is consist of failed ones.
- Note: Importing an ocean cargo tracking number will consume 200 tracking quotas.
# Request parameter
Name | Description | Required | Data type |
---|---|---|---|
trackingNo | Tracking number | true | String |
type | Tracking number type (1. booking number 2. bill of landing number 3. container number) | true | number |
carrierCode | The unique carrier code | true | String |
customerEmail | The customer email address associated with the order | false | String |
# Request example
[
{
"trackingNo": "MATS5217756000",
"carrierCode": "matson",
"type": 2,
"customerEmail": "support@track123.com"
},
{
"trackingNo": "MATS5217756001",
"carrierCode": "matson",
"type": 2,
"customerEmail": "support@track123.com"
}
]
# Response parameter
Name | Description | Type |
---|---|---|
code | Service status code | string |
msg | The description information corresponding to the service status code or other auxiliary description information. | string |
data | Object actually returned | object |
accepted | Successful registration of tracking number | array[object] |
trackingNo | Tracking number | String |
type | Tracking number type (1. booking number 2. bill of landing number 3. container number) | Integer |
carrierCode | The unique carrier code | String |
orderNo | The unique order number generated by Track123 when a tracking number is registered | String |
customerEmail | The customer email address associated with the order filled in by the merchant/platform | String |
rejected | Rejected registration of tracking number | array[object] |
trackingNo | Tracking number | String |
type | Tracking number type (1. booking number 2. bill of landing number 3. container number) | String |
carrierCode | The unique carrier code | Integer |
error | Error | object |
code | Error code | String |
msg | Error infomation | String |
# Response example
{
"code": "00000",
"data": {
"accepted": [
{
"trackingNo": "MATS5217756001",
"type": 2,
"orderNo": "11111112",
"carrierCode": "matson",
"customerEmail": "support@track123.com"
}
],
"rejected": [
{
"trackingNo": "MATS5217756000",
"type": 2,
"carrierCode": "matson",
"error": {
"code": "A0400",
"msg": "单号已经导入"
}
}
]
},
"msg": "成功",
"traceId": "N/A"
}