接口定义

参数名	字段值
服务地址[测试]	https://fbbc.wsmsd.cn/b2c-oms-server

1. 门店多规格商品管理

1.1 门店商品添加或编辑

POST /productShop/edit

接口描述

请求

参数名称	数据类型	默认值	必填	描述
accessId	string	lakala	Y	接入ID：服务方定义，发起方按接口填入
timestamp	string	1629955213000	Y	请求时间(UTC)毫秒,发起请求系统时间
sid	string	abc123	Y	交易流水号，请求方生成，建议32位UUID/snowflake
shopId	integer		Y	操作涉及门店ID
shopProductId	integer		N	商品id
productName	string		N	商品名称
firstLetters	string		Y	商品拼音码
shopCategoryId	string		N	商品分类id
unit	string		N	商品单位
productImage	string		N	商品图片
canSaleInMall	integer		N	是否商城售卖
isUpper	integer		N	商品上架状态
isWeigh	integer		N	是否称重商品
place	string		N	生产地点
tagSpec	string		N	价签规格
spec	array		N	规格信息
⇥specId	string		N	规格ID
⇥specCode	string		N	规格编码
⇥specName	string		N	规格名称
⇥mustSelect	integer		N	是否必选： 0 否， 1 是
⇥multiSelect	integer		N	是否可多选, 0 不行， 1 行
⇥showType	string		N	规格显示方式: NA，NUM
⇥specGroupId	string		N	规格分组ID
⇥specOptionList	array		N	产品规格选项集合
⇥⇥specOptionId	string		N	规格项ID
⇥⇥specId	string		N	规格ID
⇥⇥specCode	string		N	规格编码
⇥⇥specOptionCode	string		N	规格项编码
⇥⇥specOptionName	string		N	规格选项名称
⇥⇥refSaleMenuItemId	integer		N	针对餐饮场景菜品加料对应的产品ID，比如：面中加鸡蛋，西米露中增加芒果
⇥⇥refProductAmount	integer		N	是否引用商品售价：0 否， 1: 是
⇥⇥addonAmount	integer		N	针对餐饮场景加料或不同做法带来的额外费用
⇥⇥addonMemberAmount	integer		N	加料商品对应会员价，未设置时与addon_amount一致
⇥⇥isDefault	integer		N	是否默认：0-否，1-是
⇥⇥customDefault	integer		N	菜品级别是否默认：0-否，1-是
skuList	array		N	SKU列表信息
⇥skuId	array<integer>		N	SKU ID列表
⇥spec	string		N	多规格定义JSON
⇥price	string		N	售卖价
⇥memberPrice	string		N	会员价
⇥costPrice	string		N	预估成本
⇥outPrice	string		N	配货价
⇥inventorQuantity	integer		N	商品库存
⇥barcode	string		N	商品条码
⇥name	string		N	规格名
⇥supplierId	string		N	供货商编号
⇥canSaleInMall	integer		N	是否商城售卖
⇥type	integer		N	商品类型：0
⇥skuType	integer		N	SKU类型：10-常规69条码商品(默认) 20-自定义条码 99-无码,现金收支,账户充值 30-餐饮类附加费用
⇥extraBarcodeList	array<string>		N	产品拓展码列表
smallestAmount	string		N	起售份数
monthSalesVolume	integer		N	月销量
description	string		N	宣传标语
weigh	integer		N
commChainId	string		N

响应

参数名称	数据类型	默认值	必填	描述
_code	string	200	Y	响应码：200 成功；其他失败
_message	string	SUCCESS	Y	响应描述信息
timestamp	string	1629955213000	Y	响应时间(UTC)毫秒,发起请求系统时间
sid	string	abc123	Y	交易流水号，请求值原样返回
shopProductId	integer		N	商品id

1.2 门店商品详情

POST /productShop/detail

接口描述

请求

参数名称	数据类型	默认值	必填	描述
accessId	string	lakala	Y	接入ID：服务方定义，发起方按接口填入
timestamp	string	1629955213000	Y	请求时间(UTC)毫秒,发起请求系统时间
sid	string	abc123	Y	交易流水号，请求方生成，建议32位UUID/snowflake
shopId	integer		Y	操作涉及门店ID
shopProductId	integer		Y	商品ID
shopProductName	string		Y	商品名称
commChainId	string		N

响应

参数名称	数据类型	默认值	必填	描述
_code	string	200	Y	响应码：200 成功；其他失败
_message	string	SUCCESS	Y	响应描述信息
timestamp	string	1629955213000	Y	响应时间(UTC)毫秒,发起请求系统时间
sid	string	abc123	Y	交易流水号，请求值原样返回
data	object		N
⇥shopProductId	integer		N	商品ID
⇥productName	string		N	商品名称
⇥shopCategoryId	string		N	商品分类id
⇥firstCategoryId	integer		N
⇥secondCategoryId	integer		N
⇥thirdCategoryId	integer		N
⇥firstCategoryName	string		N
⇥secondCategoryName	string		N
⇥thirdCategoryName	string		N
⇥unit	string		N	商品单位
⇥productImage	string		N	商品图片
⇥canSaleInMall	integer		N	是否商城售卖
⇥isUpper	integer		N	商品状态
⇥isWeigh	integer		N	是否是称重商品
⇥smallestAmount	string		N	起售份数
⇥remark	string		N	备注
⇥salesMenuItemId	integer		N	报价单ID
⇥firstLetters	string		Y	商品拼音码
⇥place	string		N	生产地点
⇥tagSpec	string		N	价签规格
⇥spec	array		N	规格信息
⇥⇥specId	string		N	规格ID
⇥⇥specCode	string		N	规格编码
⇥⇥specName	string		N	规格名称
⇥⇥mustSelect	integer		N	是否必选： 0 否， 1 是
⇥⇥multiSelect	integer		N	是否可多选, 0 不行， 1 行
⇥⇥showType	string		N	规格显示方式: NA，NUM
⇥⇥specGroupId	string		N	规格分组ID
⇥⇥specOptionList	array		N	产品规格选项集合
⇥⇥⇥specOptionId	string		N	规格项ID
⇥⇥⇥specId	string		N	规格ID
⇥⇥⇥specCode	string		N	规格编码
⇥⇥⇥specOptionCode	string		N	规格项编码
⇥⇥⇥specOptionName	string		N	规格选项名称
⇥⇥⇥refSaleMenuItemId	integer		N	针对餐饮场景菜品加料对应的产品ID，比如：面中加鸡蛋，西米露中增加芒果
⇥⇥⇥refProductAmount	integer		N	是否引用商品售价：0 否， 1: 是
⇥⇥⇥addonAmount	integer		N	针对餐饮场景加料或不同做法带来的额外费用
⇥⇥⇥addonMemberAmount	integer		N	加料商品对应会员价，未设置时与addon_amount一致
⇥⇥⇥isDefault	integer		N	是否默认：0-否，1-是
⇥⇥⇥customDefault	integer		N	菜品级别是否默认：0-否，1-是
⇥skuList	array		N	SKU列表信息
⇥⇥skuId	array<integer>		N	SKU ID列表
⇥⇥spec	string		N	多规格定义JSON
⇥⇥price	string		N	售卖价
⇥⇥memberPrice	string		N	会员价
⇥⇥costPrice	string		N	预估成本
⇥⇥outPrice	string		N	配货价
⇥⇥inventorQuantity	integer		N	商品库存
⇥⇥barcode	string		N	商品条码
⇥⇥name	string		N	规格名
⇥⇥supplierId	string		N	供货商编号
⇥⇥canSaleInMall	integer		N	是否商城售卖
⇥⇥type	integer		N	商品类型：0
⇥⇥skuType	integer		N	SKU类型：10-常规69条码商品(默认) 20-自定义条码 99-无码,现金收支,账户充值 30-餐饮类附加费用
⇥⇥extraBarcodeList	array<string>		N	产品拓展码列表
⇥monthSalesVolume	integer		N	月销量
⇥description	string		N	宣传标语
⇥weigh	integer		N

1.3 门店商品删除

POST /productShop/delete

接口描述

请求

参数名称	数据类型	默认值	必填	描述
accessId	string	lakala	Y	接入ID：服务方定义，发起方按接口填入
timestamp	string	1629955213000	Y	请求时间(UTC)毫秒,发起请求系统时间
sid	string	abc123	Y	交易流水号，请求方生成，建议32位UUID/snowflake
shopId	integer		Y	操作涉及门店ID
shopProductId	integer		Y	商品ID
commChainId	string		N

响应

参数名称	数据类型	默认值	必填	描述
_code	string	200	Y	响应码：200 成功；其他失败
_message	string	SUCCESS	Y	响应描述信息
timestamp	string	1629955213000	Y	响应时间(UTC)毫秒,发起请求系统时间
sid	string	abc123	Y	交易流水号，请求值原样返回

1.4 根据条码查询商品

POST /productShop/barcodeQuery

接口描述

请求

参数名称	数据类型	默认值	必填	描述
accessId	string	lakala	Y	接入ID：服务方定义，发起方按接口填入
timestamp	string	1629955213000	Y	请求时间(UTC)毫秒,发起请求系统时间
sid	string	abc123	Y	交易流水号，请求方生成，建议32位UUID/snowflake
shopId	integer		Y	门店ID
shopIds	array<integer>		N	门店IDList
barcode	string		N	商品条码
saleMenuItemId	integer		N	销售报价单记录ID
excludeNotSaleable	integer		N	排出不可售卖产品

响应

参数名称	数据类型	默认值	必填	描述
_code	string	200	Y	响应码：200 成功；其他失败
_message	string	SUCCESS	Y	响应描述信息
timestamp	string	1629955213000	Y	响应时间(UTC)毫秒,发起请求系统时间
sid	string	abc123	Y	交易流水号，请求值原样返回
saleProduct	array		Y	销售商品
⇥shopProductId	string		N	门店商品ID
⇥productId	integer		N	商品ID
⇥skuId	integer		N	商品SKU
⇥productName	string		N	商品名称
⇥firstLetters	string		N	商品拼音码
⇥barcode	string		N	商品条码
⇥saleMenuItemId	integer		N	销售报价单记录ID
⇥costPrice	integer		N	商品成本(分)
⇥unitPrice	integer		N	商品售价(分)
⇥hasSell	integer		N	是否在云掌柜可售 0:不可售 1:可售
⇥tagWeighRatioLabel	string		N
⇥inventorQuantity	integer		N	商品库存
⇥unit	string		N	商品单位
⇥firstCategoryId	integer		N	自定义：一级商品类目id
⇥secondCategoryId	integer		N	自定义：二级商品类目id
⇥thirdCategoryId	integer		N	自定义：三级商品类目id
⇥primaryCategoryId	string		N	一级商品类目id
⇥primaryCategoryCode	string		N	一级商品类目
⇥secondaryCategoryId	string		N	二级商品类目id
⇥secondaryCategoryCode	string		N	二级商品类目
⇥memberPrice	integer		N	会员价格
⇥outPrice	integer		N	配货价
⇥memberReward	integer		N	参与会员积分
⇥weighing	integer		N	是否称重商品
⇥tagWeighRatio	integer		N	重量单位
⇥inventoryMax	integer		N	库存上限
⇥inventoryMin	integer		N	库存下限
⇥minSaleQuantity	integer		N	起售量
⇥maxSaleQuantity	integer		N	限购量
⇥status	integer		N	商品状态
⇥productImage	string		N	商品图片链接
⇥firstCategoryName	string		N	自定义：商品一级类目名称
⇥secondCategoryName	string		N	自定义：商品二级类目名称
⇥thirdCategoryName	string		N	自定义：商品三级类目名称
⇥primaryCategoryName	string		N	一级商品类目名称
⇥secondaryCategoryName	string		N	二级商品类目名称
⇥supplierId	string		N	进货商ID
⇥supplierName	string		N	供货商名称
⇥iconUri	string		N
⇥serializedSpecOptionIds	string		N	规格
⇥serializedSpecOptionNames	string		N	规格名称
⇥canSaleInMall	integer		N	是否商城售卖
⇥mergeSkuId	array<integer>		N	合并SKU ID列表
⇥updateExtraBarcodeFlag	boolean		N	是否编辑拓展码
⇥extraBarcodeList	array<string>		N	产品拓展码列表
⇥extraBarcodeStr	string		N	产品拓展码列表,字符串
⇥expirationDay	string	1	N	保质期天数
⇥place	string		N	生产地点
⇥tagSpec	string		N	价签规格
⇥type	integer		N	商品类型：0
⇥skuType	integer		N	SKU类型：10-常规69条码商品(默认) 20-自定义条码 99-无码,现金收支,账户充值 30-餐饮类附加费用
salesMenuItemList	array		N	报价单明细列表
⇥shopProductId	string		N	门店商品ID
⇥productId	integer		N	商品ID
⇥skuId	integer		N	商品SKU
⇥productName	string		N	商品名称
⇥firstLetters	string		N	商品拼音码
⇥barcode	string		N	商品条码
⇥saleMenuItemId	integer		N	销售报价单记录ID
⇥costPrice	integer		N	商品成本(分)
⇥unitPrice	integer		N	商品售价(分)
⇥hasSell	integer		N	是否在云掌柜可售 0:不可售 1:可售
⇥tagWeighRatioLabel	string		N
⇥inventorQuantity	integer		N	商品库存
⇥unit	string		N	商品单位
⇥firstCategoryId	integer		N	自定义：一级商品类目id
⇥secondCategoryId	integer		N	自定义：二级商品类目id
⇥thirdCategoryId	integer		N	自定义：三级商品类目id
⇥primaryCategoryId	string		N	一级商品类目id
⇥primaryCategoryCode	string		N	一级商品类目
⇥secondaryCategoryId	string		N	二级商品类目id
⇥secondaryCategoryCode	string		N	二级商品类目
⇥memberPrice	integer		N	会员价格
⇥outPrice	integer		N	配货价
⇥memberReward	integer		N	参与会员积分
⇥weighing	integer		N	是否称重商品
⇥tagWeighRatio	integer		N	重量单位
⇥inventoryMax	integer		N	库存上限
⇥inventoryMin	integer		N	库存下限
⇥minSaleQuantity	integer		N	起售量
⇥maxSaleQuantity	integer		N	限购量
⇥status	integer		N	商品状态
⇥productImage	string		N	商品图片链接
⇥firstCategoryName	string		N	自定义：商品一级类目名称
⇥secondCategoryName	string		N	自定义：商品二级类目名称
⇥thirdCategoryName	string		N	自定义：商品三级类目名称
⇥primaryCategoryName	string		N	一级商品类目名称
⇥secondaryCategoryName	string		N	二级商品类目名称
⇥supplierId	string		N	进货商ID
⇥supplierName	string		N	供货商名称
⇥iconUri	string		N
⇥serializedSpecOptionIds	string		N	规格
⇥serializedSpecOptionNames	string		N	规格名称
⇥canSaleInMall	integer		N	是否商城售卖
⇥mergeSkuId	array<integer>		N	合并SKU ID列表
⇥updateExtraBarcodeFlag	boolean		N	是否编辑拓展码
⇥extraBarcodeList	array<string>		N	产品拓展码列表
⇥extraBarcodeStr	string		N	产品拓展码列表,字符串
⇥expirationDay	string	1	N	保质期天数
⇥place	string		N	生产地点
⇥tagSpec	string		N	价签规格
⇥type	integer		N	商品类型：0
⇥skuType	integer		N	SKU类型：10-常规69条码商品(默认) 20-自定义条码 99-无码,现金收支,账户充值 30-餐饮类附加费用
category	object		N
⇥shouldNotifyKitchen	integer		N	是否通知后厨
⇥shopCategoryId	integer		N
⇥shopId	integer		N
⇥categoryId	integer		N
⇥level	integer		N
⇥displayOrder	integer		N
⇥categorySign	integer		N
⇥parentShopCategoryId	integer		N
⇥createStaffId	string		N
⇥deleteStaffId	string		N
⇥createTime	string		N
⇥deleteTime	string		N
⇥deleted	integer		N
⇥name	string		N
⇥updateTime	string		N
⇥updateStaffId	string		N
⇥categoryIconUri	string		N
⇥xlFlag	integer		N
⇥taxRate	string		N	税率
⇥kitchenId	string		N	厨房/档口id
⇥taxRateCode	string		N	税率代码目录
⇥firstCategoryId	integer		N
⇥secondCategoryId	integer		N
⇥thirdCategoryId	integer		N
⇥preKitchen	integer		N	通知厨房设置是否按分类优先
⇥categoryCode	string		N	分类编码
⇥chainShopCategoryId	integer		N
⇥searchFlag	boolean		N
comparisonPrice	object		N
⇥pcProductId	string		N	商品信息ID
⇥barcode	string		N	商品条码
⇥title	string		N	商品名称
⇥category	string		N	商品类目
⇥specification	string		N	规格
⇥unit	string		N	单位
⇥weighing	string		N	是否称重商品
⇥province	integer		N	省份
⇥city	integer		N	市州
⇥district	integer		N	区县
⇥businessAreas	string		N	所在商圈信息
⇥businessAreaType	string		N	商圈种类：10-CBD，20-集市，31-生活区_高档，32-生活区-中档，33-生活区-低档，40-景区
⇥originalPriceMin	integer		N	商品原价_最低
⇥originalPriceMax	integer		N	商品原价_最高
⇥originalPriceMid	integer		N	商品原价_中位
⇥originalPriceAvg	integer		N	商品原价_平均
⇥actualPriceMin	integer		N	商品定价_最低
⇥actualPriceMax	integer		N	商品定价_最高
⇥actualPriceMid	integer		N	商品定价_中位
⇥actualPriceAvg	integer		N	商品定价_平均
⇥suggestPrice	integer		N	商品推荐价
⇥suggestPercent	number		N	商品推荐价使用推荐度
⇥analyTime	string		N	时间
⇥status	integer		N	数据状态：1-有效，0-无效

1.5 新增/编辑产品规格

POST /product/spec/save

接口描述

新增/编辑产品规格

请求

参数名称	数据类型	默认值	必填	描述
accessId	string	lakala	Y	接入ID：服务方定义，发起方按接口填入
timestamp	string	1629955213000	Y	请求时间(UTC)毫秒,发起请求系统时间
sid	string	abc123	Y	交易流水号，请求方生成，建议32位UUID/snowflake
shopId	integer		Y	操作涉及门店ID
specId	string		N	规格ID，编辑时必填
specCode	string		N	规格编码
specName	string		Y	规格名称
displayOrder	integer		N	显示顺序
mustSelect	integer		Y	是否必选： 0 否， 1 是
multiSelect	integer		Y	是否可多选, 0 不行， 1 行
showType	string		Y	规格显示方式: NA，NUM
specGroupId	string		Y	规格分组ID
commChainId	string		N

响应

参数名称	数据类型	默认值	必填	描述
_code	string	200	Y	响应码：200 成功；其他失败
_message	string	SUCCESS	Y	响应描述信息
timestamp	string	1629955213000	Y	响应时间(UTC)毫秒,发起请求系统时间
sid	string	abc123	Y	交易流水号，请求值原样返回

1.5 新增/编辑产品规格值

POST /product/spec/option/save

接口描述

新增/编辑产品规格值

请求

参数名称	数据类型	默认值	必填	描述
accessId	string	lakala	Y	接入ID：服务方定义，发起方按接口填入
timestamp	string	1629955213000	Y	请求时间(UTC)毫秒,发起请求系统时间
sid	string	abc123	Y	交易流水号，请求方生成，建议32位UUID/snowflake
shopId	integer		Y	操作涉及门店ID
specOptionId	string		N	规格项ID，编辑时必填
specGroupId	string		Y	规格分组ID
specId	string		Y	规格ID
specOptionCode	string		N	规格项编码
specOptionName	string		Y	规格选项名称
displayOrder	integer		N	显示顺序
refSaleMenuItemId	integer		N	针对餐饮场景菜品加料对应的产品ID，比如：面中加鸡蛋，西米露中增加芒果
refProductAmount	integer		N	是否引用商品售价：0 否， 1: 是
addonAmount	integer		N	针对餐饮场景加料或不同做法带来的额外费用
addonMemberAmount	integer		N	加料商品对应会员价，未设置时与addon_amount一致
isDefault	integer		N	是否默认：0-否，1-是
commChainId	string		N

响应

参数名称	数据类型	默认值	必填	描述
_code	string	200	Y	响应码：200 成功；其他失败
_message	string	SUCCESS	Y	响应描述信息
timestamp	string	1629955213000	Y	响应时间(UTC)毫秒,发起请求系统时间
sid	string	abc123	Y	交易流水号，请求值原样返回

1.6 查询产品规格分组及规格项（如果不存在规格组，会自动创建组）

POST /product/spec/group/query/full

接口描述

查询产品规格分组及规格项（如果不存在规格组，会自动创建组）

请求

参数名称	数据类型	默认值	必填	描述
accessId	string	lakala	Y	接入ID：服务方定义，发起方按接口填入
timestamp	string	1629955213000	Y	请求时间(UTC)毫秒,发起请求系统时间
sid	string	abc123	Y	交易流水号，请求方生成，建议32位UUID/snowflake
shopId	integer		Y	操作涉及门店ID
specGroupId	string		N	规格分组ID
specGroupType	string		N	规格分组类型：normal规格，addon加料，cook做法
specGroupName	string		N	规格分组名称
template	boolean		N	是否是模板分组
specId	string		N	规格ID
specName	string		N	规格名称
specOptionName	string		N	规格选项名称
commChainId	string		N

响应

参数名称	数据类型	默认值	必填	描述
_code	string	200	Y	响应码：200 成功；其他失败
_message	string	SUCCESS	Y	响应描述信息
timestamp	string	1629955213000	Y	响应时间(UTC)毫秒,发起请求系统时间
sid	string	abc123	Y	交易流水号，请求值原样返回
specGroupId	string		N	产品规格分组ID
set	array		N	产品规格及规格选项集合
⇥specId	string		N	规格ID
⇥specCode	string		N	规格编码
⇥specName	string		N	规格名称
⇥mustSelect	integer		N	是否必选： 0 否， 1 是
⇥multiSelect	integer		N	是否可多选, 0 不行， 1 行
⇥showType	string		N	规格显示方式: NA，NUM
⇥specGroupId	string		N	规格分组ID
⇥specOptionList	array		N	产品规格选项集合
⇥⇥specOptionId	string		N	规格项ID
⇥⇥specId	string		N	规格ID
⇥⇥specCode	string		N	规格编码
⇥⇥specOptionCode	string		N	规格项编码
⇥⇥specOptionName	string		N	规格选项名称
⇥⇥refSaleMenuItemId	integer		N	针对餐饮场景菜品加料对应的产品ID，比如：面中加鸡蛋，西米露中增加芒果
⇥⇥refProductAmount	integer		N	是否引用商品售价：0 否， 1: 是
⇥⇥addonAmount	integer		N	针对餐饮场景加料或不同做法带来的额外费用
⇥⇥addonMemberAmount	integer		N	加料商品对应会员价，未设置时与addon_amount一致
⇥⇥isDefault	integer		N	是否默认：0-否，1-是
⇥⇥customDefault	integer		N	菜品级别是否默认：0-否，1-是

1.7 删除规格组、规格、规格值

POST /product/spec/group/delete

接口描述

删除规格组、规格、规格值

请求

参数名称	数据类型	默认值	必填	描述
accessId	string	lakala	Y	接入ID：服务方定义，发起方按接口填入
timestamp	string	1629955213000	Y	请求时间(UTC)毫秒,发起请求系统时间
sid	string	abc123	Y	交易流水号，请求方生成，建议32位UUID/snowflake
shopId	integer		Y	操作涉及门店ID
specGroupId	array<string>		N	规格分组ID
specId	array<string>		N	规格ID
specOptionId	array<string>		N	规格选项ID
commChainId	string		N

响应

参数名称	数据类型	默认值	必填	描述
_code	string	200	Y	响应码：200 成功；其他失败
_message	string	SUCCESS	Y	响应描述信息
timestamp	string	1629955213000	Y	响应时间(UTC)毫秒,发起请求系统时间
sid	string	abc123	Y	交易流水号，请求值原样返回

1.8 pc报价单分页列表

POST /salesMenuItem/page

接口描述

请求

参数名称	数据类型	默认值	必填	描述
accessId	string	lakala	Y	接入ID：服务方定义，发起方按接口填入
timestamp	string	1629955213000	Y	请求时间(UTC)毫秒,发起请求系统时间
sid	string	abc123	Y	交易流水号，请求方生成，建议32位UUID/snowflake
organizationId	string		Y	操作涉及总部ID
companyId	string		Y	操作涉及分公司ID
marketId	string		Y	操作涉及市场ID
marketIds	array<string>		Y	操作涉及市场ID
chainId	string		Y	总部视角的连锁ID
shopChainId	string		Y	分店视角的连锁ID
shopId	integer		Y	操作涉及门店ID
shopIds	array<integer>		Y	操作涉及门店列表
branchShopId	integer		N
branchShopIds	array<integer>		N
selectBranch	boolean		N	选择分店
myLevel	string		Y	当前登录者组织级别：1-总部，2-分公司，3-市场
myOrgId	string		Y	当前登录者组织ID
orgShopId	integer		N	当前登录组织上层组织ID
shopLevel	string		N	运营端跳转过来的组织级别：1-总部，2-分公司，3-市场
pageSize	integer		Y	页长
pageNumber	integer		Y	第几页，比如此次查第一页
condition	string		N
status	integer		N
mallStatus	integer		N
type	array<integer>		N
weighing	integer		N
shopCategoryId	integer		N
shopCategoryIdList	array<integer>		N
smiIds	array<integer>		N
salesMenuItemId	integer		N
productTypeList	array<integer>		N
recentModifyPriceOrStock	string		N	最近改价/有无库存
repeatYesOrNo	boolean		N	条码重复/不重复
headAllocationYesOrNo	boolean		N	是否为总部分配商品
recharge	boolean		N
nonDiningPackage	boolean		N
salesMenuItemIdExcludes	array<integer>		N
labelLocations	array		N	用于使用标签过滤
⇥labelType	integer		N	标签分类： 11: 总部给门店打标签； 21: 门店对产品打标签； 22: 门店对客户打标签,非必传，当需要确定类型时传入
⇥labelKey	string		N	标签组的KEY
⇥value	string		N	标签值的键
⇥name	string		N	标签值的名称
adaptorCode	integer		N	查询策略
idList	array<string>		N	导出时用的唯一id集
orderColumn	string		N	排序列名:priceFen-零售价,creationTime -创建时间,updateTime -修改时间
sortOrder	string		N	排序方式:升序:asc,降序:desc
extraFilter	string		N	额外的过滤条件：如：排除此供应商的商品
start	integer		N
commChainId	string		N

响应

参数名称	数据类型	默认值	必填	描述
_code	string	200	Y	响应码：200 成功；其他失败
_message	string	SUCCESS	Y	响应描述信息
timestamp	string	1629955213000	Y	响应时间(UTC)毫秒,发起请求系统时间
sid	string	abc123	Y	交易流水号，请求值原样返回
paging	object		N
⇥pageIndex	integer		N	当前页码
⇥pageSize	integer		N	当前页码
⇥total	integer		N	总量
set	array		N	集合
⇥id	string		N	主键id
⇥salesMenuItemId	integer		N	报价单id
⇥shopId	integer		N	售卖门店ID
⇥shopName	string		N	售卖门店名称
⇥consignmentShopId	integer		N	代销货主门店ID，不为空且不等于shopId时，此商品为代销商品
⇥productId	integer		N	产品id
⇥productName	string		N	产品名称
⇥specOptionName	string		N	规格选项名称
⇥productImage	string		N	产品图片
⇥skuId	string		N	skuId
⇥title	string		N	商品名称
⇥barcode	string		N	条码
⇥type	integer		N	0
⇥status	integer		N	是否上架：0下架，1上架
⇥mallStatus	integer		N	是否在商城中上架：0下架，1上架
⇥statusStr	string		N	上下架字符串
⇥originalPrice	string		N	参考成本价-元
⇥price	string		N	售价-元
⇥memberPrice	string		N	会员价-元
⇥originalPriceFen	string		N	参考成本价-分
⇥priceFen	string		N	售价-分
⇥memberPriceFen	string		N	会员价-分
⇥outPrice	string		N	配货价-分
⇥unit	string		N	单位
⇥inventoryQuantity	integer		N	库存
⇥wmsStockId	string		N	库存账户id
⇥weighing	integer		N	0标准商品，1称重商品
⇥taxPercentStr	string		N	税率字符串
⇥taxPercent	integer		N	税率
⇥taxCode	string		N	税收编码
⇥shortTaxName	string		N	税收分类简称
⇥isTax	integer		N	是否可以开发票
⇥shopCategoryName	string		N	所属分类
⇥categoryId	integer		N	所属分类Id,同shopCategoryName
⇥categoryName	string		N	所属分类,同shopCategoryName
⇥iconUri	string		N	图标
⇥systemInStockNumber	integer		N	系统入库数量
⇥totalCostPrice	integer		N	库存总成本
⇥sourceType	integer		N	数据来源：1：总部分配
⇥quantity	integer		N	数量
⇥extraBarcodeList	array<string>		N	产品拓展码列表
⇥labelList	array		N	标签信息
⇥⇥labelKey	string		N	标签组KEY
⇥⇥labelName	string		N	标签组名称
⇥⇥values	array		N	标签列表
⇥⇥⇥value	string		N	标签值
⇥⇥⇥name	string		N	标签值名称
⇥serializedSpecOptionIds	string		N	规格项
⇥creationTime	string		N
⇥updateTime	string		N
⇥iotDeviceId	integer		N	设备主键id
⇥serial	string		N	设备序列号(SN号)
⇥assetNo	string		N	设备固定资产编号
⇥seqId	string		N	前端使用的唯一ID
⇥statusLabel	string		N
⇥sourceTypeLabel	string		N	数据来源标签
⇥mallStatusLabel	string		N	是否在商城中上架标签：0下架，1上架
⇥typeLabel	string		N

2. 店铺分类管理

2.1 店铺分类树

POST /shop/category/api/tree

接口描述

请求

参数名称	数据类型	默认值	必填	描述
accessId	string	lakala	Y	接入ID：服务方定义，发起方按接口填入
timestamp	string	1629955213000	Y	请求时间(UTC)毫秒,发起请求系统时间
sid	string	abc123	Y	交易流水号，请求方生成，建议32位UUID/snowflake
shopId	integer		Y	操作涉及门店ID
branchShopId	integer		N
branchShopIds	array<integer>		N
selectBranch	boolean		N	选择分店
shopCategoryId	integer		N	当前分类id，用于移动分类
isFilterXlFlag	integer		N	是否过滤加料专区：0否，1是
categoryCode	string		N	分类编码
conditions	string		N	分类名称模糊搜索
commChainId	string		N

响应

参数名称	数据类型	默认值	必填	描述
_code	string	200	Y	响应码：200 成功；其他失败
_message	string	SUCCESS	Y	响应描述信息
timestamp	string	1629955213000	Y	响应时间(UTC)毫秒,发起请求系统时间
sid	string	abc123	Y	交易流水号，请求值原样返回
tree	array		N	店铺分类树
⇥shopCategoryId	string		N	店铺自定义分类id
⇥parentShopCategoryId	string		N	父分类id
⇥level	integer		N	级别
⇥name	string		N	名称
⇥xlFlag	integer		N	是否是加料专区
⇥displayOrder	integer		N	分类排序
⇥taxRate	string		N	税率
⇥taxRateCode	string		N	税率代码目录
⇥categoryIconUri	string		N	图标
⇥categorySign	integer		N	是否常用标记:0:关闭 1:开启
⇥categoryCode	string		N	分类编码

2.2 店铺创建、修改分类

POST /shop/category/api/create

接口描述

请求

参数名称	数据类型	默认值	必填	描述
accessId	string	lakala	Y	接入ID：服务方定义，发起方按接口填入
timestamp	string	1629955213000	Y	请求时间(UTC)毫秒,发起请求系统时间
sid	string	abc123	Y	交易流水号，请求方生成，建议32位UUID/snowflake
shopId	integer		Y	操作涉及门店ID
branchShopId	integer		N
branchShopIds	array<integer>		N
selectBranch	boolean		N	选择分店
shopCategoryId	integer		N	店铺分类id,修改分类必传
name	string		N	名称，新增与修改必传
level	integer		Y	层级：1/2/3，新增必传
parentShopCategoryId	integer		N	父级id，新增必传
taxRate	string		N	税率
taxRateCode	string		N	税率代码目录
categoryIconUri	string		N	图标
categoryCode	string		N	分类编码
kitchenId	string		N	厨房/档口id
shouldNotifyKitchen	integer		N	是否通知后厨
preKitchen	integer		N	通知厨房设置是否按分类优先
commChainId	string		N

响应

参数名称	数据类型	默认值	必填	描述
_code	string	200	Y	响应码：200 成功；其他失败
_message	string	SUCCESS	Y	响应描述信息
timestamp	string	1629955213000	Y	响应时间(UTC)毫秒,发起请求系统时间
sid	string	abc123	Y	交易流水号，请求值原样返回

2.3 删除店铺分类

POST /shop/category/api/del

接口描述

请求

参数名称	数据类型	默认值	必填	描述
accessId	string	lakala	Y	接入ID：服务方定义，发起方按接口填入
timestamp	string	1629955213000	Y	请求时间(UTC)毫秒,发起请求系统时间
sid	string	abc123	Y	交易流水号，请求方生成，建议32位UUID/snowflake
shopId	integer		Y	操作涉及门店ID
branchShopId	integer		N
branchShopIds	array<integer>		N
selectBranch	boolean		N	选择分店
shopCategoryId	integer		Y	店铺分类Id
commChainId	string		N

响应

参数名称	数据类型	默认值	必填	描述
_code	string	200	Y	响应码：200 成功；其他失败
_message	string	SUCCESS	Y	响应描述信息
timestamp	string	1629955213000	Y	响应时间(UTC)毫秒,发起请求系统时间
sid	string	abc123	Y	交易流水号，请求值原样返回

3.盘点单

3.1盘库（明细Id为空则需要先加入入库单）

POST /inventoryOrder/inventory

接口描述

请求

参数名称	数据类型	默认值	必填	描述
accessId	string	lakala	Y	接入ID：服务方定义，发起方按接口填入
timestamp	string	1629955213000	Y	请求时间(UTC)毫秒,发起请求系统时间
sid	string	abc123	Y	交易流水号，请求方生成，建议32位UUID/snowflake
organizationId	string		Y	操作涉及总部ID
companyId	string		Y	操作涉及分公司ID
marketId	string		Y	操作涉及市场ID
marketIds	array<string>		Y	操作涉及市场ID
chainId	string		Y	总部视角的连锁ID
shopChainId	string		Y	分店视角的连锁ID
shopId	int64		Y	操作涉及门店ID
shopIds	array<integer>		Y	操作涉及门店列表
checkId	string		N	盘点单Id
items	array		N	盘库明细
⇥checkItemId	string		N	按商品盘点时必传
⇥checkId	string		N
⇥shopId	int64		N
⇥productId	int32		N
⇥salesMenuItemId	int64		Y	报价单ID
⇥materialId	int64		N	原材料ID
⇥iotDeviceId	int64		N	设备id
⇥weighing	int32		Y	是否称重商品（称重商品主单位为KG，不可修改）
⇥title	string		N	商品名称
⇥stockQuantity	int32		N	系统库存，称重为g
⇥checkStockQuantity	int32		Y	盘点数量,称重为g
⇥mergeCheckStockQuantity	int32		Y	共享盘点合并盘点数量
⇥costPrice	int64		Y	商品成本价,分
⇥checkFlag	string		N	盘点结果:盘亏:-1;账实相等:0;盘盈:1
⇥supplierId	string		N	盘盈时供应商ID
⇥varianceQuantity	int32		N	差异数量
⇥skuId	int64		N	商品SKU
⇥barcode	string		N	商品条码
⇥checkStatus	string		N	状态：COMPLETED-已盘，PENDING-待处理
⇥createTime	string		N	创建时间
⇥updateTime	string		N	更新时间
⇥createUser	string		N	创建人,共享盘点时，最后确认时必传
⇥updateUser	string		N	更新人
⇥deleted	int32		N
shouldCreateOrder	boolean		N	是否要创建盘点单
warePositionId	int64		N	库位Id
checkMethod	int32		N	盘点方式：0:正常盘点，1：一键盘0, 2:整单盘点
checkItemStockQuantity	boolean		N	是否校验商品现有库存和传入库存，默认是，用于控制不需要校验的情况，如导入盘点时
commChainId	string		N

响应

参数名称	数据类型	默认值	必填	描述
_code	string	200	Y	响应码：200 成功；其他失败
_message	string	SUCCESS	Y	响应描述信息
timestamp	string	1629955213000	Y	响应时间(UTC)毫秒,发起请求系统时间
sid	string	abc123	Y	交易流水号，请求值原样返回
checkId	string		N	盘点单Id,新增的时候才返

接口定义 ​

1. 门店多规格商品管理 ​

1.1 门店商品添加或编辑 ​

接口描述 ​

请求 ​

响应 ​

1.2 门店商品详情 ​

接口描述 ​

请求 ​

响应 ​

1.3 门店商品删除 ​

接口描述 ​

请求 ​

响应 ​

1.4 根据条码查询商品 ​

接口描述 ​

请求 ​

响应 ​

1.5 新增/编辑产品规格 ​

接口描述 ​

请求 ​

响应 ​

1.5 新增/编辑产品规格值 ​

接口描述 ​

请求 ​

响应 ​

1.6 查询产品规格分组及规格项（如果不存在规格组，会自动创建组） ​

接口描述 ​

请求 ​

响应 ​

1.7 删除规格组、规格、规格值 ​

接口描述 ​

请求 ​

响应 ​

1.8 pc报价单分页列表 ​

接口描述 ​

请求 ​

响应 ​

2. 店铺分类管理 ​

2.1 店铺分类树 ​

接口描述 ​

请求 ​

响应 ​

2.2 店铺创建、修改分类 ​

接口描述 ​

请求 ​

响应 ​

2.3 删除店铺分类 ​

接口描述 ​

请求 ​

响应 ​

3.盘点单 ​

3.1盘库（明细Id为空则需要先加入入库单） ​

接口描述 ​

请求 ​

响应 ​

接口定义

1. 门店多规格商品管理

1.1 门店商品添加或编辑

接口描述

请求

响应

1.2 门店商品详情

接口描述

请求

响应

1.3 门店商品删除

接口描述

请求

响应

1.4 根据条码查询商品

接口描述

请求

响应

1.5 新增/编辑产品规格

接口描述

请求

响应

1.5 新增/编辑产品规格值

接口描述

请求

响应

1.6 查询产品规格分组及规格项（如果不存在规格组，会自动创建组）

接口描述

请求

响应

1.7 删除规格组、规格、规格值

接口描述

请求

响应

1.8 pc报价单分页列表

接口描述

请求

响应

2. 店铺分类管理

2.1 店铺分类树

接口描述

请求

响应

2.2 店铺创建、修改分类

接口描述

请求

响应

2.3 删除店铺分类

接口描述

请求

响应

3.盘点单

3.1盘库（明细Id为空则需要先加入入库单）

接口描述

请求

响应