小包专线

追踪轨迹

海外派

清关业务-小件创建

更新时间:2025-01-21 17:45:04

-简要描述
  • 清关业务-小件创建 (方法名称:s3.express.create)

-公共参数
请求地址
环境 HTTP请求地址
正式环境 https://open.yw56.com.cn/api/order
测试环境 https://ejf-fat.yw56.com.cn/api/order
账号信息
环境 账号 秘钥 apitoken
正式环境 贵司在我司客户号; 登录我司客户中心系统-账号管理-制单账号管理信息下查看秘钥;
测试环境 99000015 E33A3973221DB08128F8FF436EFDB8F4
公共请求参数
参数 类型 是否必填 描述
user_id String 客户号
format String 报文格式 默认为json格式,可选值:json
method String api名称;
timestamp Long 时间戳(毫秒级) 有效期为5分钟
version String api版本号 可选 V1.0
sign String 签名(根据动态规则生成)
data String 报文内容(body请求参数,放在请求体中,使用json格式)
  • 1.请求方式 所有接口使用 POST 方式请求,没有特殊说明 所有字符编码为utf-8; Content-Type: application/json;

  • 2.公共请求参数放在url后面,使用&连接

  • 3.签名规则

    第一步:按字典序排列将参数拼接。具体顺序为 user_id+data+format+method+timestamp+version

    第二步:将apiToken拼接到第一步的字符串的头部和尾部 apitoken+user_id+data+format+method+timestamp+version+apitoken

    第三步:将第二步的结果进行md5加密; MD5(apitoken+user_id+data+format+method+timestamp+version+apitoken)

    生成签名示例:

E33A3973221DB08128F8FF436EFDB8F499000015{}jsons3.express.create1655798809414V1.0E33A3973221DB08128F8FF436EFDB8F4

注:a.data 参数为body请求参数为json格式,并且使用压缩格式 b.MD5加密方式为32位小写;

  加密后结果:7af1fc82769b53064bb0ef601435326f

  • 4.请求URL示例

https://ejf-fat.yw56.com.cn/api/order?user_id=99000015&method=s3.express.create&format=json&timestamp=1655798809414&sign=7af1fc82769b53064bb0ef601435326f&version=V1.0

注:user_id,method,format,version,timestamp要和生成签名时使用的参数一致。sign为生成参数签名步骤生成的md5加密后得到的

-请求参数
参数 类型 是否必填 长度 描述
waybillNumber
String 64 运单号追踪号
mawbNo String 64 主单号
mawbVersion Integer

主单版本号

bagNo String 64 大包号
orderNumber String 65 客户订单号
channelId Integer
产品编号
-receiverInfo object

收件人信息
name String 128 收件人姓名
phone String 64 收件人电话
email String
64 收件人邮箱
company String
128 收件人公司
country String 4 收件人国家二字码
state String
64 收件人州(省)
city String
64 收件人城市
district String
64

收件人区

zipCode String 64 收件人邮编
address String 200 收件人地址
taxNumber String
50 收件人税号
- parcelInfo object

包裹信息
descriptionEn String
256 包裹描述-英文
descriptionLocal String
256 包裹描述-中文
currency String 8 申报币种; USD,EUR,GBP,AUD,CAD;
totalDeclareValue Decimal (18,2) 申报总价值
totalQuantity Integer
商品数量总和
totalWeight Integer
包裹总重量(单位:g)
hasBattery Integer

是否含电 1:是 0:否
hasMetal Integer

是否金属 1:是 0:否
hasFlammable Integer

是否易燃 1:是 0:否
hasLiquid Integer

是否液体 1:是 0:否
height Integer

包裹高(单位:cm)
width Integer

包裹宽(单位:cm)
length Integer

包裹长(单位:cm)
productList List

商品信息
goodsNameCh String 200 中文品名
goodsNameEn String 200 英文品名
declareValue Decimal (18,2) 申报单价
currency String 8
申报价值币种
hscode String
64 商品海关编码
material String
64 商品材质
use String
64 商品用途
countryOfOrigin String
64 商品原产国
countryOfOriginCode String
4 商品原产国家二字码
quantity Integer
数量
weight Integer
单品申报重量(单位:g)
sku String
64 商品sku
productUrl String
256 商品链接
imageUrl String
256 图片链接
-senderInfo object

发件人信息
name String
128 发件人姓名
phone String
64 发件人电话
email String
64 发件人邮箱
company String
128 发件人公司
country String
10 发件人国家二字码
state String
64 发件人州(省)
city String
64 发件人城市
district

String


64
发件人区
zipCode String
64 发件人邮编
address String
256 发件人地址
taxNumber String
32 发件人税号
returnInfo object

退件人信息
name String
128 退件人姓名
phone String
64 退件人电话
email String
64 退件人邮箱
company String
128 退件人公司
country String
10 退件人国家二字码
state String
64 退件人州(省)
city String
64 退件人城市
district

String


64
退件人区
zipCode String
64 退件人邮编
address String
256 退件人地址
address2 String
256 退件人地址2
-响应参数
参数 类型 描述
success Boolean 是否成功 true:成功 false:失败
code String 消息编码 0:成功 >0:失败 <0:系统异常
message String 消息内容
data object 实体信息
-请求参数示例
{
"waybillNumber": "trackingNo001",
"bagNo": "bagNo001",
"mawbNo": "test10000001",
"mawbVersion": "1",
"orderNumber": "A12448587",
"channelId": "1646",
"senderInfo": {
"name": "test",
"company": "test",
"phone": "01921145981",
"zipCode": "62430",
"email": "sender_email",
"country": "CN",
"state": "zhejiang",
"city": "yiwu",
"district": "xxx",
"address": "xxxxx",
"taxNumber": "xxxxx"
},
"receiverInfo": {
"name": "test name",
"company": "testCompany",
"phone": "10047214812",
"zipCode": "31530",
"email": "receiver_email",
"country": "FR",
"state": "Haute-garonne",
"city": "Le Castéra",
"district": "",
"address": "61 Chemin den Bigourdas",
"taxNumber": "receiver_taxNumber"
},
"returnInfo": {
"name": "test",
"company": "test",
"phone": "01921145981",
"zipCode": "62430",
"email": "receiver_email",
"country": "FR",
"state": "Louisiana",
"city": "Sallaumines",
"district": "return_district",
"address": "return address1",
"address2": "return address2"
},
"parcelInfo": {
"descriptionEn": "en",
"descriptionLocal": "cn",
"totalWeight": "1000",
"totalDeclareValue": "50",
"currency": "USD",
"totalQuantity": "5",
"hasBattery": "1",
"hasMetal": "1",
"hasFlammable": "0",
"hasLiquid": "0",
"hasPowder": "0",
"length": "10",
"width": "10",
"height": "10",
"productList": [{
"sku": "气泵 ",
"goodsNameEn": "airpump",
"goodsNameCh": "气泵",
"material": "塑料",
"use": "use",
"countryOfOrigin": "china",
"countryOfOriginCode": "CN",
"declareValue": "10",
"currency": "USD",
"weight": "358",
"quantity": "1",
"hsCode": "cbd",
"productUrl": "xxx",
"imageUrl": "xxxx"
}]
}
}

返回示例
{
    "success": true,
    "code": "0",
    "message": "操作成功",
    "data": null
}

-备注

1/订单和运单数据有效期保留半年。