海运跟踪单号订阅 - 云当网数据接口

调用该接口前，需要先使用[获取Token API]获取token。token 有效期是2小时，超过了2小时得重新获取。

请求参数

Query 参数

companyid

string

企业编号

必需

示例值:

1000

token

string

必需

Token（请先通过获取token接口获取token）

示例值:

ef658236-00e4-4dae-b516-4f21b25b11f0

Body 参数application/x-www-form-urlencoded

data

string

可选

订阅参数，传的是JSON数据。keyid:可以传贵司自定义的主键。carriercd：船东代码（云当代码）必填。referenceno：订阅号(提单号/订舱号)必填。pol：起运港代码。dtp：卸货港代码。ctnrno：箱号

示例值:

[{"keyid": "123","carriercd": "COSCO","referenceno": "6135761320", "pol":"CNNGB","ctnrno":""}]

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

success

boolean

API调用是否成功(Is the API call successful)

可选

true=成功；false=失败（API调用成功）
(True=successful; False=failed (API call successful))

result

array [object {7}]

具体单号订阅结果集(Specific order number subscription result set)

可选

具体单号订阅结果集(Specific order number subscription result set)

localkeyid

string

业务关键字(Business keywords)

可选

对应订阅参数的keyid，用于回写时识别业务关键字(The keyid corresponding to the subscription parameter, used to identify business keywords during write back)

>= 18 字符

referenceno

string

上传订阅的单号( Upload subscription number)

可选

船东主单号/船东订舱号(Shipowner's main tracking number/shipowner booking number)

success

boolean

是否成功订阅(Successfully subscribed)

可选

true=订阅成功，false=订阅失败(True=subscription successful, false=subscription failed)

message

string

错误信息(error message)

可选

接口异常藐视(Interface exception contempt)

>= 18 字符

ctnrno

string

上传订阅的箱号(Upload the subscribed container number)

可选

集装箱号(Container number)

>= 11 字符<= 11 字符

carriercd

string

上传订阅的船东代码(Upload the subscribed shipowner code)

必需

船东代码，具体参照“云当网船东支持清单”(Ship owner code, please refer to the "Yundang Network Ship Owner Support List" for details)

>= 5 字符

isctnr

string

是否是箱号订阅(Is it a container number subscription)

可选

0=否；1=是(0=No; 1=Yes)

>= 2 字符

示例

首次订阅返回示例重复订阅返回示例

{
    "success": true,
    "items": [],
    "number": 1,
    "result": [
        {
            "localkeyid": "123",
            "referenceno": "6135761320",
            "ctnrno": "CSNU6217837",
            "carriercd": "COSCO",
            "isctnr": "",
            "success": true,
            "message": null
        }
    ]
}