港区数据订阅接口

POST

/api/portdata/batchBooking

每次订阅数量限制30条。

请求参数

Query 参数

companyCode

string

必需

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

orgCode

string

组织编码

可选

token

string

必需

获取token接口返回的token值

Body 参数application/json

array of:

localKey

string

客户本地关键字

可选

<= 38 字符

referenceNo

string

订阅号

必需

提单号/箱号

<= 32 字符

blType

enum<string>

订阅类型

必需

BL=提单号订阅，CN=箱号订阅

<= 32 字符

枚举值:

BLCN

portcd

string

港口代码

必需

参照"港区数据支持清单"

<= 8 字符

ieId

enum<string>

进出口标识

必需

I=进口，E=出口

<= 2 字符

枚举值:

customerService

string

商服姓名

可选

多个以英文;隔开

<= 128 字符

extendNo

string

扩展字段Json

可选

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

remark

string

备注

可选

<= 255 字符

示例

[
  {
    "localKey": null,
    "referenceNo": "6404722375",
    "blType": "BL",
    "portcd": "CNYTN",
    "ieId": "E",
    "customerService": null,
    "extendNo": null,
    "remark": null
  },
  {
    "localKey": null,
    "referenceNo": "SZPECR439800",
    "blType": "BL",
    "portcd": "CNYTN",
    "ieId": "E",
    "customerService": null,
    "extendNo": null,
    "remark": null
  },
  {
    "localKey": null,
    "referenceNo": "HKGM73233500",
    "blType": "BL",
    "portcd": "CNYTN",
    "ieId": "E",
    "customerService": null,
    "extendNo": null,
    "remark": null
  }
]

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.trackingeyes.com/api/portdata/batchBooking?companyCode=&orgCode&token' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "localKey": null,
        "referenceNo": "6404722375",
        "blType": "BL",
        "portcd": "CNYTN",
        "ieId": "E",
        "customerService": null,
        "extendNo": null,
        "remark": null
    },
    {
        "localKey": null,
        "referenceNo": "SZPECR439800",
        "blType": "BL",
        "portcd": "CNYTN",
        "ieId": "E",
        "customerService": null,
        "extendNo": null,
        "remark": null
    },
    {
        "localKey": null,
        "referenceNo": "HKGM73233500",
        "blType": "BL",
        "portcd": "CNYTN",
        "ieId": "E",
        "customerService": null,
        "extendNo": null,
        "remark": null
    }
]'

返回响应

🟢200成功

application/json

Body

code

integer

批量订阅状态代码

必需

200=全部订阅成功, 300=警告(部分失败)，400=全部订阅失败,500=异常

codeDesc

string

批量订阅状态描述

可选

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

<= 255 字符

message

string

异常信息

可选

result

array [object {12}]

单票订阅详情

必需

string

运单id

可选

订阅成功后返回的唯一值

<= 40 字符

localKey

string

客户关键字

可选

<= 38 字符

referenceNo

string

订阅号

必需

提单号或箱号

<= 32 字符

blType

enum<string>

订阅类型

必需

BL=提单号订阅，CN=箱号订阅

<= 32 字符

枚举值:

BLCN

portcd

string

港口代码

必需

参照"港区数据支持清单"

<= 8 字符

ieId

enum<string>

进出口标识

必需

I=进口，E=出口

<= 2 字符

枚举值:

customerService

string

商服姓名

可选

多个以英文;隔开

<= 128 字符

extendNo

string

扩展字段Json

可选

remark

string

备注

必需

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

<= 255 字符

itemCode

integer

单票订阅状态代码

必需

200=订阅成功，400=订阅失败

itemCodeDesc

string

单票订阅状态描述

可选

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

<= 32 字符

message

string

补充说明

可选

订阅失败原因等

示例

{
  "code": 200,
  "codeDesc": "success",
  "message": "",
  "result": [
    {
      "referenceNo": "93125218",
      "blType": "BL",
      "portcd": "CNSHK",
      "ieId": "E",
      "customerService": null,
      "extendNo": null,
      "remark": null,
      "id": "1876107834987515904",
      "localKey": null,
      "itemCode": 200,
      "itemCodeDesc": "success",
      "itemMessage": ""
    }
  ]
}

修改于 2025-04-17 08:59:11

港区支持清单

港区数据推送接口