Merchandise接口
merchandise接口
/category1/get 一级分类操作接口
查询一级分类
Method: GET
请求:
id O str 分类id，支持in，gt(e)，lt(e)，regex查询
name O string 分类名，支持in，gt(e)，lt(e)，regex查询
group_id O group ID，支持in，gt(e)，lt(e)，regex查询
status O 状态值，1：删除，2：正常
projection O list 需要返回的字段列表
sort O dict 排序
响应:
code M int 0为成功，其它为失败
msg M string 错误提示信息
data M list 返回的数据列表
[{
'id' M string 分类ID
'name' M string 分类名称
'group_id' M int 所属group
'icon' M int 图标ID
}]
pagination O dict 分页信息
{
count: 9638 M int 总条数
limit: 200 M int 每页的条数
offset: 0 M int 起始的偏移量
}
/category1/create 新建一级分类
Method: POST
请求:
name M string 分类名称
group_id M int 所属group
icon M int 图标ID
sort_id O int 排序ID
响应:
code M int 0为成功，其它为失败
msg M string 错误提示信息
data M string 返回创建的一级分类ID
/category1/update 修改一级分类
Method: POST
请求:
id M string 一级分类ID
group_id O int 所属group
name O string 分类名称
icon O int 图标ID
sort_id O int 排序ID
响应:
code M int 0为成功，其它为失败
msg M string 错误提示信息
/category1/delete 删除一级分类
Method: POST
请求:
id M string 一级分类ID
响应:
code M int 0为成功，其它为失败
msg M string 错误提示信息
/category1/icon 获取分类图标
Method: GET
请求:
无
响应:
code M int 0为成功，其它为失败
msg M string 错误提示信息
data M list 返回的图标信息
[{
'id' M int 图标ID
'url' M string 图标文件url
}]
/category2/get 二级分类操作接口
查询二级分类
Method: GET
请求:
id O string 分类id group ID，支持in，gt(e)，lt(e)，regex查询
upstream_id O string 上级ID，group ID，支持in，gt(e)，lt(e)，regex查询
name O string 分类名，id O string 分类id group ID，支持in，gt(e)，lt(e)，regex查询
group_id O int group ID，id O string 分类id group ID，支持in，gt(e)，lt(e)，regex查询
status O int 状态值，1：删除，2：正常
projection O list 需要返回的字段列表
sort O dict 排序
skip O int 起始位置
limit O int 返回数量
响应:
code M int 0为成功，其它为失败
msg M string 错误提示信息
data M list 返回的数据列表
[{
'id' M string 分类ID
'name' M string 分类名称
'group_id' M int 所属group
'upstream_id' M string 一级分类ID
}]
pagination O dict 分页信息
{
count: 9638 M int 总条数
limit: 200 M int 每页的条数
offset: 0 M int 起始的偏移量
}
/category2/tree 查询二级分类树
Method: GET
请求:
group_id M int group ID
响应:
code M int 0为成功，其它为失败
msg M string 错误提示信息
data M list 返回的数据列表
{
'A106':{
'id': 'A106', M string 分类ID
'icon': 1, M int
'status': 2, M int 状态，1：删除 2：正常
'group_id': 1, M int saas group id
'name': '南北干货', M string 分类名
'origin_id': 'A106' M
'sub':{
'B119': {
upstream_id: "A103" M string 上级ID
id: "B119"
status: 2
group_id: 1
name: "鲜蛋"
origin_id: "B119"
}
}
}
}
/category2/branch 查询二级分类分支
Method: GET
请求:
ids M list 二级id列表
响应:
code M int 0为成功，其它为失败
msg M string 错误提示信息
data M list 返回的数据列表
[{
upstream_id: "A101" M string 上级分类ID
upstream_name: "蔬菜" M string 上级分类名
status: 2 M int 状态，1：删除 2：正常
id: "B101" M string 分类ID
group_id: 1 M int
name: "叶菜类"
origin_id: "B101"
}]
/category2/create 新建二级分类
Method: POST
请求:
name M string 分类名称
group_id M int 所属group
upstream_id M string 一级分类ID
sort_id O int 排序ID
响应:
code M int 0为成功，其它为失败
msg M string 错误提示信息
data M string 返回创建的二级分类ID
/category2/update 修改二级分类
Method: POST
请求:
id M string 二级分类ID
group_id O int 所属group
name O string 分类名称
upstream_id M string 一级分类ID
sort_id O int 排序ID
响应:
code M int 0为成功，其它为失败
msg M string 错误提示信息
/category2/delete 删除二级分类
Method: POST
请求:
id M string 二级分类ID
响应:
code M int 0为成功，其它为失败
msg M string 错误提示信息
品类操作接口
/pinlei/get 查询品类
Method: GET
请求:
id O string 分类id，支持in，gt(e)，lt(e)，regex查询
upstream_id O string 上级ID，支持in，gt(e)，lt(e)，regex查询
name O string 分类名，支持in，gt(e)，lt(e)，regex查询
group_id O int group ID，支持in，gt(e)，lt(e)，regex查询
status O int 状态值，1：删除，2：正常
projection O list 需要返回的字段列表
sort O dict 排序
skip O int 起始位置
limit O int 返回数量
响应:
code M int 0为成功，其它为失败
msg M string 错误提示信息
data M list 返回的数据列表
[{
'id' M string 品类ID
'name' M string 品类名称
'group_id' M int 所属group
'upstream_id' M string 二级分类ID
}]
pagination O dict 分页信息
{
count: 9638 M int 总条数
limit: 200 M int 每页的条数
offset: 0 M int 起始的偏移量
}
/pinlei/branch 查询品类分支
Method: GET
请求:
ids M list 品类id列表
响应:
code M int 0为成功，其它为失败
msg M string 错误提示信息
data M list 返回的数据列表
[{
upstream_id: "B101"
id: "P00001"
upstream_name: "叶菜类"
status: 2
category1_name: "蔬菜"
group_id: 1
name: "菜心"
origin_id: "P00001"
category_id_1: "A101"
}]
/pinlei/create 新建品类
Method: POST
请求:
name M string 品类名称
group_id M int 所属group
upstream_id M string 二级分类ID
sort_id O int 排序ID
响应:
code M int 0为成功，其它为失败
msg M string 错误提示信息
data M string 返回创建的品类ID
/pinlei/update 修改品类
Method: POST
请求:
id M string 品类ID
group_id M int 所属group
name O string 品类名称
upstream_id M string 二级分类ID
sort_id O int 排序ID
响应:
code M int 0为成功，其它为失败
msg M string 错误提示信息
/pinlei/delete 删除品类
Method: POST
请求:
id M string 品类ID
group_id M int 所属group
响应:
code M int 0为成功，其它为失败
msg M string 错误提示信息
spu操作接口
/spu/get 查询spu
Method: GET
请求:
id O string spu id，支持in，gt(e)，lt(e)，regex查询
name O string 分类名，支持in，gt(e)，lt(e)，regex查询
category_id_1 O string 一级分类ID，支持in，gt(e)，lt(e)，regex查询
category_id_2 O string 二级分类ID，支持in，gt(e)，lt(e)，regex查询
pinlei_id O string 品类ID，支持in，gt(e)，lt(e)，regex查询
group_id O string group ID，支持in，gt(e)，lt(e)，regex查询
station_id O string 站点ID，支持in，gt(e)，lt(e)，regex查询
status O int 状态值，1：删除，2：正常
p_type O int 类型，1：通用/2：私有
or O list or查询,形如[{"group_id":54}],参数类型要求同上，or查询内支持的操作符也同上，形如：[{"group_id":{"$in":[54]}}]
projection O list 需要返回的字段列表
sort O dict 排序
limit O int 限制个数
offset O int 偏移个数
响应:
code M int 0为成功，其它为失败
msg M string 错误提示信息
data M list 返回的数据列表
[{
'pinlei_id' M string 品类ID
'category_id_2' M string 二级分类ID
'category_id_1' M string 一级分类ID
'id' M string spu ID
'name' M string spu名称
'desc' M string 描述
'p_type' M string spu类型
'image' M string 图片
'group_id' M int 所属group
'station_id' O string 所属站点ID
'dispatch_method' M string 分拣方式
'std_unit_name' O string 基本单位
'alias' O list 别名
}]
pagination O dict 分页信息
{
count: 9638 M int 总条数
limit: 200 M int 每页的条数
offset: 0 M int 起始的偏移量
}
/spu/branch 查询spu分支
Method: GET
请求:
ids M list spu id列表
响应:
code M int 0为成功，其它为失败
msg M string 错误提示信息
data M list 返回的数据列表
[{
pinlei_name: "菜苔"
category1_name: "蔬菜"
desc: "-"
name: "白菜苔"
group_id: 1
category_id_1: "A101"
p_type: 0
category2_name: "叶菜类"
dispatch_method: 2
pinlei_id: "P00006"
std_unit_name: "斤"
id: "C00001"
category_id_2: "B101"
status: 2
image: "f43b8093de95310f.jpg"
}]
/spu/create 新建spu
Method: POST
请求:
name M string spu名称
desc M string spu描述
p_type M int 类型(0:通用;1:私有)
std_unit_name M string 基本单位
image M string 图片名称
dispatch_method M int 分拣方式(1:bagua/2:union)
pinlei_id M string 品类ID
group_id M int 所属group
station_id O string 所属站点ID
alias O list spu别名
响应:
code M int 0为成功，其它为失败
msg M string 错误提示信息
data M string 返回创建的spu ID
/spu/update 修改spu
Method: POST
请求:
id M string spu ID
group_id M int 所属group
station_id M string 所属站点ID
name O string spu名称
desc O string spu描述
p_type O int 类型(0:通用;1:私有)
std_unit_name O string 基本单位
image O string 图片名称
dispatch_method O int 分拣方式(1:bagua/2:union)
pinlei_id O string 品类ID
status O int 状态值
alias O list spu别名
响应:
code M int 0为成功，其它为失败
msg M string 错误提示信息
/spu/delete 删除单个spu
Method: POST
请求:
id M string spu ID
group_id M int 所属group
station_id M string 所属站点ID
响应:
code M int 0为成功，其它为失败
msg M string 错误提示信息
spu/delete_many 批量删除spu
Method: POST
请求:
spu_list M list spuIDs
group_id M int 所属group
响应:
code M int 0为成功，其它为失败
msg M string 错误提示信息
spu/import_by_template 通过云商品库模板导入spu
请求
# 方式1：选中N个云商品（当参数template_ids有值时 将忽略方式2的参数）
template_ids O list 云商品ID列表
# 方式2：全选云商品列表（列表查询的参数）
category1_ids O list 一级分类ID列表
category2_ids O list 二级分类ID列表
pinlei_ids O list 品类ID列表
q O string 搜索参数(按SPU别名、SPUID搜索)
# 导入相关的参数
category1_id M string 选择导入的一级分类ID
category2_id M string 选择导入的二级分类ID
auto_create_pinlei M bool 导入时是否自动创建品类（1：是，0：不是）
pinlei_id O string 选择导入的品类，当 auto_create_pinlei=1 时有效
auto_create_sku O bool 导入时是否自动创建商品规格（1：是，0：不是）
salemenu_ids O list 选择对应的报价单创建sku
响应
async M int 0:同步，1:异步
task_url M null/str 异步返回url，同步则为null
msg M str 返回信息 比如“ok”
code M int 状态码 成功时为0
tree/get 获取spu分类树结构
Method: GET
请求:
无
响应:
code M int 0为成功，其它为失败
msg M string 错误提示信息
id M string 一级分类id
name M string 一级分类名
chtree O dict 子节点树
{
id M string 二级分类id
name M string 二级分类名
upstream_id M string 上级分类id
chtree O dict 子节点树
{
id M string 品类id
name M string 品类名
upstream_id M string 上级分类id
category_id_1 M string 一级分类id
chtree O dict 子节点树
{
id M string spuID
name M string spu名
category_id_1 M string 一级分类id
category_id_2 M string 二级分类id
pinlei_id M string 品类id
}
}
}
响应示例：
"id": "A10875",
"chtree": [
{
"name": "酒",
"id": "B49646",
"chtree": [
{
"category_id_1": "A10875",
"name": "白酒",
"id": "P408382",
"chtree": [
{
"name": "五粮液",
"id": "C1738564",
"category_id_1": "A10875",
"pinlei_id": "P408382",
"category_id_2": "B49646"
},
{
"name": "22",
"id": "C1738570",
"category_id_1": "A10875",
"pinlei_id": "P408382",
"category_id_2": "B49646"
}
],
"upstream_id": "B49646"
}
],
"upstream_id": "A10875"
}
],
"name": "酒水"
}