Ocean Tracking Subscribe - TrackingEyes-API

Request

Query Params

companyCode

string

optional

Enterprise ID

token

string

optional

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, default BL）

<= 32 characters

carrierCd

string

required

Trackingeyes Shipowner Code

<= 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(Port code name refer to the Yundang port code table)

<= 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(Port code name refer to the Yundang port code table)

<= 64 characters

customerService

string

optional

Business service name

<= 128 characters

noticeEmail

string

optional

Notification email

<= 255 characters

remark

string

optional

Remark

<= 255 characters

serviceType

string

optional

Service type(C= owner /T= terminal /V= voyage, multiple directly spliced together, such as CT, the same batch of data has the first data service type shall be subject to)

<= 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": "123456",
    "orderNo": "123456",
    "localKey": "123456",
    "referenceNo": "ZG23119177788",
    "carrierCd": "ZSH",
    "Customer": "Flying fish technology",
    "PLRCd": null,
    "PLR": null,
    "POLCd": null,
    "POL": null,
    "PODCd": null,
    "POD": null,
    "CustomerService": "Alice;Anna",
    "NoticeEmail": "",
    "Remark": null,
    "blType": "string",
    "serviceType": "string",
    "extendNo": "{'CtnrNo':'SNBU2347549'}",
    "deliveryAddress": null,
    "estDelTime": null,
    "actDelTime": null,
    "custReqDate": null
  }
]

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": "123456",
        "orderNo": "123456",
        "localKey": "123456",
        "referenceNo": "ZG23119177788",
        "carrierCd": "ZSH",
        "Customer": "Flying fish technology",
        "PLRCd": null,
        "PLR": null,
        "POLCd": null,
        "POL": null,
        "PODCd": null,
        "POD": null,
        "CustomerService": "Alice;Anna",
        "NoticeEmail": "",
        "Remark": null,
        "blType": "string",
        "serviceType": "string",
        "extendNo": "{'\''CtnrNo'\'':'\''SNBU2347549'\''}",
        "deliveryAddress": null,
        "estDelTime": null,
        "actDelTime": null,
        "custReqDate": null
    }
]'

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

Shipment Keywords

<= 40 characters

resultType

string

optional

Single Shipment Subscription Status (in Chinese).(订阅成功、订阅失败、订阅中)

<= 32 characters

resultTypeCd

string

optional

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

<= 32 characters

error

enum<string>

optional

Error Codes

<= 255 characters

Allowed values:

41014102410341045101

errorMessage

string

optional

Error Message

deliveryNo

string

optional

Delivery Number

<= 38 characters

orderNo

string

optional

Order Number

<= 600 characters

localKey

string

optional

Keywords for This Shipment, Uploaded by the Client, Can Be Returned Upon Push

<= 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.

<= 2 characters

trackStatus

string

optional

Exception 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"
}