韩国韵达 API 基于 restful 标准设计。
调用API的服务URL地址,开放平台目前提供了2个环境给介入者使用:测试环境,正式环境。
测试环境
http://tapi.suyoda.cn/v1
正式环境
http://api.suyoda.cn/v1
调用任何一个API都必须传入的参数,目前支持的公共参数有:
参数名称 | 参数类型 | 是否必须 | 描叙 |
---|---|---|---|
method | String | 是 | API接口名称。 |
app_key | String | 是 | 系统分配、请联系管理员获取 |
session | String | 是 | 系统分配、请联系管理员获取 |
timestamp | String | 是 | 时间戳,格式为yyyy-MM-dd HH:mm:ss,时区为GMT+8,例如:2016-01-01 12:00:00。韩国韵达API服务端允许客户端请求最大时间误差为5分钟。 |
format | String | 是 | 响应格式。默认为json格式,目前仅支持json格式。 |
v | String | 是 | API协议版本,可选值:1.0。 |
sign | String | 是 | API输入参数签名结果,签名算法 参照下面的介绍。 |
sign_method | String | 是 | 签名的摘要算法,可选值为:hmac,md5。 |
API调用除了必须包含公共参数外,如果API本身有业务级的参数也必须传入,每个API的业务级参数请考 API文档 说明。
为了防止API调用过程中被黑客恶意篡改,调用任何一个API都需要携带签名,服务端会根据请求参数,对签名进行验证,签名不合法的请求将会被拒绝。目前支持的签名算法有两种:MD5(sign_method=md5),HMAC_MD5(sign_method=hmac),签名大体过程如下:
对所有API请求参数(包括公共参数和业务参数,但除去sign参数和byte[]类型的参数),根据参数名称的 ASCII码表 的顺序 升序排序。如:foo:1, bar:2, foo_bar:3, foobar:4排序后的顺序是bar:2, foo:1, foo_bar:3, foobar:4
将排序好的参数名和参数值拼装在一起,根据上面的示例得到的结果为:bar2foo1foo_bar3foobar4。
把拼装好的字符串采用utf-8编码,使用签名算法对编码后的字节流进行摘要。如果使用MD5算法,则需要在拼装的字符串前后加上app的session后,再进行摘要,如:md5(session+bar2foo1foo_bar3foobar4+session),将得到的结果转32位大写;如果使用HMAC_MD5算法,则需要用app的session作为,如:PHP加密如下
MD5
md5(session+bar2foo1foo_bar3foobar4+session)
HMAC
HASH_HMAC('md5',bar2foo1foo_bar3foobar4,session,false)
所有的请求和响应数据编码皆为utf-8格式,URL里的所有参数名和参数值请做URL编码。如果请求的Content-Type是application/x-www-form-urlencoded,则HTTP Body体里的所有参数值也做URL编码;如果是multipart/form-data格式,每个表单字段的参数值无需编码,但每个表单字段的charset部分需要指定为utf-8
接口名称:hjd.entry.add
请求地址:http://api.suyoda.net/v1/entry
请求类型:post
参数名称 | 参数类型 | 是否必须 | 描叙 |
---|---|---|---|
entry_arr | json | 是 | 提交的需要备案的商品信息 |
{ "error": 0, "message": "success", "data": true }
商品信息 都需遵循参数名称的 ASCII码表 的顺序规则、转成json字符串后、需要进行url
参数名称 | 参数类型 | 是否必须 | 描叙 |
---|---|---|---|
code | String | 是 | 商品SKU,必须由英文、数字、下划线、中划线组成 |
name | String | 是 | 商品名称 |
name_en | String | 是 | 商品名称对应的英文品名,报关需要,请如实填写 |
spec | String | 是 | 商品规格 |
weight | float | 是 | 净重(Kg) |
price | 单价 | 是 | 商品的单价 |
place_of_origin | String | 是 | 原产国,比如:韩国 |
send_code | String | 是 | 原产国代码:参照附属码表 例如(韩国):133 |
tax_code | String | 否 | 行邮税号 |
brand | String | 否 | 中文品牌 |
brand_en | String | 否 | 英文品牌 |
unit | String | 否 | 行邮申报单位 |
spec | String | 否 | 规格:如果是面膜或者奶粉类请标注内置数量,比如 20片/盒 |
name_short | String | 否 | 代表名称或者短品名 |
goods_unit | String | 否 | 商品单位 |
所有的请求和响应数据编码皆为utf-8格式,URL里的所有参数名和参数值请做URL编码。如果请求的Content-Type是application/x-www-form-urlencoded,则HTTP Body体里的所有参数值也做URL编码;如果是multipart/form-data格式,每个表单字段的参数值无需编码,但每个表单字段的charset部分需要指定为utf-8
接口名称:hjd.batch.add
请求地址:http://api.suyoda.net/v1/batch
请求类型:post
参数名称 | 参数类型 | 是否必须 | 描叙 |
---|---|---|---|
batch_name | String | 是 | 提交方订单号。再你方系统中具有唯一性。 |
sender | json | 是 | 寄件方\发件人信息 .创建订单的时、就无须填写 发件人信息。 |
{ "error":0, "message":"success", "data":{ "batch_no":"2018019", "start_time":"2018-04-15 20:55:38", "end_time":"2018-04-16 20:55:38", "batch_name":"20170131第一批订单" } }
所有的请求和响应数据编码皆为utf-8格式,URL里的所有参数名和参数值请做URL编码。如果请求的Content-Type是application/x-www-form-urlencoded,则HTTP Body体里的所有参数值也做URL编码;如果是multipart/form-data格式,每个表单字段的参数值无需编码,但每个表单字段的charset部分需要指定为utf-8
接口名称:hjd.order.add
请求地址:http://api.suyoda.cn/v1/order
请求类型:post
参数名称 | 参数类型 | 是否必须 | 描叙 |
---|---|---|---|
order_no | String | 是 | 提交方订单号。再你方系统中具有唯一性。 |
applicant | String | 否 | 如果不填写 我们默认会跟收件人保持一致 |
batch_no | String | 是 | 订单批次号。通过 创建批次接口 获取 可以重复使用。建议单个批次不超过500单数据 |
sender | json | 是 | 寄件方\发件人信息 |
receiver | json | 是 | 收件人信息 请查看收件人信息表 |
goods | json | 是 | 订单的商品信息 |
weight | number | 是 | 物品总重量kg 单位:Kg |
count | number | 是 | 件数/包裹数 |
length | Float | 否 | 客户订单货物总长,单位厘米,精确到小数点后 2 位 包含子母 |
width | Float | 否 | 客户订单货物总宽,单位厘米,精确到小数点后 2 位,包含子母 |
heigh | Float | 否 | 客户订单货物总高,单位厘米,精确到小数点后 2 位,包含子母 |
total_amount | Float | 是 | 订单总金额 |
currency | String | 否 | 货币单位 货币码表 跨境业务需要填写、若为空 默认为:CNY |
buyer_nick | String | 是 | 买家姓名 : 同收件人真实姓名。 |
sender_country | String | 是 | 发出国或地区。 国家或地区码表 |
receiver_country | String | 是 | 目的国或地区。 国家或地区码表 |
chanel_id | String | 是 | 渠道编码。 渠道编码表 |
{ "error":0, "message":"success", "data":{ "tid":"153499160965137178", "order_no":"201808231006", "tpdata":{ "hawbno":"153459644900110001", "mail_no":"7700075578957", "code":"E99", "msg":"下单成功" }, "waybill_no":"7700075578957" } }
所有的请求和响应数据编码皆为utf-8格式,URL里的所有参数名和参数值请做URL编码。如果请求的Content-Type是application/x-www-form-urlencoded,则HTTP Body体里的所有参数值也做URL编码;如果是multipart/form-data格式,每个表单字段的参数值无需编码,但每个表单字段的charset部分需要指定为utf-8
接口名称:hjd.export.add
请求地址:http://api.suyoda.cn/v1/export
请求类型:post
参数名称 | 参数类型 | 是否必须 | 描叙 |
---|---|---|---|
order_no | String | 是 | 提交方订单号。再你方系统中具有唯一性。 |
applicant | String | 否 | 如果不填写 我们默认会跟收件人保持一致 |
batch_no | String | 是 | 订单批次号。通过 创建批次接口 获取 可以重复使用。建议单个批次不超过500单数据 |
sender | json | 是 | 寄件方\发件人信息 |
receiver | json | 是 | 收件人信息 请查看收件人信息表 |
goods | json | 是 | 订单的商品信息 |
weight | number | 是 | 物品总重量kg 单位:Kg |
count | number | 是 | 件数/包裹数 |
length | Float | 否 | 客户订单货物总长,单位厘米,精确到小数点后 2 位 包含子母 |
width | Float | 否 | 客户订单货物总宽,单位厘米,精确到小数点后 2 位,包含子母 |
heigh | Float | 否 | 客户订单货物总高,单位厘米,精确到小数点后 2 位,包含子母 |
total_amount | Float | 是 | 订单总金额 |
currency | String | 否 | 货币单位 货币码表 跨境业务需要填写、若为空 默认为:CNY |
buyer_nick | String | 是 | 买家姓名 : 同收件人真实姓名。 |
sender_country | String | 是 | 发出国或地区。 国家或地区码表 |
receiver_country | String | 是 | 目的国或地区。 国家或地区码表 |
is_landing | String | 否 | 是否是落地配,如果是落地配则通关编码不需要填写 |
postid | String | 是 | 渠道编码。 渠道编码表【固定传值具体咨询对接人】 |
enable_sender | String | 是 | 是否启用发件地址(1启用发件地址 0使用我们系统默认发件地址) |
{ "error": 0, "message": "success", "data": { "order_no": "2020032050591679622874", "tid": "167962287506058320", "tpdata": "", "waybill_no": "567486119782", "zipCode": { "id": 84852, "zipcd": "46947", "regicnpono": "부1", "regictrlcnponm": "부산집", "dscrnno": "603", "delivregiponm": "부산사상", "regiteamcode": "04", "regidareacd": "18" }, "ems_no": "567486119782", "pdf_info": "{\"CLSFCD\":\"9N18\",\"SUBCLSFCD\":\"1l\",\"CLSFADDR\":\"덕포2 393-10 낙동빌라\",\"CLLDLVBRANNM\":\"사상덕포\",\"CLLDLVEMPNM\":\"##\",\"CLLDLVEMPNICKNM\":\"L10\",\"RSPSDIV\":\"01\",\"P2PCD\":null,\"AqCode\":\"\"}" } }
发件人信息、收件人信息、商品信息组合 都需遵循参数名称的 ASCII码表 的顺序规则、转成json字符串后、需要进行url
参数名称 | 参数类型 | 是否必须 | 描叙 |
---|---|---|---|
name | String | 是 | 发件人的姓名 |
zip | String | 否 | 发件人的地区邮编 |
mobile | String | 是 | 发件人的手机号码 如:+82 138-000-000 如果是中国大陆请加上+86 与联系电话 满足任何一项 即可 |
tel | String | 是 | 发件人的电话号码 +82 02-966-8899 与联系手机 满足任何一项 即可 |
country | String | 是 | 发件人的国家或地区 注意:这里不是编码简称 |
state | String | 是 | 发件人的所在省份 |
city | String | 是 | 发件人所在的城市 |
district | String | 否 | 发件人所在的城市区域 |
town | String | 否 | 发件人所在的街道、或者镇:三墎镇 |
address | String | 是 | 发件人的详细地址:若 街道与地址不能完整区分、请与详细地址拼在一起。 |
personal_code | String | 出口非落地配必填 | 收件人通关编码 |
参数名称 | 参数类型 | 是否必须 | 描叙 |
---|---|---|---|
name | String | 是 | 收货人的姓名 |
idcard_type | number | 否 | 收货人的证件类型、代码请参考 证件类型 |
idcard | String | 否 | 收货人的证件号码 |
zip | String | 否 | 收货人地区的邮编 |
mobile | String | 是 | 收货人的手机号码 如:+82 138-000-000 如果是中国大陆请加上+86 与联系电话 满足任何一项 即可 |
tel | String | 是 | 收货人的电话号码 +82 02-966-8899 与联系手机 满足任何一项 即可 |
country | String | 是 | 收货人的国家或地区 注意:这里不是编码简称 |
state | String | 是 | 收货人的所在省份 |
city | String | 是 | 收件人所在的城市 |
district | String | 否 | 收件人所在的城市区域 |
town | String | 否 | 收件人所在的街道、或者镇:三墎镇 |
address | String | 是 | 收货人的详细地址:若 街道与地址不能完整区分、请与详细地址拼在一起。 |
参数名称 | 参数类型 | 是否必须 | 描叙 |
---|---|---|---|
code | String | 是 | 商品编码 客户自己的商品编码如果有多规格、请填写SKU编码,具有唯一性 比如: E351840 |
name | String | 是 | 商品名称 比如: 莫维尔衬衫 |
price | Double | 是 | 商品价格:这里填写单价 |
count | Int | 是 | 商品数量 |
unit | String | 否 | 商品单位:双、件、条、台、本等。申报单位 |
spec | String | 否 | 商品的规格 、比如:莫维尔衬衫 M 黑色 |
hscode | String | 否 | 海关申报编码(税号) |
currency | String | 否 | 货币单位 货币码表 跨境业务需要填写、若为空 默认为:CNY |
所有的请求和响应数据编码皆为utf-8格式,URL里的所有参数名和参数值请做URL编码。如果请求的Content-Type是application/x-www-form-urlencoded,则HTTP Body体里的所有参数值也做URL编码;如果是multipart/form-data格式,每个表单字段的参数值无需编码,但每个表单字段的charset部分需要指定为utf-8
接口名称:hjd.find.add
请求地址:http://api.suyoda.net/v1/find
请求类型:post
参数名称 | 参数类型 | 是否必须 | 描述 |
---|---|---|---|
order_no | String | 是 | 唯一单号 |
{ "error":0, "message":"success", "data":{ "tp_waybill_no":"7700075578957", "order_no":"201808231006", "created":"2019-03-05 15:01:02", "batch_no":"126252", "weight":"800", } }
所有的请求和响应数据编码皆为utf-8格式,URL里的所有参数名和参数值请做URL编码。如果请求的Content-Type是application/x-www-form-urlencoded,则HTTP Body体里的所有参数值也做URL编码;如果是multipart/form-data格式,每个表单字段的参数值无需编码,但每个表单字段的charset部分需要指定为utf-8
接口名称:hjd.check.add
请求地址:http://api.suyoda.cn/v1/check
请求类型:post
参数名称 | 参数类型 | 是否必须 | 描述 |
---|---|---|---|
name | String | 是 | 姓名 |
card | String | 是 | 证件号码 |
mobile | String | 是 | 电话 |
{"error":0,"message":"success"}
{"error":1008,"message":"","data":"通关编码校验失败"}
所有的请求和响应数据编码皆为utf-8格式,URL里的所有参数名和参数值请做URL编码。如果请求的Content-Type是application/x-www-form-urlencoded,则HTTP Body体里的所有参数值也做URL编码;如果是multipart/form-data格式,每个表单字段的参数值无需编码,但每个表单字段的charset部分需要指定为utf-8
接口名称:hjd.cancel.add
请求地址:http://api.suyoda.cn/v1/cancel
请求类型:post
参数名称 | 参数类型 | 是否必须 | 描述 |
---|---|---|---|
order_no | String | 是 | 唯一单号 |
所有的请求和响应数据编码皆为utf-8格式,URL里的所有参数名和参数值请做URL编码。如果请求的Content-Type是application/x-www-form-urlencoded,则HTTP Body体里的所有参数值也做URL编码;如果是multipart/form-data格式,每个表单字段的参数值无需编码,但每个表单字段的charset部分需要指定为utf-8
接口名称:hjd.optype.get
请求地址:http://api.suyoda.net/v1/optype
请求类型:post
参数名称 | 参数类型 | 是否必须 | 描述 |
---|---|---|---|
gun | String | 是 | 把枪参数表示,默认传数字1。 |
trans | String | 是 | 选择线路,目前默认为kr |
{ "error":0, "message":"success", "data":[ {"id":1,"name":业务名称} {"id":2,"name":业务名称}... ] }
所有的请求和响应数据编码皆为utf-8格式,URL里的所有参数名和参数值请做URL编码。如果请求的Content-Type是application/x-www-form-urlencoded,则HTTP Body体里的所有参数值也做URL编码;如果是multipart/form-data格式,每个表单字段的参数值无需编码,但每个表单字段的charset部分需要指定为utf-8
接口名称:hjd.oporder.edit
请求地址:http://api.suyoda.net/v1/oporder
请求类型:post
参数名称 | 参数类型 | 是否必须 | 描述 |
---|---|---|---|
gun | String | 是 | 把枪参数表示,默认传数字1。 |
is_paste | Number | 是 | 客户贴单值0,我们贴单值为1。 |
waybill_no | String | 是 | 运单号 |
weight | Number | 是 | 包裹重量,单位KG |
uid | Number | 是 | 客户id |
business_type | String | 是 | 业务类型,即之前(业务类型)接口获取到的数据 |
{ "error":0, "message":"success", "data":[] }
所有的请求和响应数据编码皆为utf-8格式,URL里的所有参数名和参数值请做URL编码。如果请求的Content-Type是application/x-www-form-urlencoded,则HTTP Body体里的所有参数值也做URL编码;如果是multipart/form-data格式,每个表单字段的参数值无需编码,但每个表单字段的charset部分需要指定为utf-8
接口名称:hjd.opbatch.add
请求地址:http://api.suyoda.net/v1/opbatch
请求类型:post
参数名称 | 参数类型 | 是否必须 | 描述 |
---|---|---|---|
gun | String | 是 | 把枪参数表示,默认传数字1。 |
trans_name | String | 是 | 运输方式。 |
shoe_num | Number | 是 | 鞋包数量 |
card_num | Number | 是 | 身份证个数 |
settlement_method | String | 是 | 结算类型,次结或者月结 |
settlement_type | String | 是 | 付款方式(支付宝,微信,银行卡...) |
data | Json | 是 | 运单号组成的json字符串:{"1": "7700022000","2": "7724453245354","3":"7700151554"} |
{ "error":0, "message":"success", "data":[] }
所有的请求和响应数据编码皆为utf-8格式,URL里的所有参数名和参数值请做URL编码。如果请求的Content-Type是application/x-www-form-urlencoded,则HTTP Body体里的所有参数值也做URL编码;如果是multipart/form-data格式,每个表单字段的参数值无需编码,但每个表单字段的charset部分需要指定为utf-8
接口名称:hjd.order.weight
请求地址:http://api.suyoda.net/v1/weight
请求类型:post
参数名称 | 参数类型 | 是否必须 | 描述 |
---|---|---|---|
waybill_no | String | 是 | 运单号,必传字段 |
weight | float | 是 | 重量,单位(kg)保留两位小数 |
width | float | 是 | 包裹宽度 单位mm |
length | float | 是 | 包裹长度 单位mm |
height | float | 是 | 包裹高度 单位mm |
{ "error":0, "message":"success", "data":[] }
所有的请求和响应数据编码皆为utf-8格式,URL里的所有参数名和参数值请做URL编码。如果请求的Content-Type是application/x-www-form-urlencoded,则HTTP Body体里的所有参数值也做URL编码;如果是multipart/form-data格式,每个表单字段的参数值无需编码,但每个表单字段的charset部分需要指定为utf-8
接口名称:hjd.WaybillQuery.add
请求地址:http://api.suyoda.net/v1/WaybillQuery
请求类型:post
参数名称 | 参数类型 | 是否必须 | 描述 |
---|---|---|---|
waybill_no | String | 是 | 运单号,必传字段 |
{
"error": 0,
"message": "success",
"data": {
"mailno": "7700091975501",
"result": "true",
"time": "2018-11-24 11:16:49",
"remark": "韵达快运 SERVER-R,查询接口中仅保留最近30天内的数据,如需要查询更早的记录,请访问韵达官方网站:www.yundaex.com ,谢谢!",
"status": "signed",
"weight": "0",
"steps": [
{
"time": "2018-11-14 11:50:03",
"address": "韩国国际部仁川转运仓分部",
"station": "80000080",
"station_phone": "",
"status": "got",
"remark": "进行揽件扫描",
"next": "",
"next_name": ""
},
{
"time": "2018-11-14 15:24:00",
"address": "",
"station": "",
"station_phone": "",
"status": "gss_status",
"remark": "【韩国-仁川】包裹已到达 [仁川仓配中心]",
"next": "",
"next_name": ""
}
]
}
}
所有的请求和响应数据编码皆为utf-8格式,URL里的所有参数名和参数值请做URL编码。如果请求的Content-Type是application/x-www-form-urlencoded,则HTTP Body体里的所有参数值也做URL编码;如果是multipart/form-data格式,每个表单字段的参数值无需编码,但每个表单字段的charset部分需要指定为utf-8
接口名称:hjd.TaxFee.req
请求地址:http://api.suyoda.net/v1/TaxFee
请求类型:post
参数名称 | 参数类型 | 是否必须 | 描述 |
---|---|---|---|
goods_list | json | 是 | 商品集合,必传字段 |
{"error":0,"message":"success","data":{"fee":125}}
参数名称 | 参数类型 | 是否必须 | 描叙 |
---|---|---|---|
code | String | 是 | 商品编码 客户自己的商品编码如果有多规格、请填写SKU编码,具有唯一性 比如: E351840 |
price | Double | 是 | 商品价格:这里填写单价 |
count | Int | 是 | 商品数量 |
所有的请求和响应数据编码皆为utf-8格式,URL里的所有参数名和参数值请做URL编码。如果请求的Content-Type是application/x-www-form-urlencoded,则HTTP Body体里的所有参数值也做URL编码;如果是multipart/form-data格式,每个表单字段的参数值无需编码,但每个表单字段的charset部分需要指定为utf-8
请求地址:http://api.suyoda.net/v1/dot
接口名称:hjd.dot.req
请求类型:post
cla类:Auth
fun方法:loginNew
gun:1
参数名称 | 参数类型 | 是否必须 | 描述 |
---|---|---|---|
user_name | string | 是 | 账号 |
user_password | string | 是 | 密码 |
{
"error": 0,
"message": "success",
"data": {
"scanner_id": 447,
"scanner_role": "313",
"dot_id": 42,
"country_code": 142,
"dot_code": "264545",
"syd_code": "80000035",
"is_start_big": 0,
"big_package_weight": 0,
"other_dot_code": "",
"dot_name": "山东威海公司跨境电商分部",
"next_dot_name": "",
"next_dot_id": "",
"op_id": 4531,
"app_key": 204531,
"app_secret": "c795fbdeaab0c482d40e0acd22edd545d2d",
"msg": "登录成功"
}
}
{
"error": 1,
"message": "签名错误",
"data": {
"code": 2000,
"msg": "Invalid1 authentication credentials",
"sub_code": 10003
}
}
参数名称 | 参数类型 | 是否必须 | 描叙 |
---|---|---|---|
error | int | 是 | 1:错误信息/0:登陆成功 |
message | string | 是 | success:登录成功/签名错误,账号密码错误,等等 |
data | array | 是 | 登陆成功返回数据信息/登录失败返回错误信息 |
data--scanner_id | array | 是 | 扫描员ID |
data--dot_id | array | 是 | 网点ID |
data--dot_code | array | 是 | 网点代码 |
所有的请求和响应数据编码皆为utf-8格式,URL里的所有参数名和参数值请做URL编码。如果请求的Content-Type是application/x-www-form-urlencoded,则HTTP Body体里的所有参数值也做URL编码;如果是multipart/form-data格式,每个表单字段的参数值无需编码,但每个表单字段的charset部分需要指定为utf-8
请求地址:http://api.suyoda.net/v1/dot
接口名称:hjd.dot.req
请求类型:post
cla类:DwsInfo
fun方法:pushDwsInfo
gun:1
参数名称 | 参数类型 | 是否必须 | 描述 |
---|---|---|---|
listCode | array | 是 | 运单号数组 [SF123456,YT123456] |
boxCode | String | 是 | 箱码(没有为空) |
weight | Float | 是 | 重量单位 kg |
length | Float | 是 | 长度单位 mm |
width | Float | 是 | 宽度单位 mm |
height | Float | 是 | 高度单位 mm |
regtangle | Integer | 是 | 包裹规整度(标准方体为 100) |
orgCode | String | 是 | 机构编码 |
warehouseId | String | 是 | 仓库编码 |
scanType | Integer | 是 | 扫描类型(0-进港 1-出港) |
deviceId | String | 是 | 设备编号 例如:sh006 |
sendTime | String | 是 | 请求时间 |
dotId | Integer | 是 | 网点ID(登录接口获取) |
dotCode | String | 是 | 网点代码(登录接口获取) |
scannerId | Integer | 是 | 扫描员ID(登录接口获取) |
{
"status": 1,
"message": "上传成功",
"billCode": "SF1885613473107",
"CarrierCode": "1",
"CarrierName": "韵达速递"
}
{
"status": 0,
"message": "未匹配到格口配置项",
"billCode": "",
"CarrierCode": "error",
"CarrierName": ""
}
参数名称 | 参数类型 | 是否必须 | 描叙 |
---|---|---|---|
status | int | 是 | 1:成功 / 0:失败 |
message | string | 是 | 操作详情 |
billCode | string | 是 | 运单号 |
CarrierCode | string/int | 是 | 格口号:1234、异常口:error |
CarrierName | string | 是 | 快递公司名称 |
此码表为基数数据里对应值、由于与第三方系统对接的过程中、不同的系统对应的ID、code都不一样。故需要数据提供方 进行数据化转换.
国家或地区 | 对应货币 | 电话区号 | ||
---|---|---|---|---|
名称 | 缩写 | 中文 | 英文 | |
中国 | CN | 人民币 | CNY | +86 |
中国台湾 | TW | 新台币 | NTD | +886 |
中国香港 | HK | 港币 | HKD | +852 |
中国澳门 | MO | 澳门元 | MOP | +853 |
韩国 | KR | 韩元 | KRW | +82 |
澳大利亚 | AU | 澳大利亚元 | AUD | +61 |
马来西亚 | MY | 马来西亚元 | MYR | +60 |
美国 | US | 美元 | USD | +1 |
日本 | JP | 日元 | JPY | +81 |
类型 | code | 说明 |
---|---|---|
身份证 | 7 | 中国大陆地区、中国籍的收件人、请选择此项。以便海关查验 |
护照 | 8 | 非中国籍客户、可以提供护照号码。 |
渠道名称 | 渠道编码 |
---|---|
速邮达国际个人物品 | 112 |
数字清关个人物品 | 110 |
code | 说明 |
---|---|
10001 | 当前请求类型错误、请确认请求类型 |
10002 | 错误的接口:此接口名称不存在 |
10003 | 签名错误、请检查签名方式与签名方法 |
10004 | json格式数据 不是正确的json字符串格式、请检查 |
20001 | method:请检查method的值是否为空 |
20002 | method:请检查method的接口名称是否真实存在。 |
20010 | app_key:请检查 app_key 的值是否为空 |
20011 | app_key:请检查 app_key 的长度是否正确 |
20012 | app_key:此 app_key 不存在、请到管理后台查询真实的app_key |
20020 | session:请检查session 的值是否为空 |
20021 | session:请检查session 的值是否正确、或者超过有效期。 |
20030 | v:接口的版本号不能为空 |
20031 | v:请填写正确的接口版本号 |
20040 | sign:请检查是否填写对应的值 |
20041 | sign:请检查签名的是否正确、固定长度为:32个字符 |
20050 | sign_method:请检查是否填写对应的值 |
20051 | sign_method:目前签名格式只支持:md5、hmac两种加密方式。 |
20060 | timestamp:请检查timestamp是否填写。 |
20061 | timestamp:timestamp不是一个有效的日期 |
20062 | timestamp:timestamp的日期格式应为:"2018-04-13 12:01:02" |
20063 | timestamp:请求的日期与当前服务器日期 正负5分钟. |
20070 | format:请检查是否是否输入 |
20071 | format:该项值应为 json |
code | 错误说明 |
---|---|
20100 | batch_name:请确认批次名称是否认真填写、批次名称不能为空 |
20101 | batch_name:请确认批次名称长度为: 最少10个字符。 |
20102 | batch_name:请确认批次名称长度为: 最大100个字符。 |
20110 | sender:创建批次的时候 请携带发件信息集合。 |
20111 | sender:请仔细检查发件人信息集合。发件信息集合 |
发件人信息错误编码
code | 错误说明 |
---|---|
20200 | name:请确认发件人真实姓名、此项不能为空 |
20201 | name:请确认发件人真实姓名、正式姓名长度不符合标准 |
20206 | zip:请确认输入的邮编号码、邮编号码应为数字 |
20207 | zip:请确认输入的邮编号码、邮编号码的长度不符合标准、一般为六位数字 |
20210 | 发件人的手机号码与电话号码必须要填写一项 |
20211 | mobile:请确认输入的手机号码。格式应为:+国家(地区)区号 138-xxxx-xxxx 如:+82 138-000-000 注意国家(地区)区号后有空格 |
20212 | tel:请确认输入的手机号码。格式应为:+国家(地区)区号 区号-xxxx-xxxx 如:+82 02-966-8899 注意国家(地区)区号后有空格 |
20220 | country:请检查输入的 国家名称是否正确、此项不能为空 |
20221 | country:请检查输入的 国家名称是否正确、至少2字符。比如:中国 |
20230 | state: 请检查输入的二级行政区域名称。可以理解为对应中国的行政区域 "省"、此项不能为空,直辖市输入规则 如:上海市这里 填写 上海 |
20231 | state: 请检查输入的二级行政区域名称长度是否符合范围、最少字符应为 2个字符 |
20240 | city: 请检查输入的三级行政区域名称。可以理解为对应中国的行政区域 "市"、此项不能为空 直辖市输入规则 如:上海市这里 填写 上海市 |
20241 | city: 请检查输入的三级行政区域名称长度是否符合范围、最少字符应为 2个字符 |
20250 | district:请选择发件人所在的四级行政区:比如:城阳区、xx县 |
20260 | town:请选择发件人所在的五级行政区:比如:城阳街道、xx镇 |
20270 | address:请输入发件人所在区域的详细地址、具体到门牌号。此项不能为空 |
20271 | address:请输入发件人所在区域的详细地址是否符合对应的长度。至少6字符 |
20480 | idcard:身份证信息校验有误,请联系收件人提供真实身份证图片 |
收件人信息错误编码
code | 错误说明 |
---|---|
20400 | name:请确认收件人真实姓名、此项不能为空 |
20401 | name:请确认收件人真实姓名、正式姓名长度不符合标准 |
20406 | zip:请确认输入的邮编号码、邮编号码应为数字 |
20407 | zip:请确认输入的邮编号码、邮编号码的长度不符合标准、一般为六位数字 |
20410 | 收件人的手机号码与电话号码必须要填写一项 |
20411 | mobile:请确认输入的手机号码。格式应为:+国家(地区)区号 138-xxxx-xxxx 如:+82 138-000-000 注意国家(地区)后有空格 |
20412 | tel:请确认输入的手机号码。格式应为:+国家(地区) 区号-xxxx-xxxx 如:+82 02-966-8899 注意国家(地区)后有空格 |
20420 | country:请检查输入的 国家名称是否正确、此项不能为空 |
20421 | country:请检查输入的 国家名称是否正确、至少2字符。比如:中国 |
20430 | state: 请检查输入的二级行政区域名称。可以理解为对应中国的行政区域 "省"、此项不能为空,直辖市输入规则 如:上海市这里 填写 上海 |
20431 | state: 请检查输入的二级行政区域名称长度是否符合范围、最少字符应为 2个字符 |
20440 | city: 请检查输入的三级行政区域名称。可以理解为对应中国的行政区域 "市"、此项不能为空 直辖市输入规则 如:上海市这里 填写 上海市 |
20441 | city: 请检查输入的三级行政区域名称长度是否符合范围、最少字符应为 2个字符 |
20450 | district:请选择收件人所在的四级行政区:比如:城阳区、xx县 |
20460 | town:请选择收件人所在的五级行政区:比如:城阳街道、xx镇 |
20470 | address:请输入收件人所在区域的详细地址、具体到门牌号。此项不能为空 |
20471 | address:请输入收件人所在区域的详细地址是否符合对应的长度。至少6字符 |
20475 | address:请确认输入的证件类型是否是数字类型 证件类型 |
20476 | address:请确认输入的证件类型是否存在于证件类型 列表中 |
下单接口错误查询
code | 下单接口错误说明 |
---|---|
20300 | order_no:请确认订单号是否填写、此项不能为空 |
20301 | order_no:请确认输入的订单号长度是否正确:最小不能小于8个字符串、最长不能超过20个字符。 |
20303 | 发件人必须填写 |
20304 | 此订单号已经存在、请重新下单 |
20305 | batch_no:请确认批次号长度是否正确:最小不能少于7且不能大于10个数字 |
20306 | batch_no:输入的批次号不存在、请检查。 |
20307 | batch_no:批次号类型不准确。请输入数字类型的批次号 |
20310 | sender:请检查输入的发件人信息是否是正确的json字符串格式 |
20312 | receiver:请检查收件人信息是否填写、此项不能为空 |
20313 | receiver:请检查输入的收件人信息是否是正确的json字符串格式 |
20316 | goods:请检查订单的商品信息是否填写、此项不能为空 |
20317 | goods:请检查订单的商品信息是否是正确的json格式 |
20320 | weight:请准确输入商品重量、单位为g、若第三方数据为Kg、请进行换算 |
20321 | weight:以g 为单位最少为 三位数。比如:200 |
20325 | count:请准确输入订单商品数量、订单商品数量应为子订单商品数量之和 |
20326 | count:订单的商品数量 应为数字类型。 |
20327 | count:订单的商品数量 至少为1位数。 |
20330 | length:请准确输入货物长度、单位:CM 。精确到 2位数 如:12.12 |
20333 | width:请准确输入货物宽度、单位:CM 。精确到 2位数 如:12.12 |
20336 | heigh:请准确输入货物高度、单位:CM 。精确到 2位数 如:12.12 |
20340 | total_amount:请准确输入订单的商品金额 、此项不能为空 |
20341 | total_amount:订单金额的类型应为浮点型 。精确到 2位数 如:12.12 |
20345 | currency:请输入交易的货币单位比如:CNY 货币码表 |
20350 | tax_fee:关税金额类型应为浮点型 。精确到 2位数 如:12.12 |
20351 | buyer_nick:请填写买家名称、此项不能为空。 |
20352 | buyer_nick:买家名称与收件人名称相同、请检查输入。 |
20355 | sender_country:请填写发件国或地区、此项不能为空。 |
20356 | sender_country:请按照已开通的国家码表填写、码表中不存在的将出现此错误。如:KR 国家或地区码表 |
20360 | receiver_country:请填写目的国或地区、此项不能为空。 |
20361 | receiver_country:请按照已开通的国家码表填写、码表中不存在的将出现此错误。如:CN 国家或地区码表 |
商品组合错误查询
code | 商品组合错误查询 |
---|---|
20500 | code:商品编码不能为空、此项请填写第三方商品SKU.(唯一性) |
20501 | code:为了保证唯一性、商品SKU至少六个字符串、请确认。 |
20536 | code:请确保该条商品已经审核通过,如未审核请联系关务人员进行数据审核。 |
20505 | name:请确认输入的商品名称、此项不能为空。 |
20506 | name:请确认输入的商品名称、不能少于5个字符串。 |
20510 | price:请确认输入的商品价格(单价)、此项不能为空 |
20511 | price:请确认输入的商品价格、应为浮点型 如:12.02 |
20515 | count:请输入商品数量. |
20516 | count:商品的数量应为数字类型、如:2 |
20520 | unit:请输入商品对应的单位、如:双、条、件等 |
20525 | spec:请输入商品对应的规格、如:莫维尔衬衫 M 黑色 |
20530 | hscode:请准确输入海关申报编码(税号) |
20535 | currency:请填写对应的国家(地区) 货币代码 |
备案错误代码查询
code | 商品信息错误代码查询 |
---|---|
50001 | code:商品的SKU必填 |
50002 | code:该商品的SKU已经存在,请勿重复备案。 |
50003 | code:商品SKU最少为6位。 |
50004 | code:商品SKU最多为32位。 |
50005 | name:商品品名必填 |
50006 | name_en:英文品名必填 |
50007 | spec:商品规格必填. |
50008 | weight:净重必须填写,且单位为kg |
50009 | weight:净重必须为数字格式 |
50010 | price:商品价格不能为空 |
50011 | price:价格必须为数字格式 |
50012 | place_of_origin:原产国必填 |
50013 | send_code:起运国(地区)代码 比如韩国:133 具体请查看附属码表 |
50014 | code:SKU格式不正确,必须由英文、数字、下划线、中划线组成 |
50015 | place_of_origin:原产国必填 |
50016 | name:商品的品名含有对数据传输有影响的特殊字符,请检查过滤后重新备案 |