燕文开放平台

-简要描述

根据运单号或订单号获取运单详情信息集合（方法名称：express.order.getlist）

-公共参数

请求地址

环境	HTTP请求地址
正式环境	https://open.yw56.com.cn/api/order
测试环境	https://open-fat.yw56.com.cn/api/order

账号信息

环境	账号	秘钥 apitoken
正式环境	贵司在我司客户号；	登录我司客户中心系统-账号管理-制单账号管理信息下查看秘钥；
测试环境	100000	D6140AA383FD8515B09028C586493DDB

公共请求参数

参数	类型	是否必填	描述
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)
生成签名示例：

D6140AA383FD8515B09028C586493DDB100000{}jsoncommon.country.getlist1655798809414V1.0D6140AA383FD8515B09028C586493DDB

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

加密后结果：bc5f1792e30936c72fa2a35efead8d73

4.请求URL示例

https://open-fat.yw56.com.cn/api/order?user_id=100000&method=common.country.getlist&format=json&timestamp=1655798809414&sign=bc5f1792e30936c72fa2a35efead8d73&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	转单号
yanwenOrderNumber	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	拣货单信息
handoverCode	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	object	商品信息
goodsNameCh	String	中文品名
goodsNameEn	String	英文品名
price	decimal	申报单价
quantity	Integer	申报数量
weight	Integer	单票重量(单位:g)
hscode	String	商品海关编码
url	String	商品链接
material	String	商品材质
sku	String	商品sku
imei	String	IMEI编码
- poPStation	object	自提网点信息
pointId	String	自提点ID
- importCustomsInfo	object	进口清关信息
taxPolicyExtends	Map<String,String>	国家相关税收政策信息
csp	String	瑞士CSP deferment account ID

-请求参数示例

{
    "listNumber":["YE891463206CN","KI2500000001A"]
}

-返回示例

{
  "success": true,
  "code": "0",
  "message": "操作成功",
  "data": [
    {
      "waybillNumber": "LW236960447CN",
      "orderNumber": "string",
      "referenceNumber": "",
      "yanwenNumber": "",
      "yanwenOrderNumber": "AB06000000003262",
      "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",
      "handoverCode":"TEMU_YWE_LAX",
      "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
      },
      "poPStation":{ 
         "pointId": ""
      },
       "importCustomsInfo": {
	    "taxPolicyExtends": {
	        "csp": "19237423SDFGEG"
	    }
      }
      "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,
            "imei":  ""
          },
          {
            "goodsNameCh": "杯子",
            "goodsNameEn": "cup",
            "quantity": "10",
            "weight": "1000",
            "price": "12.50",
            "hscode": null,
            "url": null,
            "material": null,
            "imei":  ""
          }
        ]
      }
    },
    {
      "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",
      "handoverCode":"",
      "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"
      },
      "poPStation":{ 
                "pointId": ""
            },
      "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,
            "imei":  ""
          },
          {
            "goodsNameCh": "杯子",
            "goodsNameEn": "cup",
            "quantity": "10",
            "weight": "1000",
            "price": "12.50",
            "hscode": null,
            "url": null,
            "material": null,
            "imei":  ""
          }
        ]
      }
    }
  ]
}

批量查询单号详情

-简要描述

-公共参数

请求地址

账号信息

公共请求参数

-请求参数

-响应参数

-请求参数示例

-返回示例