批量运单订阅接口 - Trackingeyes数据接口

请求参数

Query 参数

companyCode

string

必需

企业编号（需向云当网申请）

token

string

必需

获取token接口返回的记录

orgCode

string

组织代码

可选

Body 参数application/json

array of:

deliveryNo

string

交货单号

可选

<= 38 字符

orderNo

string

需货单号

可选

<= 38 字符

localKey

string

客户本地关键字

可选

唯一值

<= 38 字符

referenceNo

string

订阅号

必需

<= 32 字符

blType

string

订阅类型

可选

BL=提单号/BK=订舱号/CN=箱号，空值=自动识别

<= 32 字符

carrierCd

string

云当船东代码

必需

船东代码参照海运支持清单中云当代码

<= 16 字符

extendNo

object

扩展数据

可选

如提单订阅SINO，该字段必须传一个箱号才能订阅成功，例如：{"CtnrNo":"BHCU4987386"}，字段仅限用于SINO船东

customer

string

客户

可选

<= 128 字符

etd

string <date-time>

预计开航时间

可选

Datetime类型

polCd

string

起运港代码

可选

港口代码参照云当港口代码表,订阅码头数据且是出口则必填，且必须为国内港口

<= 8 字符

pol

string

起运港名称

可选

<= 64 字符

podCd

string

目的港代码

可选

港口代码参照云当港口代码表,订阅码头数据且是进口则必填，且必须为国内港口

<= 8 字符

pod

string

目的港名称

可选

<= 64 字符

customerService

string

商服姓名

可选

<= 128 字符

noticeEmail

string

通知邮箱

可选

<= 255 字符

remark

string

备注

可选

如需要备注的内容，填入该字段

<= 255 字符

serviceType

string

服务类型

可选

C=船东，CT=综合接口

<= 16 字符

deliveryAddress

string

派送地址

可选

<= 255 字符

estDelTime

string

预计派送时间

可选

<= 30 字符

actDelTime

string

实际派送完成时间

可选

<= 30 字符

custReqDate

string

客户要求交期

可选

<= 30 字符

示例

[
    {
        "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"
     }
]

示例代码

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"
     }
]'

返回响应

🟢200成功

application/json

Body

code

integer

批量订阅状态代码

必需

200=success，300=warning，其他=error

type

string

批量订阅状态

可选

success、warning、error

<= 32 字符

message

string

批量订阅提示信息

必需

具体长度视报错信息决定

result

array [object {16}]

单票详情

必需

id

string

该票关键字

必需

云端返回

<= 40 字符

resultType

string

单票订阅状态（中文）

可选

订阅成功、订阅失败、订阅中

<= 32 字符

resultTypeCd

string

单票订阅状态

可选

success=订阅成功、error=订阅失败、booking=订阅中、warning=订阅提醒

<= 32 字符

error

enum<string>

错误代码

可选

<= 255 字符

枚举值:

410141024103410451016101

errorMessage

string

错误描述

可选

deliveryNo

string

交货单号

可选

<= 38 字符

orderNo

string

需货单号

可选

<= 600 字符

localKey

string

该票关键字

可选

唯一值，客户端上传，推送时可返回

<= 38 字符

referenceNo

string

订阅单号

可选

提单号、订舱号、箱号

<= 32 字符

ctnrNo

string

箱号

可选

<= 12 字符

carrierCd

string

云当船东代码

可选

<= 16 字符

billCreateTime

string <date-time>

运单创建时间

可选

订阅成功才有创建时间

trackStatusCd

string

跟踪状态

可选

T=跟踪中、F=订阅失败

<= 2 字符

trackStatus

string

跟踪状态中文描述

可选

<= 12 字符

errorStatus

string

异常状态

可选

T=提示、E=错误，空值

<= 20 字符

dataStatus

string

数据状态

可选

<= 20 字符

time

string <date-time>

请求时间

必需

示例

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