10. 订单列表

1. 接口

/mtop/aftersale/openapi/order/list

2. 接口参数

公共参数

公共参数

请求参数

字段 类型 是否必填 默认值 备注
orderId List<Long> 条件必填 订单号
status List<Integer> 条件必填 订单状态 参考下文状态列表
beginTime Long 条件必填 查询开始时间,订单支付时间,unix timestamp 秒
endTime Long 条件必填 查询结束时间,endTime-beginTime 不超过7天
pid Long 商品ID
channel String YOUPIN 订单渠道:"YOUPIN"-有品商城订单, "VMI"-VMI渠道订单
pageNo Integer 1 当前页号,从1开始
pageSize Integer 50 页大小, pageSize <= 100

备注:

  1. 两种查询模式:
    • 通过订单号查询:只需传 orderId 列表
    • 通过条件范围查询,beginTime, endTime, status 必填
  2. endTime - beginTime 支付时间跨度不超过7天

订单状态

状态码(status) 状态名称 描述 备注
4 已支付 已支付,待发货
6 已发货 已发货,待揽收
50 已妥投
17 申请退款 未发货,用户申请售中退款
37 退款中 未发货,商家已经同意退款,退款中
39 退款完成 退款完成(售中、拒收、售后)
18 订单取消 未支付或支付超时导致的订单取消
45 待服务 虚拟服务待服务
46 服务中 虚拟服务服务中

注意: openapi暂时不支持虚拟服务单处理,处理流程请到 有品售后服务系统(YMS)

3. 请求示例

{
  "status":[4,6],
  "beginTime":1570400610,
  "endTime":1578476640,
  "pageNo": 1,
  "pageSize": 50
}

4. 返回示例

{
   "code": 0,
   "message": "ok",
   "data": {
      "pageNo": 1,
      "pageSize": 50,
      "total": 2000,
      "orderList": [{
         "orderId": 4200309201900540, // 订单ID
         "originOrderId": 0, // 换货单原单单号,见文档常见问题
         "channel": "YOUPIN", // 订单渠道:"YOUPIN"-有品商城订单, "VMI"-VMI渠道订单
         "orderType": 6,  // 订单类型 6-有品普通订单, 13-普通众筹, 16-定金预售订单, 17-海淘跨境, 18-收单订单(外平台或活动), 19-虚拟商品订单, 23-换货单, 24-补件单, 25-盲售单
         "uid": 222548368, // 用户id
         "partnerId": 65, // 商户ID, 同公共参数里的partnerId
         "ctime": 1477352886, // 订单创建时间,时间戳(秒)
         "ftime": 1477352915, // 订单支付时间,时间戳(秒)
         "consignor": 65, // 发货主体 (65为有品配送,非65为商家自发)
         "description": "", // 订单用户备注
         "address":{ // 订单收货人信息
            "country":{
               "id":"1",
               "name":"中国"
            },
            "province":{
               "id":"2",
               "name":"北京"
            },
            "city":{
               "id":"36",
               "name":"北京市"
            },
            "district":{
               "id":"377",
               "name":"东城区"
            },
            "area":{
               "id":"377001",
               "name":"安定门街道"
            },
            "address":"测试请勿发货",
            "addressId":"10160717960900847",
            "addressName":"",
            "consignee":"测试",
            "tel":"15011577075",
            "zipcode":"100011",
            "addTime":1581995815,
            "updateTime":1581995815,
         }, 
         "consigneeIdCard": { // 用户身份证信息(跨境电商专用)
            "cardId": "100214199001010113", // 身份证号码 
            "cardName": "张三" // 身份证姓名
         },
         "paymentInfo": { // 支付信息 跨境电商专用
            "importationType": ["WEIXIN"], // 保税仓金控订单支付类型,不符合业务需求的支付方式为空,微信: WEIXIN, 支付宝: ALIPAY, 
         },
         "couponReduce": 0, // 订单优惠券扣减金额(分)
         "activityReduce": 0, // 订单活动扣减金额(分)
         "redpacketReduce": 0, // 订单红包扣减金额 (分)
         "shipFee": 0, // 订单运费(分)
         "totalPrice": 16900, // 订单支付总价(包含运费)(分)
         "invoiceTitle": "String(发票抬头)",
         "invoiceType": 0, // 0-无发票,1-个人纸质普票,2-企业纸质普票,4-电子发票(旧版),5-个人电子普票,6-企业电子普票
         "invoiceCompanyCode": "String(税号)",
         "invoicePhone": 13800000001, // 发票开具通知号码
         "invoiceEmail": "test@163.com", // 发票开具通知邮箱
         "productList": [{  // 订单购买的产品详情列表
            "ugId": "4200309201900540001", // ugId 商品行唯一标识
            "gid": 101364, // 商品GID
            "pid": 8624, // 产品PID
            "name": "90分银离子抗菌T恤 男款 黑白 165/84A", // pid商品名称
            "count": 1, // 该pid商品数量
            "status": 4, // 订单商品状态,见下表
            "packagePid": 0, // 套装pid
            "packageCount": 0,  // 套装购买数量
            "packageName": "",  // 套装名称
            "virtualType": 0, // 商品虚拟类型: 0-实物, 1-安装服务, 2-会员
            "merchantId": 28, // 商品所属的商户ID,
            "price": 349900, // 产品支付价格(pid支付金额小计),单位:分
            "salePrice": 7900, // 下单时该商品售卖价格(券优惠,红包以及其他非直降类活动优惠的基准价格),单位:分
            "productPrice": 17900, // 原价(市场价),单位:分
            "expressAvFee": 0, // 商品分摊运费,单位:分
            "skuInfoList": [{
                "skuId": 3055298, // skuid
                "count": 1 // 单个pid对应的skuid 数量,见下文常见问题
            }],
            "customizedInfo": "{\"individual\":{\"collar\":\"1\",\"sleeve\":\"8\",\"pocket\":\"57\",\"pattern\":\"61\",\"word_location\":\"17\"},\"size\":{\"abdomen_para\":\"normal\",\"chest_para\":\"corpulent\",\"shoulder_para\":\"normal\",\"stance_para\":\"normal\",\"height\":\"170\",\"weight\":\"60\"},\"individual_word\":\"\"}" // 商品定制信息
            "promiseDeliveryTime": 1477439315 // 承诺发货时间,时间戳(秒)
         }],
         "logisticsList": [{
            "bizCode": "zhongtong",
            "companyName": "中通快递",
            "expressSn": "zt000000002",
            "deliveryTime": 1553740458,
            "acceptTime": 0,
            "itemList": [{
                "pid": 8624,
                "skuId": 0,
                "count": 1
            }]
         }],
         "orderRemarkList": [{
          "level": 0, //备注等级,0-5分别对应蓝、红、橙、黄、绿、紫
          "remark": "订单备注",
          "userName": "操作人",
          "createTime": "创建时间戳,秒级"
         }]
     }]
  }
}

5 常见问题

1 ugId, gid, pid, packagePid, skuId 分别是什么

  1. ugId 为订单商品行唯一标识,全局唯一,用于定位商品。同时,在售后单列表接口报文中也包含该字段,用于指定申请拒收、售后(退换修)的商品行。

  2. gid是有品的产品站编号,比如 "90分Grinder牛津休闲双肩包"(gid=103787) 的产品站PC端链接为:https://www.xiaomiyoupin.com/detail?gid=103787

  3. pid为有品平台最小的售卖单位,即用户下单的最小商品单位。产品站(gid)内可包含多个的商品(pid),比如 "90分Grinder牛津休闲双肩包"(gid=103787) 有三个不同的颜色即:黑色(pid=17740), 深蓝色(pid=17741), 米白色(pid=17742),gid与pid为1对多关系

  4. packagePid 为套装商品pid,一个或多个单品商品可以组合成一个套装商品打包售卖。订单明细会按照套装商品映射规则拆分成对应的单品商品(单品pid)。升级详情见 套装商品升级指南

  5. skuId 是仓库库存单位,套装商品上线后,pid与skuId的关系为1对1。

  6. pid-skuId的对应关系可以通过如下两种方式获取:

    6.1 在订单列表中的 skuInfoList 字段

    6.2 通过 productlist 接口获取。

  7. 维护pid-skuId 关系是为了保证回传准确的包裹内物(itemList),回传接口见 单次发货

2 有品sku支持外部编码吗?

有品sku暂不支持外部编码,商家入驻有品后,在创建商品时会生成统一的商品 skuId,skuId 需要商家ERP维护。

3 totalPrice, price, salePrice, productPrice, expressAvFee, shipFee 分别是什么

"totalPrice":该订单的支付总金额(分)

"shipFee":该订单的邮费总金额(分)

"price": 该pid(商品)支付金额(pid支付金额小计,分),已经乘过数量(count)

"salePrice": 下单时该pid(商品)售卖单价(分)

"productPrice": 市场单价(分)

"expressAvFee": 该pid(商品)分摊运费(分)

4 优惠如何计算?

商品(pid)优惠计算:sale_price(下单时该商品售卖价) * count(pid购买个数) - price(pid支付金额)

5 为什么会出现 商品支付金额合计后不等于订单支付总金额?

有可能出现 sum(productList.price) != totalPrice 的情况,即该订单下还有其他商家的商品,贵司只能获取到部分本公司商品的信息。

shipFee 同理

6 couponReduce, activityReduce, redpacketReduce 分别是什么,是否区分费用承担方(有品承担、商家承担)

couponReduce:订单优惠券扣减金额(分)

activityReduce:订单活动扣减金额(分)

redpacketReduce: 订单红包扣减金额 (分)

三个扣减金额均为整个订单的优惠金额。优惠金额未分摊到各商品(pid)上,也不区分费用承担方。

7 如何确认订单是否为商家自发货

可以根据发货主体字段判断:"consignor": 65为有品配送,非65为商家自发。

8 换货单类型订单

换货单类型订单(orderType=23)的响应结果中,会将原单单号信息带出。见响应结果的"originOrderId"字段。"originOrderId"返回的原单单号指的是用户最原始下的订单,例如A换B,B换C,此时在B、C的订单响应信息中的"originOrderId"的值指的是A单。非换货单,originOrderId 为 0。

©xiaomiyoupin.com 苏B2-20180351 苏ICP备18025642号-1            该文件修订时间: 2023-04-26 01:54:18

results matching ""

    No results matching ""