快递数据订阅接口 - Trackingeyes数据接口

请求参数

Query 参数

companyCode

string

必需

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

orgCode

string

组织编码

可选

token

string

必需

获取token接口返回的token值

Body 参数application/json

array of:

trackNo

string

快递单号

必需

<= 32 字符

slug

string

承运商代码

可选

<= 28 字符

slugGroup

string

承运商集团代码

可选

<= 28 字符

language

string

动态描述语言

可选

en=英文，zh=中文

<= 2 字符

trackingAccount

string

承运商官网跟踪账号

可选

<= 64 字符

trackingKey

string

跟踪密钥

可选

<= 255 字符

trackingShipDate

string

货物发货日期

可选

<= 20 字符

smses

string

接受sms的电话号码

可选

<= 16 字符

orgCountryCd

string

始发地国家/地区代码

可选

<= 3 字符

orgState

string

始发地州/省

可选

<= 32 字符

orgPostCd

string

始发地邮政编号

可选

<= 10 字符

org

string

始发地地点全称

可选

<= 128 字符

dstCountryCd

string

目的地国家/地区代码

可选

<= 3 字符

dstState

string

目的地州/省

可选

<= 32 字符

dstPostCd

string

目的地邮政编号

可选

<= 10 字符

dst

string

目的地地点全称

可选

<= 128 字符

localKey

string

客户本地关键字

可选

<= 38 字符

customer

string

客户

可选

<= 128 字符

extendNo

string

拓展字段Json

可选

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

remark

string

备注

可选

<= 255 字符

示例

[
    {
        "trackNo": "YT8946689954911",
        "slug": "yto",
        "slugGroup": "",
        "language": "",
        "trackingAccount": "",
        "trackingKey": "",
        "trackingShipDate": "",
        "smses": "",
        "orgCountryCd": "",
        "orgState": "",
        "orgPostCd": "",
        "org": "",
        "dstCountryCd": "",
        "dstState": "",
        "dstPostCd": "",
        "dst": "",
        "localKey": "",
        "customer": "",
        "extendNo": "",
        "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/express/booking?companyCode&orgCode&token' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "trackNo": "YT8946689954911",
        "slug": "yto",
        "slugGroup": "",
        "language": "",
        "trackingAccount": "",
        "trackingKey": "",
        "trackingShipDate": "",
        "smses": "",
        "orgCountryCd": "",
        "orgState": "",
        "orgPostCd": "",
        "org": "",
        "dstCountryCd": "",
        "dstState": "",
        "dstPostCd": "",
        "dst": "",
        "localKey": "",
        "customer": "",
        "extendNo": "",
        "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 {24}]

结果集（单票订阅详情）

必需

trackNo

string

快递单号

可选

<= 32 字符

slug

string

承运商代码

可选

<= 28 字符

slugGroup

string

承运商集团代码

可选

<= 28 字符

language

string

动态描述语言

可选

en=英文，zh=中文

<= 2 字符

trackingAccount

string

承运商官网跟踪账号

可选

<= 64 字符

trackingKey

string

跟踪密钥

可选

<= 255 字符

trackingShipDate

string

货物发货日期

可选

<= 20 字符

smsEs

string

接受sms的电话号码

可选

<= 16 字符

orgCountryCd

string

始发地国家/地区代码

可选

<= 3 字符

orgState

string

始发地州/省

可选

<= 32 字符

orgPostCd

string

始发地邮政编号

可选

<= 10 字符

org

string

始发地地点全称

可选

<= 128 字符

dstCountryCd

string

目的地国家/地区代码

可选

<= 3 字符

dstState

string

目的地州/省

可选

<= 32 字符

dstPostCd

string

目的地邮政编号

可选

<= 10 字符

dst

string

目的地地点全称

可选

<= 128 字符

customer

string

客户

可选

<= 38 字符

extendNo

string

拓展字段Json

可选

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

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": [
        {
            "trackNo": "YT8946689954911",
            "slug": "yto",
            "slugGroup": "",
            "language": "",
            "trackingAccount": "",
            "trackingKey": "",
            "trackingShipDate": "",
            "smsEs": "",
            "orgCountryCd": "",
            "orgState": "",
            "orgPostCd": "",
            "org": "",
            "dstCountryCd": "",
            "dstState": "",
            "dstPostCd": "",
            "dst": "",
            "customer": "",
            "extendNo": "",
            "remark": "",
            "id": "1927559716669960192",
            "localKey": "",
            "itemCode": 200,
            "itemCodeDesc": "success",
            "itemMessage": ""
        }
    ]
}