批量获取订单(保税订单) - globalsacnner/bonded GitHub Wiki

1. 更新说明

2019-03-11

获取商家在平台产生的保税订单 入参中增加标示,区分是否获取的是保税订单信息,默认是非保税订单信息 获取的信息中,增加了发货单整单的运费、实付、税费、非现金抵扣、货款 商品明细中增加商品级税费、非现金抵扣、货款信息

2. 调用URI

/order/findOrders

3. 请求方式

请求方式统一为POST

4. 业务请求参数

名称 类型 是否必须 描述
consignCode String 履约单号
status int 订单状态说明(100:待发货;200:已发货;210:已签收;300:无需发货)
startTime String 付款起始时间,例:2018-12-15 00:00:00
endTime String 付款结束时间,例:2018-12-17 00:00:00
updateTimeStart String 更新开始时间,例:2018-01-15 00:00:00
updateTimeEnd String 更新结束时间,例:2018-01-17 00:00:00
page int 否,默认1 页码,不传默认展示第一页
pageSize int 否,默认100 每页数量,不传默认一页100条,每页最大100条
bondedArea boolean 否,false 是否保税业务,默认非保税业务,需要获取保税特殊信息时,此处传true

单独回传履约单号时即可查询单个履约单信息,不必传时间信息

starTime必须小于endTime,并且起始时间跟结束时间差不得超过30天

如果没有传递分页参数(page和pageSize), 则默认只查询page=1和pageSize=100的数据

完整请求参数示例

 {
    "params": {
        "startTime":"2018-12-15 00:00:00",
        "endTime":"2018-12-17 00:00:00",
        "page":1,
        "pageSize":50,
        "status":100
    },
    "partner":"hqbs43",
    "timestamp":"2018-12-17 11:35:00"
}

5. 响应结果

名称 父级 类型 是否必须 描述
code - String
message - String 业务处理结果描述
data - Object code=1时返回结果
--rows data array 履约单列表
--total data int 履约单数量

rows参数

名称 父级 类型 是否必须 描述
shopOrderId data/rows Long 店铺订单id
consignCode data/rows String 履约单号
status data/rows int 发货单状态 100:待发货 ,200:已发货,210:已签收,300:无需发货
statusDesc data/rows String 发货单状态描述
freezeStatus data/rows int 冻结状态 1:未冻结,2:已冻结(买家发起退款后,状态变为已冻结,此部分数据是否发货,需要重点关注。退款完结后,冻结状态恢复)
freezeStatusDesc data/rows String 冻结状态描述
payTime data/rows String 支付时间
createTime data/rows String 创建时间
payChannel data/rows String 支付渠道
tradeNo data/rows String 支付交易号
buyerComment data/rows String 买家备注
sellerComment data/rows String 卖家备注
bondedAreaShipExpense data/rows String 发货单总运费
bondedAreaGoodsPrice data/rows String 商品货款
bondedAreaNonCashDeduct data/rows String 非现金抵扣金额
bondedAreaTax data/rows String 商品税费
bondedAreaPayCash data/rows String 发货单总实付金额
shipAddress data/rows object 收货人信息
orderSkuList data/rows array 履约单下的sku
--skuTitle data/rows/orderSkuList String 商品名称
--deliverCode data/rows/orderSkuList String 发货编码
--quantity data/rows/orderSkuList int 需要发货数量(若全部退款,可能为0)
--price data/rows/orderSkuList Long 售价, 商品原价(单位:分)
--shipExpenseShare data/rows/orderSkuList Long 运费:商品级订单分摊到的运费值(单位:分)
--shopPromotionAmount data/rows/orderSkuList Long 店铺优惠金额:商品级订单店铺优惠总金额(满减、优惠券)(单位:分)
--acrossPromotionAmount data/rows/orderSkuList Long 跨店优惠金额(单位:分)
--platformPromotionAmount data/rows/orderSkuList Long 平台优惠金额:商品级订单平台优惠总金额(G币、优惠券、会员优惠)(单位:分)
--payPrice data/rows/orderSkuList Long 支付金额(单位:分)
--actualIncomePrice data/rows/orderSkuList Long 实收金额 (单位:分)
--skuProProperty data/rows/orderSkuList String sku属性
--bondedAreaGoodsPrice data/rows/orderSkuList String 商品货款
--bondedAreaNonCashDeduct data/rows/orderSkuList String 非现金抵扣金额
--bondedAreaTax data/rows/orderSkuList String 商品税费
packageList data/rows array 履约单下的包裹
--logisticsChannel data/rows/packageList String 物流公司
--logisticsNumber data/rows/packageList String 物流编号
--status data/rows/packageList int 包裹状态 100:初始化,110:首次揽件,120:已签收
--statusDesc data/rows/packageList String 包裹状态描述

参数说明:

  • 商品售价:单件考虑打折/一口价后的的销售价;
  • 运费:商品级订单分摊到的运费值;
  • 支付金额:商品级订单用户实际支付金额;
  • 实收金额:商品级店铺实收;
  • 店铺优惠金额:商品级订单店铺优惠总金额(满减、优惠券);
  • 跨店优惠金额:商品级订单跨店优惠总金额;
  • 平台优惠金额:商品级订单平台优惠总金额(G币、优惠券、会员优惠)。
  • 支付金额=商品售价*数量+运费-店铺优惠金额-跨店优惠-平台优惠金额;
  • 实收金额=商品售价*数量-店铺优惠金额-跨店优惠=支付金额-运费+平台优惠金额。
  • 买家申请退款时,履约单会被冻结。获取数据后,可仅处理冻结状态是未冻结的履约单,避免错发。

保税新增的参数说明

  • 商品税费=[商品售价(单品优惠后)-店铺活动优惠-跨店优惠-平台活动优惠+运费]-[商品售价(单品优惠后)-店铺活动优惠-跨店优惠-平台活动优惠+运费]/1.091
  • 商品货款=商品售价(单品优惠后)-店铺活动优惠-跨店优惠-平台活动优惠-税费
  • 商品实付=商品货款+运费+税费-非现金抵扣
  • 非现金抵扣金额=店铺优惠券+平台优惠券+会员优惠+G币减免

shipAddress收货人信息

名称 父级 类型 是否必须 描述
shipToName data/rows/shipAddress String 收货方姓名
shipToMobile data/rows/shipAddress String 收货方手机号
shipToZip data/rows/shipAddress String 收货方地址邮编
shipToProvince data/rows/shipAddress String 收货方地址省份,直辖市省市相同
shipToCity data/rows/shipAddress String 收货方地址市,直辖市省市相同
shipToDistrict data/rows/shipAddress String 收货方地址行政区,市/县级行政区
shipToTown data/rows/shipAddress String 收货方地址镇,市级行政区对应街道/县级行政区对应城镇收货城市编码
shipToAddress data/rows/shipAddress String 收货方详细收货地址,街道、小区、门牌号收货地区
certification data/rows/shipAddress object 实名认证信息
--idCardNO data/rows/shipAddress/certification String 身份证号码
--idCardName data/rows/shipAddress/certification String 身份证姓名
--positiveUrl data/rows/shipAddress/certification String 身份证正面照片(图片url)
--otherSideUrl data/rows/shipAddress/certification String 身份证反面照片(图片url)

成功响应:

 {
    "code":"1",
    "data":{
        "rows":[
            {
                "shopOrderId":3025937543,
                "consignCode":"3025937543P1",
                "status":100,
                "freezeStatus":2,
                "payTime":1545708537000,
                "createTime":1545708538000,
                "shipAddress":{
                    "shipToName":"李大拿",
                    "shipToMobile":"**",
                    "shipToZip":"",
                    "shipToProvince":"浙江省",
                    "shipToCity":"杭州市",
                    "shipToDistrict":"西湖区",
                    "shipToTown":"",
                    "shipToAddress":"浙商财富中心",
                    "certification":{
                        "idCardNO":"**",
                        "idCardName":"**",
                        "positiveUrl":"https://img.gegejia.com/address/idCard/**.jpg",
                        "otherSideUrl":"https://img.gegejia.com/address/idCard/**.jpg"
                    }
                },
                "orderSkuList":[
                    {
                        "skuTitle":"光光测试-日常无活动商品-短名称测试长度",
                        "deliverCode":"**",
                        "quantity":0,
                        "price":0,
                        "shipExpenseShare":0,
                        "shopPromotionAmount":0,
                        "platformPromotionAmount":0,
                        "payPrice":0,
                        "actualIncomePrice":0
                    }
                ],
                "packageList":[

                ]
            },
            {
                "shopOrderId":3027265896,
                "consignCode":"3027265896P1",
                "status":100,
                "freezeStatus":1,
                "payTime":1545717182000,
                "createTime":1545717183000,
                "shipAddress":{
                    "shipToName":"毕竟",
                    "shipToMobile":"***",
                    "shipToZip":"",
                    "shipToProvince":"北京市",
                    "shipToCity":"北京市",
                    "shipToDistrict":"东城区",
                    "shipToTown":"",
                    "shipToAddress":"horn送",
                    "certification":{
                        "idCardNO":"***",
                        "idCardName":"安维佳",
                        "positiveUrl":"https://img.gegejia.com/address/idCard/***.jpg",
                        "otherSideUrl":"https://img.gegejia.com/address/idCard/***.jpg"
                    }
                },
                "orderSkuList":[
                    {
                        "skuTitle":"测试",
                        "deliverCode":"**",
                        "quantity":1,
                        "price":0,
                        "shipExpenseShare":0,
                        "shopPromotionAmount":0,
                        "platformPromotionAmount":0,
                        "payPrice":0,
                        "actualIncomePrice":0
                    }
                ],
                "packageList":[

                ]
            },
            {
                "shopOrderId":4000235896,
                "consignCode":"4000235896P1",
                "status":100,
                "freezeStatus":1,
                "payTime":1545722017000,
                "createTime":1545722017000,
                "shipAddress":{
                    "shipToName":"毕竟",
                    "shipToMobile":"**",
                    "shipToZip":"",
                    "shipToProvince":"北京市",
                    "shipToCity":"北京市",
                    "shipToDistrict":"东城区",
                    "shipToTown":"",
                    "shipToAddress":"horn送",
                    "certification":{
                        "idCardNO":"**",
                        "idCardName":"安维佳",
                        "positiveUrl":"https://img.gegejia.com/address/idCard/**.jpg",
                        "otherSideUrl":"https://img.gegejia.com/address/idCard/**.jpg"
                    }
                },
                "orderSkuList":[
                    {
                        "skuTitle":"测试",
                        "deliverCode":"是大法官442",
                        "quantity":1,
                        "price":0,
                        "shipExpenseShare":0,
                        "shopPromotionAmount":0,
                        "platformPromotionAmount":0,
                        "payPrice":0,
                        "actualIncomePrice":0
                    }
                ],
                "packageList":[

                ]
            },
            {
                "shopOrderId":8000815834,
                "consignCode":"8000815834P1",
                "status":100,
                "freezeStatus":1,
                "payTime":1545817862000,
                "createTime":1545817863000,
                "shipAddress":{
                    "shipToName":"**",
                    "shipToMobile":"**",
                    "shipToZip":"",
                    "shipToProvince":"浙江省",
                    "shipToCity":"杭州市",
                    "shipToDistrict":"西湖区",
                    "shipToTown":"",
                    "shipToAddress":"上到几点回家大家",
                    "certification":{
                        "idCardNO":"411424199502070916",
                        "idCardName":"刘霄",
                        "positiveUrl":"https://img.gegejia.com/address/idCard/**.jpg",
                        "otherSideUrl":"https://img.gegejia.com/address/idCard/**.jpg"
                    }
                },
                "orderSkuList":[
                    {
                        "skuTitle":"啊啊啊啊啊啊-短名称",
                        "deliverCode":"1544668786439",
                        "quantity":1,
                        "price":0,
                        "shipExpenseShare":0,
                        "shopPromotionAmount":0,
                        "platformPromotionAmount":0,
                        "payPrice":0,
                        "actualIncomePrice":0
                    }
                ],
                "packageList":[

                ]
            }
        ],
        "total":4
    },
    "message":"操作成功"
}

失败响应:

 {
    "code":"P04",
    "message":"服务繁忙,请稍后再试"
}

6. 错误码