Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

接口地址

测试URL:http://api.t.baoguan001.com/api/docking/upload

正式URL:http://api.platform.codeflagai.com/api/docking/upload

请求方式post
入参(JSON)


字段

类型

描述

必填

备注

appId

String

权限令牌

Y

身份标记(分为测试环境与线上环境)

bghId

String

报关行ID

Y

通过接口获取(6 通过货代appId获取报关行列表

fileUrl

String

网络下载地址

Y

http://allseeing-rar.oss-cn-shanghai.aliyuncs.com/A1908010846

5575164/1564620414.zip

海运报关业务支持:zip,rar格式;

orderOutNo

String

外部订单号

Y

业务编号

isReload

String

重传标记

Y

“2” 表示重传,其他暂无意义(暂不支持重传)

parameter

JSON

其他参数

Y


字段

类型

描述

必填

备注

sourceAppIdString来源appIdN第三方
phoneString手机号N信号旗货代平台如果存在该手机号,为默认为上传人
customerNameString客户上传人N默认为空,标记第三方上传人
hdEmailString货代邮箱N如果存在,则显示,不存在,则通过手机查询平台结果(20200805新增)

hdqq

String货代QQN如果存在,则显示,不存在,则通过手机查询平台结果(20200805新增)

declarationPort

String

申报口岸

N

海关编码

IEPort

String

出境关别

N

洋山:“2248”

外港:“2225”

entyPort

String

离境口岸

N

海关编码

trafName

String

船名

N


voyageNo

String

航次

N


billNo

String

提运单号

N


packNo

String

件数

N


grossWet

String

毛重

N


tradeArea

String

贸易国

N

海关编码

originalCountry

String

运抵国

N

海关编码

distinatePort

String

指运港

N

海关编码

trafModeName

String

运输方式

N

2:水路运输;3:铁路运输;4:公路运输;5:航空运输;默认为2

declareNo

String

报关ID

N

业务编号预留字段

customerNo

String

客户自编号

N


volume

String

体积

N


receiptUserName

String

客户名称

N

页面显示

noticeBgh

boolean

等通知报关

N

true=是 (等通知报关) false=否 (直接可报关) 接口上传默认false


paperType

boolean

有纸报关/通关无纸化

N

true=是 false=否  接口上传默认false

linkage

String

多式联运

N

twoPortLinkage=两港联动

dushanPort=独山港

Other=其他内支河

hdUserName

String

货代联系人

N

页面显示

containerNo

String

集箱号

N


hdRemark

String

货代备注

N



source

String

来源

N

用于页面显示

manuscriptCheck

boolean

校验单标识

N

true=是 false=否  是否需要进行预录单校验

needSecondCheck

boolean

二审标识

N

true=是 false=否  接口上传默认false

priorityGrade

boolean

优先审核标识

N

true=是 false=否  接口上传默认false

importantCheck

boolean

重点审核标识

N

true=是 false=否  接口上传默认false

orderCommissionCheck

boolean

电子委托标记

N

true=是 false=否  报关委托书为电子委托或非电子委托

declareTime

String

要求报关日期

Y

yyyy-MM-dd HH:mm:ss

mergeType


String


拼箱标识


N

1=出口拼箱

2=出口整箱

3=进口拼箱

4=进口整箱

5=进口分拨

6=出口自拼箱

7=进口报关

8=出口报关

superviseMode

String

监管仓上传方式

N

JGC/9710/9810/HNCZC


Bool

是否退税

N



String

客户报关类型

N



String

入库单号

N



String

进仓单号

N




进仓件数

N


decContainersJsonArray


List


集装箱箱号


N

格式:

字段名称类型描述格式说明

containerMd

json

规格

code,value

value必须为以下值:20GP,40GP ,40HQ,45GP,45HQ;

code对应value:20GP为21,40GP为11,40HQ为11,45GP为11,45HQ为11;

code 21 对应 value 20GP
11对应40GP
11对应40HQ
11对应45GP
11对应45HQ


goodsNo

json

商品项号关系

code,value

value必须为“1,2,3”格式,数字对应报关单商品项号,用英文逗号隔开;

code传空字符串

containerId

json

集装箱号

code,value

value为集装箱号;

code传空字符串

lclFlag

json

拼箱标志

code,value

value必须为以下值:是,否;(是表示拼箱,否表示整箱)

code对应value:是为1,否为0

containerWt

json

自重

code,value

value为集装箱自重;

code传空字符串


示例:

[{

"containerMd":{"code":"","value":""},

"goodsNo":{"code":"","value":""},

"containerId":{"code":"","value":""},

"lclFlag":{"code":"","value":""},

"containerWt":{"code":"","value":""}

}]



出参(Object)


字段

类型

描述

备注

code

int

200=成功


msg

String

接口返回信息


data

json

返回数据:

orderOutNo(外部流水号

信号旗内部流水号


描述

上传成功以后,返回orderOutNo

...

接口地址

测试URL:http://api.t.baoguan001.com/api/docking/uploadImport

正式URL:http://api.platform.codeflagai.com/api/docking/uploadImport

请求方式post
入参(JSON)


字段

类型

描述

必填

备注

appId

String

权限令牌

Y

身份标记(分为测试环境与线上环境)

bghId

String

报关行ID

Y

报关行ID

fileUrl

String

网络下载地址

Y

http://allseeing-rar.oss-cn-shanghai.aliyuncs.com/A1908010846

5575164/1564620414.zip

海运报关业务支持:zip,rar格式;

orderOutNo

String

外部订单号

Y

业务编号

settlementNo

String

结算编号

N

结算编号

isReload

String

重传标记

Y

“2” 表示重传,其他暂无意义(暂不支持重传)

customerNo

String

客户自编号

N

客户自编号

receivingRemark

String

接单备注

N

接单备注

isNotice

Bool

是否等通知报关

N

是否等通知报关

trafName

String

船名

N

船名

voyageNo

String

航次

N

航次

billNo

String

提运单号

N

提运单号

trafModeName

String

运输方式

N

2:水路运输;3:铁路运输;4:公路运输;5:航空运输;默认为2

N

海运  / 空运  /  公路 / 铁路

receiptUserName

String

客户名称

Y

客户名称

receivingRemark

String

接单备注

N

接单备注

packNo

String

件数

N

件数

grossWet

String

毛重

N

毛重

tradeName

String

境内收发货人

N

境内收发货人

tradeNameCode

String

境内10位编码

N

境内10位编码

tradeNameDutyNo

String

境内18位编码

N

境内18位编码

expectedOrderExchangeTime

String

预计换单时间

N

预计换单时间

practicalOrderExchangeTime

String

实际换单时间

N

实际换单时间

parameter

JSON

其他参数

N


字段

类型

描述

必填

备注


















出参(Object)


字段

类型

描述

备注

code

int

200=成功


msg

String

接口返回信息


data

jsonString

返回数据:

信号旗内部流水号


描述




2.单一放行数据接口 

...

接口地址

调试url:http://api.t.baoguan001.com/api/docking/lcl_task

正式url:http://api.platform.codeflagai.com/api/docking/lcl_task

请求方式post入参(DataForm)
入参(json


字段

类型

描述

必填

备注

appId

String

权限令牌

Y

身份标记

fileUrl
String随附文档N图片地址 (图片地址和订单列表必填一个,不能两者都为空)
taskId
String拼箱任务IDN新增成功后返回的ID,修改时必填
bghId
String报关行IDY
outNo
String拼箱号N
billNo
String提单号Y
shipName
String船名Y
voyage
String航次Y
iEPort
String出境关别N

外港海关,洋山港区,吴淞

iEPortCode
String
出境关别代码
N

2225-外港海关

2248-洋山港区

2202-吴淞

declarationPort
String
申报地海关
N航交办,洋山市内
declarationPortCode
String
申报地海关代码
N

2229-航交办

2231-洋山市内

entyPort
String
离境口岸
N外高桥,洋山港
entyPortCode
String
离境口岸代码
N

310701-外高桥

311002-洋山港

distinatePort
String指运港N
distinatePortCode
String指运港代码N
containerId
String集装箱号N
containerMd
String集装箱规格N

20GP,40GP ,40HQ,45GP,45HQ

containerWt
String集装箱自重N
containerMdCode
String集装箱规格代码N


lclFlagCodeString拼箱标识代码N是为1,否为0;(是表示拼箱,否表示整箱)
packNo
String
件数
N
grossWet
String
毛重
N
businessTypeString业务类型Nsea =海运出口 ;  air=空运出口;不传默认海运出口
orders
List 订单列表N


字段类型描述必填
StringorderOutNo业务编号Y
String
newBillNo
新提单号N
String
hdPackNo
件数N
String
hdGrossWet
毛重N



出参


字段

类型

描述

备注

code

int

200=成功


msg

String

接口返回信息


data

JSON




描述

示例


入参出参
{
"appId":"<身份标记>",
"fileUrl":"",
"bghId":"<报关行>",
"outNo":"",
"billNo":"<提单号>",
"shipName":"<船名>",
"voyage":"<航次>",
"iEPort":"",
"iEPortCode":"",
"declarationPort":"",
"declarationPortCode":"",
"entyPort":"",
"entyPortCode":"",
"distinatePort":"",
"distinatePortCode":"",
"containerId":"",
"containerMd":"",
"containerWt":"",
"containerMdCode":"",
"packNo":"",
"grossWet":"",
"orders":[{"orderOutNo":"<业务编号>","newBillNo":"<新提单号>"}]
}

code =200 成功

非200 表示失败


...

接口地址

调试url:http://api.t.baoguan001.com/api/docking/bghList

正式url:http://api.platform.codeflagai.com/api/docking/bghList

请求方式post入参(DataForm)
入参(json


字段

类型

描述

必填

备注

appId

String

权限令牌

Y

身份标记


出参


字段

类型

描述

备注

code

int

200=成功


msg

String

接口返回信息


data

List<Object>


字段
类型
描述
bghID报关行id
bghName报关行名称




描述

报关行列表,需要在相应的开放平台系统中绑定。详细咨询客服

示例

...

接口地址

调试url:http://api.t.baoguan001.com/api/docking/recall

正式url:http://api.platform.codeflagai.com/api/docking/recall

请求方式post入参(DataForm)
入参(json


字段

类型

描述

必填

备注

appId

String

货代身份标记

Y

身份标记

orderOutNoString业务编号Y
phoneString手机号N
hdUserNameString操作人名称Y


出参


字段

类型

描述

备注

code

int

200=成功


msg

String

接口返回信息


data






描述

撤回

示例

...

接口地址

调试url:http://api.t.baoguan001.com/api/docking/unFrozen

正式url:http://api.platform.codeflagai.com/api/docking/unFrozen

请求方式post入参(DataForm)
入参(json


字段

类型

描述

必填

备注

appId

String

货代身份标记

Y

身份标记

orderOutNosList<String>业务编号Y
phoneString手机号Y
hdUserNameString操作人名称N
noticeFlag
Boolean解冻标记Ytrue(解冻),false为冻结
remarkString备注N冻结、解冻备注或原因


出参


字段

类型

描述

备注

code

int

200=成功


msg

String

接口返回信息


data

List<Object>

 失败集合


字段

类型

描述

必填

String

orderOutNo

业务编号Y
String

errMsg

错误信息Y



描述

如果有不能解冻的订单会返回错误信息,能解冻订单会解冻但不会提示。

示例

...

接口地址

在信号旗中配置回调接口,接口地址回调方提供(注意:该地址只能提供一个,具体业务根据action字段区分)。

请求方式post
入参(json)


字段

类型

必填

描述

action

String

Y

single_receipt(海关回执) , single_receipt_I(进口海关回执)

orderNo

String

Y

信号旗系统流水号

orderOutNo

String

N

业务流水号

billNo

String

N

提运单号

paramJson

json

Y

回执json

字段

类型

必填

描述

channel

String


参见《附件3:海关状态

note

String


海关描述

noticeDate

String


海关时间

customMaster

String


主管海关

entryId

String


海关编码

cusCiqNo
String
统一编号

releaseNotice

String

N

放行通知书文件地址(出口)

customsDeclaration

String

N

报关单文件地址(出口)

authorizationLetter

String

N

报关委托书地址(进出口)

examinePdf
StringN查验通知书(口岸查验通知、报关单查验通知......)(进出口)
allowLifting
StringN准予提离通知书地址(进口)



出参


字段

类型

必填

描述

state

boolean

Y

成功:true

失败:false

msg

String

N



描述


...