百胜对接模块

API域名以及签名 统一签名

联系人: 王萌、林哲

全局响应参数:

参数名称	数据类型	参数说明
code	Integer	0:成功 其他失败
data	Object	返回数据
message	String	错误信息

---

1、收款

（1）接口地址:/openApi/bs/collectPayment

（2）请求方式:POST

（3）请求数据类型:application/json

（4）响应数据类型:application/json

（5）请求参数:

参数名称	数据类型	是否必须	参数说明
requestId	String	true	请求id,作为幂等性标识字段
dataList	List	true	收款数据行
└ cashierCode	String	true	收银员编码
└ cashierName	String	true	收银员名称
└ currency	String	true	币种
└ dataList	List	true	收款明细行
└ currency	String	true	币种
└ giftCardNo	String	false	礼品卡号
└ offStoreOrderNo	String	true	门店订单号
└ recChannelCode	String	true	收款渠道编码
└ recChannelName	String	false	收款渠道名称
└ recFaceAmount	Number	true	收款面值金额
└ recRealAmount	Number	true	收款本金金额
└ offStoreCode	String	true	门店编码
└ offStoreOrderNo	String	true	门店订单号
└ orderCreateTime	String	true	单据创建时间,格式:yyyy-MM-dd HH:mm:ss
└ orderCreator	String	true	单据创建人
└ orderType	Integer	true	订单类型，0:门店订单，1:预售订单，2:定金订单，3:店定网络订单
└ recTime	String	true	收款时间,格式:yyyy-MM-dd HH:mm:ss
└ recType	String	true	收款类型，receive:收款 back:退款
└ totalPreFaceAmount	Number	false	预收订单面值总金额
└ totalPreRealAmount	Number	false	预收订单本金总金额
└ totalRecFaceAmount	Number	true	收款总面值金额
└ totalRecRealAmount	Number	true	收款总本金金额

（6）请求示例:

{
  "dataList": [
    {
      "cashierCode": "",
      "cashierName": "",
      "currency": "",
      "dataList": [
        {
          "currency": "",
          "giftCardNo": "",
          "offStoreOrderNo": "",
          "recChannelCode": "",
          "recChannelName": "",
          "recFaceAmount": 0,
          "recRealAmount": 0
        }
      ],
      "offStoreCode": "",
      "offStoreOrderNo": "",
      "orderCreateTime": "",
      "orderCreator": "",
      "orderType": 0,
      "recTime": "",
      "recType": "",
      "totalPreFaceAmount": 0,
      "totalPreRealAmount": 0,
      "totalRecFaceAmount": 0,
      "totalRecRealAmount": 0
    }
  ],
  "requestId": ""
}

（7）响应参数:

参数名称	数据类型	参数说明
code	Integer	0:成功 其他失败
data	Object	无返回数据
message	String	错误信息

（8）响应示例:

{
  "code": 0,
  "data": {},
  "message": ""
}

---

2、配货入库接口

（1）接口地址:/openApi/bs/dispatchStorageOrder

（2）请求方式:POST

（3）请求数据类型:application/json

（4）响应数据类型:application/json

（5）请求参数:

参数名称	数据类型	是否必须	参数说明
requestId	String	true	请求id,作为幂等性标识字段
dataList	List	false	配货入库列表
└ dataList	List	true	明细行
└ omsStockSn	String	true	OMS库存流水单号
└ qty	Integer	true	商品数量
└ skuCode	String	true	SKU编码
└ dispatchOrderType	Integer	true	配货订单类型
└ invSerialNo	String	true	库存流水单号
└ invTime	String	true	库存日期
└ offStoreCode	String	true	入库门店编码
└ offStoreName	String	true	入库门店名称
└ omsInvSerialNo	String	false	OMS库存流水单号
└ orderCreateTime	String	true	单据创建时间
└ orderCreator	String	true	单据创建人
└ tradeNo	String	false	交易订单号

（6）请求示例:

{
  "dataList": [
    {
      "dataList": [
        {
          "omsStockSn": "",
          "qty": 0,
          "skuCode": ""
        }
      ],
      "dispatchOrderType": 0,
      "invSerialNo": "",
      "invTime": "",
      "offStoreCode": "",
      "offStoreName": "",
      "omsInvSerialNo": "",
      "orderCreateTime": "",
      "orderCreator": "",
      "tradeNo": ""
    }
  ],
  "requestId": ""
}

（7）响应参数:

参数名称	数据类型	参数说明
code	Integer	0:成功 其他失败
data	Object	返回数据
└ isSuccess	Boolean	是否成功
message	String	错误信息

（8）响应示例:

{
  "code": 0,
  "data": {
    "isSuccess": true
  },
  "message": ""
}

---

3、库内存货接口

（1）接口地址:/openApi/bs/invDetail/save

（2）请求方式:POST

（3）请求数据类型:application/json

（4）响应数据类型:application/json

（5）请求参数:

参数名称	数据类型	是否必须	参数说明
requestId	String	true	请求id,作为幂等性标识字段
dataList	List	false	库内存货明细列表
└ financeTypeCode	String	false	财务类型代码
└ invSerialNo	String	false	门店库存流水单据号
└ invType	Integer	false	门店出入库类型
└ offStoreCode	String	false	门店编码
└ orderCreateTime	String	false	单据创建时间
└ orderCreator	String	false	单据创建人
└ orderTime	String	false	单据日期
└ qty	Integer	false	数量
└ remark	String	false	备注说明
└ skuCode	String	false	SKU编码

（6）请求示例:

{
  "dataList": [
    {
      "financeTypeCode": "",
      "invSerialNo": "",
      "invType": 0,
      "offStoreCode": "",
      "orderCreateTime": "",
      "orderCreator": "",
      "orderTime": "",
      "qty": 0,
      "remark": "",
      "skuCode": ""
    }
  ],
  "requestId": ""
}

（7）响应参数:

参数名称	数据类型	参数说明
code	Integer	0:成功 其他失败
data	Object	无返回数据
message	String	错误信息

（8）响应示例:

{
  "code": 0,
  "data": {},
  "message": ""
}

---

4、履约订单

（1）接口地址:/openApi/bs/salesOrder

（2）请求方式:POST

（3）请求数据类型:application/json

（4）响应数据类型:application/json

（5）请求参数:

参数名称	数据类型	是否必须	参数说明
requestId	String	true	请求id,作为幂等性标识字段
dataList	List	true	订单数据行
└ channelType	Integer	true	渠道类型，0:pos、1:旗舰店小程序、2:超级门店小程序、3:美团、4:饿了吗、5:京东到家、6:喵街
└ consignTime	String	true	订单发货日期,格式:yyyy-MM-dd HH:mm:ss
└ dataList	List	true	订单明细行
└ midTypeCode	String	true	中类编码
└ midTypeName	String	true	中类名称
└ offStoreFirstCategoryCode	String	true	门店一级分类编码
└ offStoreFirstCategoryName	String	true	门店一级分类名称
└ qty	Integer	true	数量
└ salesFaceAmount	Number	true	销售金额（面值）
└ salesPrice	Number	true	销售单价
└ salesRealAmount	Number	true	销售金额（本金）
└ salesStandardAmount	Number	true	标准销售金额
└ skuCode	String	true	SKU编码
└ smallTypeCode	String	true	小类编码
└ smallTypeName	String	true	小类名称
└ miniStoreCode	String	false	小程序店铺编码
└ offStoreCode	String	true	门店编码
└ orderClass	String	true	订单类别，sales:销售订单、back:退货订单
└ orderCreateTime	String	true	单据创建时间,格式:yyyy-MM-dd HH:mm:ss
└ orderCreator	String	true	单据创建人
└ orderType	Integer	true	订单类型，0:门店订单、1:预售订单、2:定金订单、3:店定网络订单、4:自提订单、5:门店快递订单、6:渠道订单
└ originOrderNo	String	false	原订单号
└ payTime	String	true	支付日期,格式:yyyy-MM-dd HH:mm:ss
└ salesOrderNo	String	true	订单编号
└ totalFaceAmount	Number	true	订单总金额（面值）
└ totalRecAmount	Number	true	订单总金额（本金）

（6）请求示例:

{
  "dataList": [
    {
      "channelType": 0,
      "consignTime": "",
      "dataList": [
        {
          "midTypeCode": "",
          "midTypeName": "",
          "offStoreFirstCategoryCode": "",
          "offStoreFirstCategoryName": "",
          "qty": 0,
          "salesFaceAmount": 0,
          "salesPrice": 0,
          "salesRealAmount": 0,
          "salesStandardAmount": 0,
          "skuCode": "",
          "smallTypeCode": "",
          "smallTypeName": ""
        }
      ],
      "miniStoreCode": "",
      "offStoreCode": "",
      "orderClass": "",
      "orderCreateTime": "",
      "orderCreator": "",
      "orderType": 0,
      "originOrderNo": "",
      "payTime": "",
      "salesOrderNo": "",
      "totalFaceAmount": 0,
      "totalRecAmount": 0
    }
  ],
  "requestId": ""
}

（7）响应参数:

参数名称	数据类型	参数说明
code	Integer	0:成功 其他失败
data	Object	无返回数据
message	String	错误信息

（8）响应示例:

{
  "code": 0,
  "data": {},
  "message": ""
}

---

5、店铺信息同步

（1）接口地址:/openApi/bs/syncStore

（2）请求方式:POST

（3）请求数据类型:application/json

（4）响应数据类型:application/json

（5）请求参数:

参数名称	数据类型	是否必须	参数说明
cityCode	String	false	市编码
cityName	String	false	市名称
customerCode	String	false	客户编码
mainGroupName	String	true	主体名称
marketingAreaCode	String	false	营销区域编码
marketingAreaName	String	false	营销区域名称
provinceCode	String	false	省编码
provinceName	String	false	省名称
storeCode	String	true	店铺编码
storeName	String	true	店铺名称
storeType	String	false	店铺类型 01:直营；02:联营；03:加盟；04:批销；05:托管
storeTypeName	String	false	店铺类型名称

（6）请求示例:

{
  "cityCode": "",
  "cityName": "",
  "customerCode": "",
  "mainGroupName": "",
  "marketingAreaCode": "",
  "marketingAreaName": "",
  "provinceCode": "",
  "provinceName": "",
  "storeCode": "",
  "storeName": "",
  "storeType": "",
  "storeTypeName": ""
}

（7）响应参数:

参数名称	数据类型	参数说明
code	Integer	0:成功 其他失败
data	Object	无返回数据
message	String	错误信息

（8）响应示例:

{
  "code": 0,
  "data": {},
  "message": ""
}

---

6、调拨订单接口

（1）接口地址:/openApi/bs/transferOrder

（2）请求方式:POST

（3）请求数据类型:application/json

（4）响应数据类型:application/json

（5）请求参数:

参数名称	数据类型	是否必须	参数说明
requestId	String	true	请求id,作为幂等性标识字段
dataList	List	false	调拨订单列表
└ dataList	List	true	明细行
└ qty	Integer	true	商品数量
└ skuCode	String	true	SKU编码
└ orderCreateTime	String	true	单据创建时间
└ orderCreator	String	true	单据创建人
└ transferInStoreCode	String	true	调拨入库门店编码
└ transferNo	String	true	调拨单号
└ transferOutStoreCode	String	true	调拨出库门店编码
└ transferOutTime	String	true	调拨出库日期

（6）请求示例:

{
  "dataList": [
    {
      "dataList": [
        {
          "qty": 0,
          "skuCode": ""
        }
      ],
      "orderCreateTime": "",
      "orderCreator": "",
      "transferInStoreCode": "",
      "transferNo": "",
      "transferOutStoreCode": "",
      "transferOutTime": ""
    }
  ],
  "requestId": ""
}

（7）响应参数:

参数名称	数据类型	参数说明
code	Integer	0:成功 其他失败
data	Object	返回数据
└ isSuccess	Boolean	是否成功
message	String	错误信息

（8）响应示例:

{
  "code": 0,
  "data": {
    "isSuccess": true
  },
  "message": ""
}

---

7、退仓订单接口

（1）接口地址:/openApi/bs/warehouseReturnOrder

（2）请求方式:POST

（3）请求数据类型:application/json

（4）响应数据类型:application/json

（5）请求参数:

参数名称	数据类型	是否必须	参数说明
requestId	String	true	请求id,作为幂等性标识字段
dataList	List	false	退仓订单列表
└ dataList	List	true	明细行
└ omsStockSn	String	true	OMS库存流水单号
└ qty	Integer	true	商品数量
└ skuCode	String	true	SKU编码
└ dispatchOrderNo	String	true	门店配货订单号
└ dispatchOrderType	Integer	true	配货订单类型
└ invSerialNo	String	true	库存流水单号
└ invTime	String	true	库存日期
└ offStoreCode	String	true	入库门店编码
└ omsInvSerialNo	String	true	OMS库存流水单号
└ orderCreateTime	String	true	单据创建时间
└ orderCreator	String	true	单据创建人

（6）请求示例:

{
  "dataList": [
    {
      "dataList": [
        {
          "omsStockSn": "",
          "qty": 0,
          "skuCode": ""
        }
      ],
      "dispatchOrderNo": "",
      "dispatchOrderType": 0,
      "invSerialNo": "",
      "invTime": "",
      "offStoreCode": "",
      "omsInvSerialNo": "",
      "orderCreateTime": "",
      "orderCreator": ""
    }
  ],
  "requestId": ""
}

（7）响应参数:

参数名称	数据类型	参数说明
code	Integer	0:成功 其他失败
data	Object	返回数据
└ isSuccess	Boolean	是否成功
message	String	错误信息

（8）响应示例:

{
  "code": 0,
  "data": {
    "isSuccess": true
  },
  "message": ""
}

---

8、批销订单

（1）接口地址:/openApi/bs/wholeSalesOrder

（2）请求方式:POST

（3）请求数据类型:application/json

（4）响应数据类型:application/json

（5）请求参数:

参数名称	数据类型	是否必须	参数说明
requestId	String	true	请求id,作为幂等性标识字段
dataList	List	true	批销订单数据行
└ consignTime	String	true	发货日期,格式:yyyy-MM-dd HH:mm:ss
└ dataList	List	true	批销订单明细行
└ offStoreFirstCategoryCode	String	true	门店一级分类编码
└ qty	Integer	true	发货数量
└ salesAmount	Number	true	销售金额
└ salesPrice	Number	true	商品单价
└ salesStandardAmount	Number	true	标准销售金额
└ skuCode	String	true	SKU编码
└ offStoreCode	String	true	门店编码
└ omsSalesOrderNo	String	true	OMS单号
└ orderCreateTime	String	true	单据创建时间,格式:yyyy-MM-dd HH:mm:ss
└ orderCreator	String	true	单据创建人
└ orderType	String	true	订单类型，receive:收款、back:退款
└ outOrderNo	String	true	出库单号
└ payTime	String	true	订单下单日期,格式:yyyy-MM-dd HH:mm:ss
└ salesOrderNo	String	false	销售订单号
└ totalAmount	Number	true	本次发货总金额
└ totalQty	Integer	true	本次发货总数量
└ verCashAmount	Number	true	现金核销金额
└ verSupplyAmount	Number	true	货补核销金额
└ warehouseCode	String	false	发货仓库

（6）请求示例:

{
  "dataList": [
    {
      "consignTime": "",
      "dataList": [
        {
          "offStoreFirstCategoryCode": "",
          "qty": 0,
          "salesAmount": 0,
          "salesPrice": 0,
          "salesStandardAmount": 0,
          "skuCode": ""
        }
      ],
      "offStoreCode": "",
      "omsSalesOrderNo": "",
      "orderCreateTime": "",
      "orderCreator": "",
      "orderType": "",
      "outOrderNo": "",
      "payTime": "",
      "salesOrderNo": "",
      "totalAmount": 0,
      "totalQty": 0,
      "verCashAmount": 0,
      "verSupplyAmount": 0,
      "warehouseCode": ""
    }
  ],
  "requestId": ""
}

（7）响应参数:

参数名称	数据类型	参数说明
code	Integer	0:成功 其他失败
data	Object	无返回数据
message	String	错误信息

（8）响应示例:

{
  "code": 0,
  "data": {},
  "message": ""
}