场站数据订阅接口 - Trackingeyes数据接口

请求参数

Query 参数

companyCode

string

必需

公司编码（需向云当网申请）

orgCode

string

组织编码

可选

token

string

必需

获取token接口返回的token值

Body 参数application/json

array of:

referenceNo

string

订阅号

必需

提单号

<= 32 字符

depotCd

string

场站代码

必需

参照“场站支持清单”

<= 12 字符

portCd

string

港口代码

必需

只支持青岛港，代码是CNTAO

<= 12 字符

localKey

string

客户本地关键字

可选

<= 38 字符

extendNo

string

拓展字段Json

可选

长度由实际数据决定，暂未使用

<= 255 字符

customer

string

客户

可选

<= 128 字符

remark

string

备注

可选

<= 255 字符

示例

[
    {
        "referenceNo": "HDMUTAOE88074700",
        "depotCd": "TAOJHDC",
        "portCd": "CNTAO",
        "localKey": "",
        "extendNo": "",
        "customer": "",
        "remark": ""
    }
]

示例代码

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/deport/booking?companyCode=&orgCode&token=' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "referenceNo": "HDMUTAOE88074700",
        "depotCd": "TAOJHDC",
        "portCd": "CNTAO",
        "localKey": "",
        "extendNo": "",
        "customer": "",
        "remark": ""
    }
]'

返回响应

🟢200成功

application/json

Body

code

integer

批量订阅状态代码

必需

200=全部订阅成功，300=警告（部分失败），400=全部订阅失败，500=异常

codeDesc

string

批量订阅状态描述

必需

success=全部订阅成功, warning=警告(结果中有itemCodeDesc=warning或者failure)，failure=全部订阅失败

<= 255 字符

message

string

异常信息

必需

<= 255 字符

result

array [object {11}]

结果集（单票订阅详情）

必需

referenceNo

string

订阅号

可选

<= 32 字符

depotCd

string

场站代码

可选

<= 12 字符

portCd

string

港口代码

可选

<= 12 字符

extendNo

string

拓展字段Json

可选

长度由实际数据决定，暂未使用

<= 255 字符

customer

string

客户

可选

<= 128 字符

remark

string

备注

可选

<= 255 字符

id

string

运单id

可选

订阅成功后返回的唯一值

<= 32 字符

localKey

string

客户本地关键字

可选

<= 38 字符

itemCode

integer

单票订阅状态

可选

200=成功，300=警告（重复订阅等），400=失败

itemCodeDesc

string

单票订阅状态说明

可选

success=订阅成功, warning=警告(重复订阅等)，failure=订阅失败

<= 8 字符

itemMessage

string

补充说明

可选

订阅失败的原因等

<= 255 字符

示例

{
    "code": 200,
    "codeDesc": "success",
    "message": "Operation succeeded",
    "result": [
        {
            "referenceNo": "HDMUTAOE88074700",
            "depotCd": "TAOJHDC",
            "portCd": "CNTAO",
            "extendNo": "",
            "customer": "",
            "remark": "",
            "id": "1876841631722901504",
            "localKey": "",
            "itemCode": 200,
            "itemCodeDesc": "success",
            "itemMessage": ""
        }
    ]
}