云当网数据接口
  1. 海运跟踪
云当网数据接口
  • 通用接口
    • API Token获取
      • 获取Token
  • 海运数据接口
    • 海运跟踪
      • 海运状态码
      • 海运支持清单
      • 海运跟踪单号订阅
        POST
      • 海运箱动态全量推送(按提单号/订舱号订阅)
        POST
      • 海运跟踪下载(按提单号/订舱号订阅)
        POST
      • 海运跟踪箱号订阅
        POST
      • 海运箱动态全量推送(按箱号订阅)
        POST
      • 海运跟踪下载(按箱号订阅)
        POST
      • 海运箱动态推送(单节点)
        POST
      • 集装箱海上轨迹
        GET
      • 港区数据订阅
        POST
      • 港区数据全量推送
        POST
      • 港区数据订阅下载
        POST
    • 船舶靠泊计划
      • 船舶靠泊计划
    • 船期表
      • 船期表获取
    • 船舶AIS
      • 单船搜索
      • 船舶定位
      • 船舶历史挂港
      • 船舶轨迹
  • 陆运数据接口
    • EIR(电子设备交接单)
      • Eir获取API
    • 场站数据
      • 场站数据查询订阅接口
      • 场站数据推送
    • 车辆GPS
      • 车辆定位
      • 车辆轨迹
  • 关务数据接口
    • 报关状态
      • 报关状态查询
      • 报关状态推送
    • 舱单数据
      • 上传订阅海运舱单
      • 海运舱单订阅数据下载
  • 美国目的港数据接口
    • 美国码头数据
      • 美国码头支持清单
      • 美国码头信息订阅
      • 美国码头数据下载
    • 美国清关状态
      • 清关状态代码
      • 美国清关数据查询接口
  • OCR识别
    • 报关单识别接口
    • 发票/清关识别接口
  • 空运数据接口
    • 空运支持清单
    • 空运状态代码
    • 空运跟踪订阅
    • 空运状态节点全量推送
    • 空运状态单节点推送
    • 空运跟踪下载
  • 快递数据接口
    • 国家、地区ISO Alpha-3代码表
    • 主状态代码表
    • 子状态代码表
    • 承运商代码表
    • 承运商集团表
    • 特殊承运人代码表
    • 快递跟踪订阅
    • 快递跟踪下载
    • 快递跟踪全量推送
  1. 海运跟踪

港区数据订阅下载

POST
http://apis.my56home.com/api/v1/portdatabookingdownload
调用该接口前,需要先使用[获取Token API]获取token。token 有效期是2小时,超过了2小时得重新获取。

请求参数

Query 参数
companyid
string 
可选
示例值:
1000
token
string 
可选
示例值:
1382b465-f972-46da-a5b2-1d286fa84d96
Body 参数multipart/form-data
data
string 
可选
订阅参数,传的是JSON数据。
referenceno:港区提单/订舱号
portcd:云当港口代码(必填)
ctnrno: 箱号
referenceno , ctnrno 不可同时为空
示例值:
{"referenceno":"COAU8036422250","ctnrno":"","portcd":"CNSHA"}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://apis.my56home.com/api/v1/portdatabookingdownload?companyid=1000&token=1382b465-f972-46da-a5b2-1d286fa84d96' \
--form 'data="{\"referenceno\":\"COAU8036422250\",\"ctnrno\":\"\",\"portcd\":\"CNSHA\"}"'

返回响应

🟢200成功
application/json
Body
referenceno
string 
订阅时传的单号(Order number passed during subscription)
可选
localkeyid
string 
订阅是传的keyid参数(Keyid parameter passed during subscription)
可选
status
integer 
状态码(Status code)
可选
0=成功;1=失败;1000=查无数据;1005=未订阅(0=success; 1=failed; 1000=no data found; 1005=unsubscribed)
success
boolean 
是否成功Whether successful)
可选
message
string 
错误信息(error message)
可选
array [object {58}] 
港区单箱信息表(Port Area Single Container Information Form)
可选
多箱会有多个记录(There will be multiple records for multiple boxes)
ctnrno
string 
箱号(Container No.)
可选
>= 11 字符<= 11 字符
referenceno
string 
订阅提单号/订舱号(BL No. or BKG No.)
可选
>= 36 字符<= 36 字符
localkeyid
string 
客户关键字(Customer's Keyid)
可选
>= 256 字符<= 256 字符
blno
string 
提单号(BL NO.)
可选
>= 32 字符<= 32 字符
owner
string 
箱(Box owner)
可选
>= 64 字符<= 64 字符
vslname
string 
船名(Vessel Name)
可选
>= 64 字符<= 64 字符
voy
string 
航次(Voyage)
可选
>= 32 字符<= 32 字符
ieid
string 
进出口标识(Import and export identification)
可选
I=进口,E=出口(I=import, E=export)
>= 2 字符<= 2 字符
csize
string 
尺寸(Size)
可选
>= 2 字符<= 2 字符
ctype
string 
箱型(Box type)
可选
>= 4 字符<= 4 字符
terminalcd
string 
码头代码(Dock code)
可选
>= 18 字符<= 18 字符
terminal
string 
码头名称(Dock name)
可选
>= 64 字符<= 64 字符
portcd
string 
码头所属港口代码(Port code of the dock)
可选
>= 18 字符<= 18 字符
slot
string 
场箱位(Field container space)
可选
>= 64 字符<= 64 字符
sealno
string 
封签号(Seal number)
可选
>= 36 字符<= 36 字符
customstatus
string 
海放标识(Sea release label)
可选
Y=已放行,N或空=未放行(Y=released, N or empty=not released)
>= 1 字符<= 1 字符
customtime
string <date-time>
海放时间(Sea release time)
可选
terminalrlsstatus
string 
码放标识(Code release label)
可选
Y=已放行,N或空=未放行(Y=released, N or empty=not)
>= 1 字符<= 1 字符
terminalrlstime
string <date-time>
码放时(Playback time)
可选
inspectionstatus
string 
国检放行标识(National inspection release label)
可选
Y=已放行,N或空=未放行(Y=released, N or empty=not released)
>= 1 字符<= 1 字符
inspectiontime
string <date-time>
国检放行时间(National inspection release time)
可选
ifci
string 
是否查验(Whether to verify)
可选
Y=是,N=否
>= 1 字符<= 1 字符
citime
string <date-time>
查验时间(Inspection time)
可选
dgid
string 
危品标识(Dangerous goods identification)
可选
Y=危险品(Y=Dangerous goods)
>= 1 字符<= 1 字符
dglevel
string 
危品等级(Hazardous material level)
可选
>= 5 字符<= 5 字符
dgunno
string 
危品国际编号(Dangerous goods international number)
可选
>= 10 字符<= 10 字符
rfid
string 
冻柜标识(Freezer identification)
可选
Y=冻柜(Y=Freezer)
>= 1 字符<= 1 字符
rftmp
string 
冷藏温度(Reefer-Temperature required)
可选
>= 56 字符<= 56 字符
poundwgt
string 
磅重(Pound weight)
可选
>= 11 字符<= 11 字符
vgm
string 
VGM重量(VGM weight)
可选
>= 11 字符<= 11 字符
tarewgt
string 
箱皮重(Box tare weight)
可选
>= 11 字符<= 11 字符
pieces
string 
件数(Number of pieces)
可选
>= 18 字符<= 18 字符
grosswgt
string 
毛重(Number of pieces)
可选
>= 18 字符<= 18 字符
volume
string 
体积(Volume)
可选
>= 18 字符<= 18 字符
pol
string 
起运港(Port of departure)
可选
>= 64 字符<= 64 字符
pod
string 
卸货港(Discharge Port)
可选
>= 64 字符<= 64 字符
intime
string <date-time>
进场时间(Entry time)
可选
outtime
string <date-time>
出场时间(Exit time)
可选
preloadid
string 
配载标识(Load identification)
可选
Y=已配载(Y=loaded)
>= 2 字符<= 2 字符
intype
string 
进场方式(Entry method)
可选
>= 16 字符<= 16 字符
outtype
string 
出场方式(Exit method)
可选
>= 16 字符<= 16 字符
cntrdynamic
string 
当前箱状态(Current box status)
可选
>= 18 字符<= 18 字符
cntrdynamiccd
string 
当前箱状态代码(Current box status code)
可选
>= 10 字符<= 10 字符
truckno
string 
拖车号(Trailer number)
可选
>= 10 字符<= 10 字符
efid
string 
空重标识(Empty weight identification)
可选
E=空箱,F=重箱(E=empty box, F=heavy box)
>= 2 字符<= 2 字符
wharfrlstatus
string 
码头扣留标识
可选
Y=是,N或者没值=否
>= 2 字符<= 2 字符
ydcarriercd
string 
云当识别的船东代码
可选
>= 18 字符
datatime
string <date-time>
数据时间
可选
oh
string 
超高(CM)
可选
olid
string 
超限标识(Y=是;N=否)
可选
olf
string 
前超(CM)
可选
olb
string 
后超(CM)
可选
owl
string 
左超(CM)
可选
owr
string 
右超(CM)
可选
bertheta
string <date-time>
预计靠泊时间
可选
berthetd
string <date-time>
预计离泊时间
可选
berthata
string <date-time>
靠泊时间
可选
berthatd
string <date-time>
离泊时间
可选
示例
{
    "referenceno": "COAU8036422250",
    "localkeyid": "5859f9a7-d0e8-428f-99f3-6e947169a005",
    "data": [
        {
            "ctnrno": "CSLU2225565",
            "blno": "COAU8036422250",
            "owner": "CSE",
            "vslname": "OOCL ATLANTA",
            "voy": "153W",
            "ieid": "E",
            "csize": "20",
            "ctype": "GP",
            "terminalcd": "SHAZDMT",
            "terminal": "上海振东(外二)",
            "portcd": "CNSHA",
            "slot": null,
            "sealno": "CS692521",
            "customstatus": "Y",
            "customtime": null,
            "terminalrlsstatus": "Y",
            "terminalrlstime": null,
            "inspectionstatus": null,
            "inspectiontime": null,
            "ifci": null,
            "citime": null,
            "dgid": null,
            "dglevel": "",
            "dgunno": "",
            "rfid": null,
            "rftmp": " ",
            "poundwgt": "25835",
            "vgm": null,
            "tarewgt": "2185",
            "pieces": "12",
            "grosswgt": "23650",
            "volume": "12",
            "pol": "CNSHA",
            "pod": "PKKHI",
            "dtp": "PKKHI",
            "intime": "2023/3/22 5:06:44",
            "outtime": "2023/3/25 0:07:27",
            "declarationno": null,
            "preloadid": null,
            "preloadtime": null,
            "intype": "出口进场",
            "outype": "出口装船",
            "cntrdynamic": "出口装船",
            "cntrdynamiccd": "",
            "truckno": "沪A97448",
            "efid": "F"
        },
        {
            "ctnrno": "FCIU4962297",
            "blno": "COAU8036422250",
            "owner": "CSE",
            "vslname": "OOCL ATLANTA",
            "voy": "153W",
            "ieid": "E",
            "csize": "20",
            "ctype": "GP",
            "terminalcd": "SHAZDMT",
            "terminal": "上海振东(外二)",
            "portcd": "CNSHA",
            "slot": null,
            "sealno": "CS841211",
            "customstatus": "Y",
            "customtime": null,
            "terminalrlsstatus": "Y",
            "terminalrlstime": null,
            "inspectionstatus": null,
            "inspectiontime": null,
            "ifci": null,
            "citime": null,
            "dgid": null,
            "dglevel": "",
            "dgunno": "",
            "rfid": null,
            "rftmp": " ",
            "poundwgt": "26475",
            "vgm": null,
            "tarewgt": "2180",
            "pieces": "11",
            "grosswgt": "24295",
            "volume": "11",
            "pol": "CNSHA",
            "pod": "PKKHI",
            "dtp": "PKKHI",
            "intime": "2023/3/22 12:04:22",
            "outtime": "2023/3/25 0:00:03",
            "declarationno": null,
            "preloadid": null,
            "preloadtime": null,
            "intype": "出口进场",
            "outype": "出口装船",
            "cntrdynamic": "出口装船",
            "cntrdynamiccd": "",
            "truckno": "沪A97241",
            "efid": "F"
        },
        {
            "ctnrno": "OOLU1641325",
            "blno": "COAU8036422250",
            "owner": "CSE",
            "vslname": "OOCL ATLANTA",
            "voy": "153W",
            "ieid": "E",
            "csize": "20",
            "ctype": "GP",
            "terminalcd": "SHAZDMT",
            "terminal": "上海振东(外二)",
            "portcd": "CNSHA",
            "slot": null,
            "sealno": "CS823953",
            "customstatus": "Y",
            "customtime": null,
            "terminalrlsstatus": "Y",
            "terminalrlstime": null,
            "inspectionstatus": null,
            "inspectiontime": null,
            "ifci": null,
            "citime": null,
            "dgid": null,
            "dglevel": "",
            "dgunno": "",
            "rfid": null,
            "rftmp": " ",
            "poundwgt": "27915",
            "vgm": null,
            "tarewgt": "2250",
            "pieces": "12",
            "grosswgt": "25665",
            "volume": "12",
            "pol": "CNSHA",
            "pod": "PKKHI",
            "dtp": "PKKHI",
            "intime": "2023/3/22 12:04:26",
            "outtime": "2023/3/25 0:00:00",
            "declarationno": null,
            "preloadid": null,
            "preloadtime": null,
            "intype": "出口进场",
            "outype": "出口装船",
            "cntrdynamic": "出口装船",
            "cntrdynamiccd": "",
            "truckno": "沪A97448",
            "efid": "F"
        }
    ],
    "success": true,
    "status": 0,
    "message": null
}
⚪接口请求成功
⚪1接口请求失败
上一页
港区数据全量推送
下一页
船舶靠泊计划
Built with