小包专线

追踪轨迹

海外派

尾程业务-查询单号详情

更新时间:2025-01-21 15:06:34

-简要描述
  • 根据运单号或订单号获取运单详情信息集合 (方法名称:express.order.getlist)

-公共参数
请求地址
环境 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{}jsonexpress.order.create1655798809414V1.0E33A3973221DB08128F8FF436EFDB8F4

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

  加密后结果:1a4187d5e55337e2383b041bfb5a532f

  • 4.请求URL示例

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


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

-请求参数
参数 类型 描述
listNumber array 查询单号集合,支持运单号或订单号,最多查询50个
-响应参数
参数 类型 描述
success Boolean 是否成功 true:成功 false:失败
code String 消息编码 0:成功 >0:失败 <0:系统异常
message String 消息内容
- data object 实体信息
waybillNumber String 运单号
orderNumber String 订单号
referenceNumber String 转单号
yanwenNumber String 燕文参考单号(唯一)
channelId String 产品编号(产品id)
channelName String 产品名称
orderSource String 订单来源
userId String 发货账号
dateOfReceipt Date 收款到账日期
createTime Date 下单时间
status Integer

运单状态:0 已制单,1 已确认发货,2 已收货,3 运输中,4已妥投,5已取消,6 已截留,7 投递失败,8 仓内异常,

9 仓内退件,10 退件签收,11 转运异常,12 派送中,13 待提取,15 追踪结束;

companyCode String 发货账号所属燕文揽收仓编码
isPrint Integer 是否打印 1:是 0:否
remark String 拣货单信息
-receiverInfo object 收件人信息
name String 收件人姓名
phone String 收件人电话
company String 收件人公司
email String 收件人邮箱
countryId String 收件人国家Id
countryName String 收件人国家
state String 收件人所属州(省)
city String 收件人城市
zipCode String 收件人邮编
houseNumber String 收件人门牌号
address String 收件人地址
taxNumber String 收件人税号
- senderInfo object 发件人信息
name String 发件人姓名
phone String 发件人电话
company String 发件人公司
email String 发件人邮箱
countryId String 发件人国家Id
countryName String 发件人国家
state String 发件人所属州(省)
city String 发件人城市
zipCode String 发件人邮编
houseNumber String 发件人门牌号
address String 发件人地址
taxNumber String 发件人税号
-parcelInfo object 包裹信息
hasBattery Integer 是否含电 1:是 0:否
currency String 申报币种
totalPrice Number 申报总价
totalQuantity Integer 申报总数量
totalWeight Integer 总重量(单位:g)
height Integer 包裹高度(单位:cm)
width Integer 包裹宽度(单位:cm)
length Integer 包裹长度(单位:cm)
ioss String IOSS税号
-productList List 商品信息
goodsNameCh String 中文品名
goodsNameEn String 英文品名
price decimal 申报单价
quantity Integer 申报数量
weight Integer 单票重量(单位:g)
hscode String 商品海关编码
url String 商品链接
material String 商品材质
sku String 商品sku
-请求参数示例
{
   "listNumber":["YE891463206CN","KI2500000001A"]
}


-返回示例
{
 "success": true,
 "code": "0",
 "message": "操作成功",
 "data": [
   {
     "waybillNumber": "LW236960447CN",
     "orderNumber": "string",
     "referenceNumber": "",
     "yanwenNumber": "LW236960447CN",
     "userId": "10003791",
     "orderSource": "portal",
     "channelId": "155",
     "channelName": "中邮上海线下E邮宝",
     "dateOfReceipt": "2022-01-10 00:00:00",
     "createTime": "2022-06-21 02:59:42",
     "companyCode": "01",
     "isPrint": "0",
     "remark": "AAAA拣货单信息",
     "status": "0",
     "receiverInfo": {
       "name": "string",
       "company": "string",
       "countryId": "115",
       "countryName": "美国",
       "phone": "string",
       "state": "string",
       "city": "string",
       "email": "529932298@qq.com",
       "zipCode": "10110",
       "taxNumber": "AAAAAstring",
       "address": "string",
       "houseNumber": "string"
     },
     "senderInfo": {
       "name": null,
       "company": null,
       "countryId": null,
       "countryName": null,
       "phone": null,
       "state": null,
       "city": null,
       "email": null,
       "zipCode": null,
       "taxNumber": "AAAAAAAstring",
       "address": null,
       "houseNumber": null
     },
     "parcelInfo": {
       "currency": "USD",
       "totalPrice": "50.10",
       "totalQuantity": "10",
       "totalWeight": "243",
       "height": "10",
       "width": "10",
       "length": "10",
       "hasBattery": "1",
       "ioss": null,
       "productList": [
         {
           "goodsNameCh": "杯子",
           "goodsNameEn": "cup",
           "quantity": "10",
           "weight": "1000",
           "price": "12.50",
           "hscode": null,
           "url": null,
           "material": null
         },
         {
           "goodsNameCh": "杯子",
           "goodsNameEn": "cup",
           "quantity": "10",
           "weight": "1000",
           "price": "12.50",
           "hscode": null,
           "url": null,
           "material": null
         }
       ]
     }
   },
   {
     "waybillNumber": "LW236961076CN",
     "orderNumber": "SWuijdhj17777UIAA",
     "referenceNumber": "",
     "yanwenNumber": "LW236961076CN",
     "userId": "10003791",
     "orderSource": "portal",
     "channelId": "155",
     "channelName": "中邮上海线下E邮宝",
     "dateOfReceipt": "2022-01-10 00:00:00",
     "createTime": "2022-06-21 03:07:24",
     "companyCode": "01",
     "isPrint": "0",
     "remark": "AAAA拣货单信息",
     "status": "0",
     "receiverInfo": {
       "name": "string",
       "company": "string",
       "countryId": "115",
       "countryName": "美国",
       "phone": "string",
       "state": "string",
       "city": "string",
       "email": "529932298@qq.com",
       "zipCode": "10110",
       "taxNumber": "AAAAAstring",
       "address": "string",
       "houseNumber": "string"
     },
     "senderInfo": {
       "name": "string",
       "company": "string",
       "countryId": "115",
       "countryName": "美国",
       "phone": "string",
       "state": "string",
       "city": "string",
       "email": "string",
       "zipCode": "string",
       "taxNumber": "AAAAAAAstring",
       "address": "Astring",
       "houseNumber": "string"
     },
     "parcelInfo": {
       "currency": "USD",
       "totalPrice": "50.10",
       "totalQuantity": "10",
       "totalWeight": "243",
       "height": "10",
       "width": "10",
       "length": "10",
       "hasBattery": "1",
       "ioss": "AAAA123456",
       "productList": [
         {
           "goodsNameCh": "杯子",
           "goodsNameEn": "cup",
           "quantity": "10",
           "weight": "1000",
           "price": "12.50",
           "hscode": null,
           "url": null,
           "material": null
         },
         {
           "goodsNameCh": "杯子",
           "goodsNameEn": "cup",
           "quantity": "10",
           "weight": "1000",
           "price": "12.50",
           "hscode": null,
           "url": null,
           "material": null
         }
       ]
     }
   }
 ]
}