Bulk Ocean Tracking Subscribe

Request

Query Params

companyCode

string

required

Enterprise ID

token

string

required

Encrypted signature token

orgCode

string

optional

Organization code

Body Params application/json

array of:

deliveryNo

string

optional

Delivery note number

<= 38 characters

orderNo

string

optional

Order number

<= 38 characters

localKey

string

optional

Customer Local Keywords

<= 38 characters

referenceNo

string

required

Subscription number

<= 32 characters

blType

string

required

Subscription type(BL=Bill of Lading number, BK=Booking number, CN=Container number, null value=Automatic identification)

<= 32 characters

carrierCd

string

required

Trackingeyes Shipowner Code(Please refer to the code in the Ocean Support List)

<= 16 characters

customer

string

optional

customer

<= 128 characters

etd

string <date-time>

optional

Estimated time of departure

polCd

string

optional

Port of origin code.If subscribing to terminal data and it is for export, it is required and must be a Chinese port.

<= 8 characters

pol

string

optional

Port of origin name

<= 64 characters

podCd

string

optional

Destination Port Code.If subscribing to port data and it is imported, it is required and must be a Chinese port.

<= 8 characters

pod

string

optional

Destination Port Name

<= 64 characters

customerService

string

optional

Business service name

<= 128 characters

noticeEmail

string

optional

Notification email：Real name

<= 255 characters

remark

string

optional

Remark

<= 255 characters

serviceType

string

optional

Service type(C=Ocean data,CT=Comprehensive Data)

<= 16 characters

extendNo

object

optional

Extended data Json

deliveryAddress

string

optional

Delivery Address

<= 255 characters

estDelTime

string

optional

Estimated Delivery Time

<= 30 characters

actDelTime

string

optional

Actual Delivery Completion Time

<= 30 characters

custReqDate

string

optional

Customer Requested Delivery Date

<= 30 characters

Example

[
    {
        "deliveryNo": null,
        "orderNo": null,
        "localKey": "",
        "referenceNo": "177QAZAZXTCN0541",
        "blType": "BL",
        "carrierCd": "MSC",
        "extendNo": null,
        "customer": null,
        "polCd": null,
        "customerService": null,
        "noticeEmail": null,
        "remark": null,
        "serviceType": "C",
    },
    {
        "deliveryNo": null,
        "orderNo": null,
        "localKey": "",
        "referenceNo": "SNLFSKALB61601",
        "blType": "BL",
        "carrierCd": "SINO",
        "extendNo": {"CtnrNo":"BHCU4987386"},
        "customer": null,
        "polCd": null,
        "customerService": null,
        "noticeEmail": null,
        "remark": null,
        "serviceType": "C",
    },
    {
        "deliveryNo": null,
        "orderNo": null,
        "localKey": "",
        "referenceNo": "6414918850",
        "blType": "",
        "carrierCd": "COSCO",
        "extendNo": null,
        "customer": null,
        "polCd": null,
        "customerService": null,
        "noticeEmail": null,
        "remark": null,
        "serviceType": "C"
     }
]

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.trackingeyes.com/api/oceanbill/batchOceanBill?companyCode=&token=&orgCode' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "deliveryNo": null,
        "orderNo": null,
        "localKey": "",
        "referenceNo": "177QAZAZXTCN0541",
        "blType": "BL",
        "carrierCd": "MSC",
        "extendNo": null,
        "customer": null,
        "polCd": null,
        "customerService": null,
        "noticeEmail": null,
        "remark": null,
        "serviceType": "C",
    },
    {
        "deliveryNo": null,
        "orderNo": null,
        "localKey": "",
        "referenceNo": "SNLFSKALB61601",
        "blType": "BL",
        "carrierCd": "SINO",
        "extendNo": {"CtnrNo":"BHCU4987386"},
        "customer": null,
        "polCd": null,
        "customerService": null,
        "noticeEmail": null,
        "remark": null,
        "serviceType": "C",
    },
    {
        "deliveryNo": null,
        "orderNo": null,
        "localKey": "",
        "referenceNo": "6414918850",
        "blType": "",
        "carrierCd": "COSCO",
        "extendNo": null,
        "customer": null,
        "polCd": null,
        "customerService": null,
        "noticeEmail": null,
        "remark": null,
        "serviceType": "C"
     }
]'

Responses

🟢200sucess

application/json

Body

code

integer

required

Batch Subscription Status Codes(200=success，300=warning，other=error)

type

string

optional

Batch Subscription Status(success、warning、error)

message

string

optional

Batch Subscription Notification Messages

result

array [object {16}]

required

Single Shipment Details

id

string

optional

Unique value,the ID returned by the Subscription interface

<= 40 characters

resultType

string

optional

Chinese Single Subscription Status

<= 32 characters

resultTypeCd

string

optional

Single Subscription Status.(success、error、booking、warning)

<= 32 characters

error

enum<string>

optional

Error Codes

<= 255 characters

Allowed values:

410141024103410451016101

errorMessage

string

optional

deliveryNo

string

optional

Delivery Number

<= 38 characters

orderNo

string

optional

Order Number

<= 600 characters

localKey

string

optional

Unique value,Customer Local Keywords

<= 38 characters

referenceNo

string

optional

Subscription Number (Bill of Lading Number, Booking Number, Container Number)

<= 32 characters

ctnrNo

string

optional

Container Number

<= 12 characters

carrierCd

string

optional

Shipping Company Code

<= 16 characters

billCreateTime

string <date-time>

optional

Subscription bill CreateTime

trackStatusCd

string

optional

Tracking Status（T=Tracking in progress, F=Subscription failed）

<= 2 characters

trackStatus

string

optional

Chinese description of tracking status

<= 12 characters

errorStatus

string

optional

Error Description

<= 20 characters

dataStatus

string

optional

Data Status

<= 20 characters

time

string <date-time>

optional

Request Time

Example

{
    "code": 200,
    "type": "success",
    "message": "",
    "result": [
        {
            "resultType": "订阅成功",
            "resultTypeCd": "success",
            "error": "",
            "id": "627472342581317",
            "deliveryNo": null,
            "orderNo": null,
            "localKey": null,
            "referenceNo": "278342554",
            "ctnrNo": null,
            "carrierCd": "MSK",
            "trackStatus": "跟踪中",
            "trackStatusCd": "T",
            "errorMessage": "",
            "errorStatus": "T",
            "billCreateTime": "2024-12-28 11:31:32",
            "dataStatus": null
        }
    ],
    "time": "2024-12-28 11:31:32"
}