商品api说明
接口地址 | http://host:port/pospal-api2/openapi/v1/productopenapi/queryproductcategorypages | ||
---|---|---|---|
请求头 |
|
||
请求方式 | post | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appid | 是 | string | pospal配置的访问凭证 |
postbackparameter | 否 | json | 查询凯发官方首页时可以不传,之后的内容从返回结果中取出 |
parametertype | 是 | string | 从返回结果中取出 |
parametervalue | 是 | string | 从返回结果中取出 |
返回结果 |
|
||
字段名 | 类型 | 说明 | |
status | string | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | string[] | 处理结果的消息 | |
errorcode | int | 业务处理的错误代码,参见错误代码表 | |
pagesize | int | 本次查询预期从库存取出记录数,如果结果集的长度小于pagesize,不需要进行下一页查询 | |
postbackparameter | json | 分页查询回传到服务器的参数结构从第二页开始必须回传,如果没传,每次查询都是第一页 | |
parametertype | string | 从返回结果中直接取出用于回传,不能变其值 | |
parametervalue | string | 从返回结果中直接取出用于回传,不能变其值 | |
result | list | 商品分类实体 | |
uid | long | 当前商品分类唯一标识 | |
parentuid | long | 当前商品分类的父分类的唯一标识 | |
name | string | 商品分类名称 |
接口地址 | http://host:port/pospal-api2/openapi/v1/productopenapi/queryproductimagepages | ||
---|---|---|---|
请求头 |
|
||
请求方式 | post | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appid | 是 | string | pospal配置的访问凭证 |
postbackparameter | 否 | json | 查询凯发官方首页时可以不传,之后的内容从返回结果中取出 |
parametertype | 是 | string | 从返回结果中取出 |
parametervalue | 是 | string | 从返回结果中取出 |
返回结果 |
|
||
字段名 | 类型 | 说明 | |
status | string | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | string[] | 处理结果的消息 | |
errorcode | int | 业务处理的错误代码,参见错误代码表 | |
pagesize | int | 本次查询预期从数据库中取出记录数,如果结果集的长度小于pagesize,不需要进行下一页查询 | |
postbackparameter | json | 分页查询回传到服务器的参数结构从第二页开始必须回传,如果没传,每次查询都是第一页 | |
parametertype | string | 从返回结果中直接取出用于回传,不能变其值 | |
parametervalue | string | 从返回结果中直接取出用于回传,不能变其值 | |
result | list |
商品图片实体 | |
productuid | long | 商品的唯一标识 | |
productname | string | 商品名称 | |
productbarcode | string | 商品的条形码 | |
imageurl | string | 商品图片的url |
请求头 |
|
||
---|---|---|---|
请求方式 | post | ||
接口地址 | http://host:port/pospal-api2/openapi/v1/productopenapi/queryproductimagesbyproductuid | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appid | 是 | string | pospal配置的访问凭证 |
productuid | 是 | long | 商品uid |
接口地址 | http://host:port/pospal-api2/openapi/v1/productopenapi/queryproductimagesbybarcode | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appid | 是 | string | pospal配置的访问凭证 |
productbarcode | 是 | string | 商品条码 |
返回结果 |
|
||
字段名 | 类型 | 说明 | |
status | string | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | string[] | 处理结果的消息 | |
errorcode | int | 业务处理的错误代码,参见错误代码表 | |
result | list | 商品图片实体 | |
productuid | long | 商品的唯一标识 | |
productname | string | 商品名称 | |
productbarcode | string | 商品的条形码 | |
imageurl | string | 商品图片的url |
接口地址 | http://host:port/pospal-api2/openapi/v1/productopenapi/queryproductbybarcode | ||
---|---|---|---|
请求头 |
|
||
请求方式 | post | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appid | 是 | string | pospal配置的访问凭证 |
barcode | 是 | string | 商品条码 |
返回结果 |
|
||
字段名 | 类型 | 说明 | |
status | string | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | string[] | 处理结果的消息 | |
errorcode | int | 业务处理的错误代码,参见错误代码表 | |
data | json | 商品实体信息 | |
uid | long | 商品实体唯一标识 | |
categoryuid | long | 商品分类的唯一标识 | |
name | string | 商品名称 | |
barcode | string | 商品条形码 | |
buyprice | bigdecimal | 商品进货价 | |
sellprice | bigdecimal | 商品销售价 | |
sellprice2 | bigdecimal | 批发价 | |
stock | bigdecimal | 商品库存 | |
maxstock | bigdecimal | 库存上限 | |
minstock | bigdecimal | 库存下限 | |
nostock | int | null/0 记库存,1不记库存 | |
pinyin | string | 商品名称拼音 | |
customerprice | bigdecimal | 商品会员价 | |
iscustomerdiscount | integer | 是否开启会员折扣支持,为0或null不开启;1开启 | |
description | string[长度6000] | 商品描述 | |
supplieruid | long | 供应商唯一标识 | |
enable | int | 1可用 0禁用 -1删除 | |
attribute1 | string | 自定义1 | |
attribute2 | string | 自定义2 | |
attribute3 | string | 自定义3 | |
attribute4 | string | 自定义4 | |
attribute5 | string | spu/货号/主编码(服装多颜色尺码) | |
attribute6 | string | 规格 | |
attribute7 | string | 是否主商品(多规格时用到) | |
attribute8 | string | 是否多颜色尺码 | |
productiondate | string | 生产日期,格式yyyy-mm-dd hh:mm:ss | |
shelflife | integer | 保质期(天数) |
行业 | 自定义1 | 自定义2 | 自定义3 | 自定义4 |
---|---|---|---|---|
零售 | 自定义1 | 自定义2 | 自定义3 | 货号 |
餐饮 | 无(无显示) | 自定义2 | 自定义3 | 页面没显示 |
母婴 | 自定义1 | 自定义2 | 自定义3 | 货号 |
烘焙 | 自定义1 | 自定义2 | 页面没显示 | 页面没显示 |
美业休闲 | 自定义1 | 自定义2 | 自定义3 | 自定义4 |
服装 | 颜色 | 尺码 | 无(无显示) | 货号 |
宠物 | 自定义1 | 自定义2 | 自定义3 | 自定义4 |
生活服务 | 自定义1 | 自定义2 | 自定义3 | 自定义4 |
其他 | 自定义1 | 自定义2 | 自定义3 | 自定义4 |
接口地址 | http://host:port/pospal-api2/openapi/v1/productopenapi/queryproductpages | ||
---|---|---|---|
请求头 |
|
||
请求方式 | post | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appid | 是 | string | pospal配置的访问凭证 |
categoryuid | 否 | long | 商品分类唯一标识,根据商品分类查询商品 |
needallincludedel | 否 | int | 是否查询已删除的数据 1:是 0:否(默认) |
updateddatetimefrom | 否 | string | 修改开始时间,格式为yyyy-mm-dd hh:mm:ss,包含开始时间 |
updateddatetimeto | 否 | string | 修改结束时间,格式为yyyy-mm-dd hh:mm:ss,包含结束时间 |
postbackparameter | 否 | json | 查询凯发官方首页时可以不传,之后的内容从返回结果中取出 |
parametertype | 是 | json | 从返回结果中取出 |
parametervalue | 是 | string | 从返回结果中取出 |
返回结果 |
|
||
字段名 | 类型 | 说明 | |
status | string | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | string[] | 处理结果的消息 | |
errorcode | int | 业务处理的错误代码,参见错误代码表 | |
pagesize | int | 本次查询预期从库存取出记录数,如果结果集的长度小于pagesize,不需要进行下一页查询 | |
postbackparameter | json | 分页查询回传到服务器的参数结构从第二页开始必须回传,如果没传,每次查询都是第一页 | |
parametertype | string | 从返回结果中直接取出用于回传,不能变其值 | |
parametervalue | string | 从返回结果中直接取出用于回传,不能变其值 | |
result | list | 商品实体信息,字段信息参照:4. 根据条形码查询商品信息 |
接口地址 | http://host:port/pospal-api2/openapi/v1/productopenapi/updateproductinfo | ||
---|---|---|---|
请求头 |
|
||
请求方式 | post | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appid | 是 | string | pospal配置的访问凭证 |
productinfo | 是 | json | |
uid | 是 | long | 商品在银豹系统的唯一标识 |
buyprice | 否 | bigdecimal | 进货价,传空或不传不做修改操作 |
sellprice | 否 | bigdecimal | 销售价,传空或不传不做修改操作 |
sellprice2 | 否 | bigdecimal | 商品批发价 |
stock | 否 | bigdecimal | 库存,传空或不传不做修改操作 |
customerprice | 否 | bigdecimal | 会员价,传空或不传不做修改操作 |
categoryuid | 否 | long | 商品分类的唯一标识 |
supplieruid | 否 | long | 供应商唯一标识 |
iscustomerdiscount | 否 | integer | 传1表示使用会员折扣计算商品价格传0表示使用商品的会员价 |
shelflife | 否 | integer | 保质期(天数) |
name | 否 | string | 商品名称 |
enable | 否 | integer | 1可用 0禁用 -1删除 |
attribute1 | 否 | string[长度255] | attribute1-attribute10 不同行业,表示的意义不同,可在后台创建个商品,调用下查询接口,自行对应各个字段的含义 |
attribute2 | 否 | string[长度255] | attribute2 |
attribute3 | 否 | string[长度255] | attribute3 |
attribute4 | 否 | string[长度255] | attribute4 |
attribute5 | 否 | string[长度255] | spu/货号(服装多颜色尺码) 多规格商品,该字段一样 |
attribute6 | 否 | string[长度255] | 规格 |
attribute7 | 否 | string[长度255] | 是否主商品 1:主商品 0:非主商品 多规格收银时,默认选中的商品 比如默认选中 大杯 |
attribute8 | 否 | string[长度255] | attribute8 |
attribute9 | 否 | string[长度255] | attribute9 |
attribute10 | 否 | string[长度255] | attribute10 |
返回结果 |
|
||
字段名 | 类型 | 说明 | |
status | string | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | string[] | 处理结果的消息 | |
errorcode | int | 业务处理的错误代码,参见错误代码表 |
接口地址 | http://host:port/pospal-api2/openapi/v1/productopenapi/queryproductbyuid | ||
---|---|---|---|
请求头 |
|
||
请求方式 | post | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appid | 是 | string | pospal配置的访问凭证 |
productuid | 是 | long | 商品在银豹系统的唯一标识 |
返回结果 |
|
||
字段名 | 类型 | 说明 | |
status | string | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | string[] | 处理结果的消息 | |
errorcode | int | 业务处理的错误代码,参见错误代码表 | |
data | json | 商品实体信息,字段信息参照:4. 根据条形码查询商品信息 |
接口地址 | http://host:port/pospal-api2/openapi/v1/productopenapi/addproductinfo | ||
---|---|---|---|
请求头 |
|
||
请求方式 | post | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appid | 是 | string | pospal配置的访问凭证 |
productinfo | 是 | json | 商品主要信息 |
categoryuid | 否 | long | 商品分类的唯一标识 |
name | 是 | string | 商品名称 |
barcode | 是 | string | 如果后台没该商品,但添加时 报 商品已存在 的错误,表示该商品被删除了 |
buyprice | 是 | bigdecimal | 商品进货价,不可为0 |
sellprice | 是 | bigdecimal | 商品销售价,不可为0 |
sellprice2 | 否 | bigdecimal | 商品批发价 |
stock | 是 | bigdecimal | 商品库存 |
maxstock | 是 | bigdecimal | 库存上限 |
minstock | 是 | bigdecimal | 库存下限 |
nostock | 是 | int | 是否不记库存 null/0 记库存,1不记库存 |
pinyin | 否 | string | 商品名称拼音 |
customerprice | 否 | bigdecimal | 商品会员价 |
iscustomerdiscount | 否 | integer | 是否开启会员折扣支持,为0或null不开启;1开启 |
description | 否 | string[长度6000] | 商品描述 |
supplieruid | 否 | long | 供应商唯一标识 |
shelflife | 否 | integer | 保质期(天数) |
attribute1 | 否 | string[长度255] | attribute1-attribute10 不同行业,表示的意义不同,可在后台创建个商品,调用下查询接口,自行对应各个字段的含义 |
attribute2 | 否 | string[长度255] | attribute2 |
attribute3 | 否 | string[长度255] | attribute3 |
attribute4 | 否 | string[长度255] | attribute4 |
attribute5 | 否 | string[长度255] | spu/货号(服装多颜色尺码) 多规格商品,该字段一样 |
attribute6 | 否 | string[长度255] | 规格 |
attribute7 | 否 | string[长度255] | 是否主商品 1:主商品 0:非主商品 多规格收银时,默认选中的商品 比如默认选中 大杯 |
attribute8 | 否 | string[长度255] | attribute8 |
attribute9 | 否 | string[长度255] | attribute9 |
attribute10 | 否 | string[长度255] | attribute10 |
enable | 否 | int | 0禁用,1可用 |
productcommonattribute | 否 | json | 商品属性信息 |
canappointed | 否 | int | 是否可预约 0/null-否,1-是 |
plucode | 否 | string | 称编码 |
branduid | 否 | bigint | 品牌关联uid |
stockposition | 否 | string | 库位 |
volume | 否 | bigdecimal | 体积 |
weight | 否 | bigdecimal | 重量 |
weightunit | 否 | int | 重量单位 null/1-kg,2-斤 |
minsellquantity | 否 | bigdecimal | 起售量 |
enablesn | 否 | int | 是否开启序列号管理 0/null = 关闭, 1=开启 |
ispacking | 否 | int | 是否包装商品 0/null-否,1-是 |
isbarcodescale | 否 | int | 是否条码秤商品 0/null-否,1-是 |
isnewly | 否 | int | 是否新品 0/null-否,1-是 |
返回结果 |
|
||
字段名 | 类型 | 说明 | |
status | string | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | string[] | 处理结果的消息 | |
errorcode | int | 业务处理的错误代码,参见错误代码表 | |
data | json | 商品实体信息,字段信息参照:4. 根据条形码查询商品信息 |
接口地址 | http://host:port/pospal-api2/openapi/v1/productopenapi/queryallproductunitdef | ||
---|---|---|---|
请求头 |
|
||
请求方式 | post | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appid | 是 | string | pospal配置的访问凭证 |
postbackparameter | 否 | json | 查询凯发官方首页时可以不传,之后的内容从返回结果中取出 |
parametertype | 是 | string | 从返回结果中取出 |
parametervalue | 是 | string | 从返回结果中取出 |
返回结果 |
|
||
字段名 | 类型 | 说明 | |
status | string | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | string[] | 处理结果的消息 | |
errorcode | int | 业务处理的错误代码,参见错误代码表 | |
data | list | 商品分类实体 | |
uid | long | 商品单位在银豹收银系统的唯一标识 | |
name | string | 商品单位名称 |
接口地址 | http://host:port/pospal-api2/openapi/v1/supplieropenapi/querysupplierpages | ||
---|---|---|---|
请求头 |
|
||
请求方式 | post | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appid | 是 | string | pospal配置的访问凭证 |
postbackparameter | 否 | json | 查询凯发官方首页时可以不传,之后的内容从返回结果中取出 |
parametertype | 是 | string | 从返回结果中取出 |
parametervalue | 是 | string | 从返回结果中取出 |
返回结果 |
|
||
字段名 | 类型 | 说明 | |
status | string | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | string[] | 处理结果的消息 | |
errorcode | int | 业务处理的错误代码,参见错误代码表 | |
pagesize | int | 本次查询预期从库存取出记录数,如果结果集的长度小于pagesize,不需要进行下一页查询 | |
postbackparameter | json | 分页查询回传到服务器的参数结构从第二页开始必须回传,如果没传,每次查询都是第一页 | |
parametertype | string | 从返回结果中直接取出用于回传,不能变其值 | |
parametervalue | string | 从返回结果中直接取出用于回传,不能变其值 | |
result | list | 商品分类实体 | |
uid | long | 供应商在银豹收银系统的唯一标识 | |
name | string | 供应商名称 | |
number | string | 供应商编号 | |
linkman | string | 供应商联系人 | |
gender | string | 联系人性别 | |
tel | string | 联系人电话 | |
string | 联系人邮箱 | ||
address | string | 供应商地址 | |
remarks | string | 备注信息 | |
enable | integer | 1:启用;0:禁用,-1删除 |
接口地址 | http://host:port/pospal-api2/openapi/v1/productopenapi/queryproductbybarcodes | ||
---|---|---|---|
请求头 |
|
||
请求方式 | post | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appid | 是 | string | pospal配置的访问凭证 |
barcodes | 是 | string[] | 商品条形码列表,数量<=200 |
返回结果 |
|
||
字段名 | 类型 | 说明 | |
status | string | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | string[] | 处理结果的消息 | |
errorcode | int | 业务处理的错误代码,参见错误代码表 | |
data | list | 商品实体信息,字段信息参照4. 根据条形码查询商品信息 |
接口地址 | http://host:port/pospal-api2/openapi/v1/productopenapi/queryunitexchangepages | ||
---|---|---|---|
请求头 |
|
||
请求方式 | post | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appid | 是 | string | pospal配置的访问凭证 |
postbackparameter | 否 | json | 查询凯发官方首页时可以不传,之后的内容从返回结果中取出 |
parametertype | 是 | string | 从返回结果中取出 |
parametervalue | 是 | string | 从返回结果中取出 |
返回结果 |
|
||
字段名 | 类型 | 说明 | |
status | string | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | string[] | 处理结果的消息 | |
errorcode | int | 业务处理的错误代码,参见错误代码表 | |
data | json | 数据 | |
pagesize | int | 本次查询预期从库存取出记录数,如果结果集的长度小于pagesize,不需要进行下一页查询 | |
postbackparameter | json | 分页查询回传到服务器的参数结构 从第二页开始必须回传,如果没传,每次查询都是第一页 |
|
parametertype | string | 从返回结果中直接取出用于回传,不能变其值 | |
parametervalue | string | 从返回结果中直接取出用于回传,不能变其值 | |
result | list | 商品单位规则交换实体 |
接口地址 | http://host:port/pospal-api2/openapi/v1/productopenapi/queryunitexchangebyproductuid | ||
---|---|---|---|
请求头 |
|
||
请求方式 | post | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appid | 是 | string | pospal配置的访问凭证 |
productuid | 否 | long | 商品在银豹的唯一标识 |
返回结果 |
|
||
字段名 | 类型 | 说明 | |
status | string | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | string[] | 处理结果的消息 | |
errorcode | int | 业务处理的错误代码,参见错误代码表 | |
data | list | 数据列表 | |
productuid | long | 商品uid | |
productunituid | long | 商品单位uid | |
exchangequantity | decimal | 单位与基准单位的倍数,如 1公斤=1000克 基准单位时,这个值是1 | |
isbase | int | 是否是基准商品的基准单位 |
接口地址 | http://host:port/pospal-api2/openapi/v1/productopenapi/updateproductcustomerprice | ||
---|---|---|---|
请求头 |
|
||
请求方式 | post | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appid | 是 | string | pospal配置的访问凭证 |
productuid | 是 | long | 商品在银豹的唯一标识 |
customerpriceinfo | 是 | 数组 | 会员价信息 |
categoryuid | 是 | long | 会员等级在银豹的唯一标识 |
price | 是 | bigdecimal | 会员价格 |
返回结果 |
|
||
字段名 | 类型 | 说明 | |
status | string | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | string[] | 处理结果的消息 | |
errorcode | int | 业务处理的错误代码,参见错误代码表 |
接口地址 | http://host:port/pospal-api2/openapi/v1/productopenapi/queryproducotherinfotbyuids | ||
---|---|---|---|
请求头 |
|
||
请求方式 | post | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appid | 是 | string | pospal配置的访问凭证 |
productuids | 是 | 数组 | 商品uid,最多200个 |
返回结果 |
|
||
字段名 | 类型 | 说明 | |
status | string | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | string[] | 处理结果的消息 | |
errorcode | int | 业务处理的错误代码,参见错误代码表 | |
data | list | 商品其它信息实体 | |
id | int | 数据库主键,用不到,直接忽略 | |
productuid | long | 商品单位在银豹收银系统的唯一标识 | |
branduid | long | 品牌uid | |
brandname | string | 品牌名称 | |
stockposition | string | 库位 | |
weight | bigdecimal | 重量 | |
unituid | long | 基准单位uid | |
unitname | string | 基准单位名称 | |
tagnames | string[] | 标签 |
接口地址 | http://host:port/pospal-api2/openapi/v1/productopenapi/addcategory | ||
---|---|---|---|
请求头 |
|
||
请求方式 | post | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appid | 是 | string | pospal配置的访问凭证 |
name | 是 | string | 分类名称 |
parentuid | 否 | long | 上级分类(假如苹果的上级分类是水果,这边就填水果的分类uid) |
返回结果 |
|
||
字段名 | 类型 | 说明 | |
status | string | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | string[] | 处理结果的消息 | |
errorcode | int | 业务处理的错误代码,参见错误代码表 | |
data | json | 商品分类实体信息 | |
id | int | 数据库主键,用不到,直接忽略 | |
uid | long | 商品分类在银豹收银系统的唯一标识 | |
name | string | 分类名称 | |
parentuid | long | 上级分类uid |
接口地址 | http://host:port/pospal-api2/openapi/v1/productopenapi/updatecategory | ||
---|---|---|---|
请求头 |
|
||
请求方式 | post | ||
请求体 |
|
||
参数名 | 是否必须 | 类型 | 说明 |
appid | 是 | string | pospal配置的访问凭证 |
uid | 是 | string | 分类uid, 通过queryproductcategorypages 接口获取 |
name | 是 | string | 分类名称(如果不想改分类名称,可以称原来的名称) |
parentuid | 否 | long | 上级分类(0:顶级分类 空,-1:不改变父分类) |
返回结果 |
|
||
字段名 | 类型 | 说明 | |
status | string | 是否正确处理请求,返回success或error,不区分大小写 | |
messages | string[] | 处理结果的消息 | |
errorcode | int | 业务处理的错误代码,参见错误代码表 | |
data | json | 商品分类实体信息 | |
id | int | 数据库主键,用不到,直接忽略 | |
uid | long | 商品分类在银豹收银系统的唯一标识 | |
name | string | 分类名称 | |
parentuid | long | 上级分类uid |