API导航栏
银豹开放平台开发者服务协议
接口调用方法
常见问题
门店API
1. 获取所有门店信息(只能通过总部appId获取)
会员API
1. 根据会员号查询会员
2. 根据customerUid查询会员完整信息
3. 分页查询全部会员
4. 修改会员基本信息
5. 修改会员余额积分
6. 添加会员
7. 查询全部通用金额充值记录
8. 根据customerUid查询会员通用金额充值情况
9. 根据会员手机号查询会员
10. 查询所有会员等级
11. 批量修改会员类型(等级)
12. 修改会员密码
13. 分页查询补贴发放记录
商品API
1. 分页查询全部商品分类
2. 分页查询全部商品图片
3. 根据商品Uid/Barcode(条形码)查询商品图片
4. 根据Barcode(条形码)查询商品信息
5. 分页查询全部商品信息
6. 修改商品信息
7. 根据productUid(商品唯一标识)查询商品信息
8. 新增加商品信息
9. 查询所有商品单位定义
10. 分页查询全部供应商信息
11. 根据Barcode(条形码)批量查询商品信息
12. 分页商品单位互换规则
13. 根据productUid(商品唯一标识)查询单位互换规则
14. 根据productUid修改商品多级会员价
15. 查询商品其它信息(品牌,库位,重量,单位,标签,多级会员价,属性口味等信息)
16. 新增商品分类
17. 更新商品分类
18. 分页查询全部品牌信息
19. 查询全部属性组,如口味组,尺码组
20. 查询全部属性,如口味、颜色尺码
21. 查询报损记录
22. 查询报损原因
盘点API
1. 查询历史盘点记录
2. 查询某一盘点记录明细
3. 查询某一盘点详情
销售单据API
1. 查询支付方式代码
2. 根据sn(单据序列号)查询
3. 根据单据uid查询
4. 分页查询所有单据
5. 分页查询会员单据
6. 根据sellTcketUid(销售单据uid)查询对应的退货单据
7. 根据sellTcketSn(销售单据sn)查询对应的退货单据
8. 根据refunTcketUid(退货单据uid)查询对应的销售单据
9. 根据refunTcketSn(退货单据sn)查询对应的销售单据
10. 根据orderNo(网单号)查询对应的销售单据
11. 查询当前门店的支付方式代码
收银员API
1. 获取门店所有收银员
订单推送API
1. 网单流程图
2. 新增在线订单
3. 取消在线订单
4. 在线订单发货
5. 完成在线订单
6. 根据orderNo(网单号)查询线上订单详情
7. 根据订单id查询订单
8. 分页查询订单
促销(优惠券)API
1. 促销活动说明
2. 根据promotionCouponUid(优惠券规则Uid)查询
3. 查询可用优惠券规则
4. 添加优惠券号(核销码)
5. 分页查询会员所有优惠券号(核销码)(id倒序)
6. 分页查询核销过的优惠券号(核销码)
7. 分页查询所有促销规则
8. 使用code(优惠券号)对核销码进行核销
预付卡API
1. 分页查询预付卡规则
2. 分页查询预付卡制卡明细
3. 分页查询预付卡售卡明细
货流API
1.货流说明
2. 分页查询所有订货单(所有门店)
3. 根据productReuestId(订货单Id)查询订货单
4. 分页查询所有货单(调货/进货/退货)(所有门店)
5. 根据productRequestId(订货单id)查询所有货单(调货/进货/退货)
6. 根据stockFlowId(货流单id)查询货单
7. 创建货流单
8. 确认出货
9. 确认进货
10. 拒绝出货
11. 拒绝进货
12. 分页查询采购单
接口访问量API
1. 查询访问量配置
2. 查询每日访问量
通知服务API
1. 查询推送地址
2. 修改推送地址
错误代码
错误代码
订单推送API V2
1. 网单流程图
2. 新增在线订单
3. 取消在线订单
4. 在线订单发货
5. 完成在线订单
6. 根据orderNo(网单号)查询线上订单详情
7. 根据订单id查询订单
8. 分页查询订单
促销(优惠券)API V2
1. 促销活动说明
2. 根据promotionCouponUid(优惠券规则Uid)查询
3. 查询可用优惠券规则
4. 添加优惠券号(核销码)
5. 分页查询会员所有优惠券号(核销码)(id倒序)
6. 分页查询核销过的优惠券号(核销码)(id倒序)
7. 分页查询所有促销规则
8. 使用code(优惠券号)对核销码进行核销
交互格式说明
更新时间:2025-12-31
# 1.1 编码格式(V2) - 请求与响应统一使用 UTF-8 编码。 - JSON 体必须是 UTF-8 字符串。
# 1.2 请求体(V2) - 请求体为 UTF-8 JSON 字符串。 - 示例:`{"appId":"your-app-id","body":"..."}` 确保请求体与签名计算时的原文完全一致(字段顺序、空格均会影响签名)。
# 1.3 请求头(V2) 通用请求头(V2): - `User-Agent`: `openApi` - `Content-Type`: `application/json; charset=utf-8` - `accept-encoding`: `gzip,deflate`(可选) - `time-stamp`: 毫秒级 UNIX(Unix)时间戳,例如 `1627547314370` - `data-signature`: `MD5(appKey + 请求体原文)`,32 位大写 请确保签名计算与实际请求体完全一致。
# 1.4 响应体(V2) 响应体为 UTF-8 JSON,顶层常见字段: - `status`: `success` / `error`(不区分大小写) - `messages`: `String[]` - `errorCode`: `Int` - `data`: 业务数据 如响应头带 `Content-Encoding: gzip`,需先解压再解析 JSON。部分接口会在响应头中返回 `data-signature`,签名计算规则与请求头一致。
本页导读