商数通开放平台

主题

接口总览 ​

API 基础信息 ​

项目说明
沙箱地址https://sandbox-openapi.example.com
生产地址https://openapi.example.com
API 版本v1
数据格式JSON
认证方式AppKey + HMAC-SHA256 签名

所有开放 API 的完整路径格式为：{基础地址}/open-api/v1/{资源路径}

例如：GET https://openapi.example.com/open-api/v1/merchants

接口列表 ​

商户 API ​

需要权限：merchant

接口方法路径权限说明
查询商户列表GET/open-api/v1/merchants只读分页查询已授权的商户
查询商户详情GET/open-api/v1/merchants/{merchantId}只读获取商户详细信息
注册商户POST/open-api/v1/merchants/register读写注册新商户
更新商户信息PUT/open-api/v1/merchants/{merchantId}读写更新商户基本信息
提交商户认证POST/open-api/v1/merchants/{merchantId}/certification读写提交商户资质认证
查询商户认证状态GET/open-api/v1/merchants/{merchantId}/certification/status只读获取认证进度
查询门店列表GET/open-api/v1/stores只读分页查询门店
查询门店详情GET/open-api/v1/stores/{storeId}只读获取门店详细信息
查询附近门店GET/open-api/v1/stores/nearby只读按经纬度查询附近门店
查询门店营业时间GET/open-api/v1/stores/{storeId}/business-hours只读获取门店营业时间段
创建门店POST/open-api/v1/stores读写在商户下创建门店
更新门店PUT/open-api/v1/stores/{storeId}读写更新门店信息
删除门店DELETE/open-api/v1/stores/{storeId}完全删除门店

会员卡 API ​

需要权限：member_card

接口方法路径权限说明
查询会员卡模板列表GET/open-api/v1/card-templates只读查询可用的会员卡模板
查询会员卡模板详情GET/open-api/v1/card-templates/{templateId}只读获取模板详细信息
创建会员卡模板POST/open-api/v1/card-templates读写创建新的会员卡模板
更新会员卡模板PUT/open-api/v1/card-templates/{templateId}读写修改模板信息
上架会员卡模板PUT/open-api/v1/card-templates/{templateId}/publish读写发布模板使其可购买
下架会员卡模板PUT/open-api/v1/card-templates/{templateId}/unpublish读写下架模板
配置充值档位PUT/open-api/v1/card-templates/{templateId}/recharge-tiers读写设置储值卡的充值档位
配置分销提成PUT/open-api/v1/card-templates/{templateId}/commission读写设置推广分佣比例
配置会员发券PUT/open-api/v1/card-templates/{templateId}/coupon-config读写设置会员开卡赠券配置
购买会员卡POST/open-api/v1/member-cards/purchase读写为用户开通会员卡
查询会员卡列表GET/open-api/v1/member-cards只读分页查询会员卡
查询会员卡详情GET/open-api/v1/member-cards/{cardId}只读获取会员卡信息
会员卡充值POST/open-api/v1/member-cards/{cardId}/recharge读写对储值卡进行充值
会员卡核销POST/open-api/v1/member-cards/{cardId}/write-off读写核销会员卡余额/次数
会员卡购买优惠券POST/open-api/v1/member-cards/{cardId}/purchase-coupon读写用卡内权益兑换优惠券
会员卡核销优惠券POST/open-api/v1/member-cards/{cardId}/write-off-coupon读写核销卡绑定的优惠券
查询会员卡消费记录GET/open-api/v1/member-cards/{cardId}/consumption-records只读获取消费流水
查询会员卡统计GET/open-api/v1/member-cards/statistics只读获取商户会员卡汇总数据

订单 API ​

需要权限：order

接口方法路径权限说明
创建订单POST/open-api/v1/orders读写创建新订单
查询订单列表GET/open-api/v1/orders只读分页查询订单
查询订单详情GET/open-api/v1/orders/{orderId}只读获取订单详情
查询订单状态历史GET/open-api/v1/orders/{orderId}/status-history只读获取状态变更记录
查询订单统计GET/open-api/v1/orders/statistics只读获取订单汇总数据
查询退款详情GET/open-api/v1/orders/{orderId}/refund只读获取退款信息
取消订单POST/open-api/v1/orders/{orderId}/cancel读写取消待支付订单
确认收货POST/open-api/v1/orders/{orderId}/confirm-receipt读写确认订单收货
核销订单POST/open-api/v1/orders/{orderId}/write-off读写核销服务类订单
申请退款POST/open-api/v1/orders/{orderId}/refund读写提交退款申请
订单评价POST/open-api/v1/orders/{orderId}/review读写提交订单评价
订单支付POST/open-api/v1/orders/{orderId}/pay读写发起订单支付
更新配送状态PUT/open-api/v1/orders/{orderId}/delivery-status读写更新物流配送状态
确认预约订单POST/open-api/v1/orders/{orderId}/confirm-booking读写商家确认预约
变更预约订单POST/open-api/v1/orders/{orderId}/change-booking读写修改预约时间/内容

商品 API ​

需要权限：product

接口方法路径权限说明
查询商品列表GET/open-api/v1/products只读分页查询商品/服务
查询商品详情GET/open-api/v1/products/{productId}只读获取商品/服务详情
搜索商品GET/open-api/v1/products/search只读关键词搜索商品
查询商品分类列表GET/open-api/v1/product-categories只读获取商户商品分类
创建商品POST/open-api/v1/products读写发布新商品/服务
更新商品PUT/open-api/v1/products/{productId}读写修改商品信息
删除商品DELETE/open-api/v1/products/{productId}完全删除商品
商品上架/下架PUT/open-api/v1/products/{productId}/status读写变更商品状态
创建商品分类POST/open-api/v1/product-categories读写新增商品分类
更新商品分类PUT/open-api/v1/product-categories/{categoryId}读写修改分类信息
删除商品分类DELETE/open-api/v1/product-categories/{categoryId}完全删除商品分类
库存入库POST/open-api/v1/products/{productId}/stock-in读写增加商品库存
库存出库POST/open-api/v1/products/{productId}/stock-out读写减少商品库存
查询库存变动日志GET/open-api/v1/products/{productId}/stock-logs只读获取库存流水
查询商品统计GET/open-api/v1/products/statistics只读获取商品汇总数据

支付 API ​

需要权限：payment

接口方法路径权限说明
创建收银台会话POST/open-api/v1/payment/cashier/create读写创建支付收银台
查询支付结果GET/open-api/v1/payment/query只读查询支付订单状态

优惠券 API ​

需要权限：coupon

接口方法路径权限说明
查询券模板列表GET/open-api/v1/coupon-templates只读分页查询券模板
查询券模板详情GET/open-api/v1/coupon-templates/{templateId}只读获取模板详情
创建券模板POST/open-api/v1/coupon-templates读写新建优惠券模板
更新券模板PUT/open-api/v1/coupon-templates/{templateId}读写修改模板信息
发布券模板PUT/open-api/v1/coupon-templates/{templateId}/publish读写发布模板开始发券
暂停券模板PUT/open-api/v1/coupon-templates/{templateId}/pause读写暂停发券
恢复券模板PUT/open-api/v1/coupon-templates/{templateId}/resume读写恢复发券
批量发放优惠券POST/open-api/v1/coupon-templates/{templateId}/issue读写批量向用户发放优惠券
查询用户优惠券GET/open-api/v1/user-coupons只读查询用户持有的优惠券
领取优惠券POST/open-api/v1/user-coupons/claim读写用户主动领取优惠券
购买优惠券POST/open-api/v1/user-coupons/purchase读写用户购买付费优惠券
验证优惠券POST/open-api/v1/user-coupons/verify读写核销前校验优惠券有效性
核销优惠券POST/open-api/v1/user-coupons/write-off读写核销用户的优惠券

预约 API ​

需要权限：booking

接口方法路径权限说明
查询可用时段GET/open-api/v1/booking/available-slots只读查询资源的可预约时间段
创建预约POST/open-api/v1/booking/orders读写创建预约单
查询预约列表GET/open-api/v1/booking/orders只读分页查询预约单
查询预约详情GET/open-api/v1/booking/orders/{bookingId}只读获取预约单详情
变更预约PUT/open-api/v1/booking/orders/{bookingId}读写修改预约信息
取消预约POST/open-api/v1/booking/orders/{bookingId}/cancel读写取消预约单
确认预约POST/open-api/v1/booking/orders/{bookingId}/confirm读写商家确认预约
开始服务POST/open-api/v1/booking/orders/{bookingId}/start读写标记服务开始
完成服务POST/open-api/v1/booking/orders/{bookingId}/complete读写标记服务完成
查询预约统计GET/open-api/v1/booking/statistics只读获取预约汇总数据

客户 API ​

需要权限：customer

接口方法路径权限说明
同步客户信息POST/open-api/v1/customers/sync读写将应用用户同步至商户客户库
查询客户列表GET/open-api/v1/customers只读分页查询客户
查询客户详情GET/open-api/v1/customers/{customerId}只读获取客户详细信息
查询客户交易记录GET/open-api/v1/customers/{customerId}/transactions只读获取客户消费流水
获取客户标签GET/open-api/v1/customers/{customerId}/tags只读查询客户标签
添加客户标签POST/open-api/v1/customers/{customerId}/tags读写为客户打标签
删除客户标签DELETE/open-api/v1/customers/{customerId}/tags读写移除客户标签
查询客户统计GET/open-api/v1/customers/statistics只读获取客户汇总数据

统计 API ​

需要权限：statistics

接口方法路径权限说明
总览统计GET/open-api/v1/statistics/overview只读获取业务总览数据
销售统计GET/open-api/v1/statistics/sales只读查询销售数据趋势
客户统计GET/open-api/v1/statistics/customers只读查询客户增长数据
渠道统计GET/open-api/v1/statistics/channels只读查询各渠道数据
预约统计GET/open-api/v1/statistics/bookings只读查询预约统计数据
导出报表POST/open-api/v1/statistics/export读写创建数据导出任务
查询导出进度GET/open-api/v1/statistics/export/{taskId}只读获取导出任务状态

资源管理 API ​

需要权限：resource

接口方法路径权限说明
查询资源列表GET/open-api/v1/resources只读分页查询可预约资源
查询资源详情GET/open-api/v1/resources/{resourceId}只读获取资源详细信息
创建资源POST/open-api/v1/resources读写新建可预约资源（如美容师、设备）
更新资源PUT/open-api/v1/resources/{resourceId}读写修改资源信息
删除资源DELETE/open-api/v1/resources/{resourceId}完全删除资源
更新资源状态PUT/open-api/v1/resources/{resourceId}/status读写启用/停用资源
更新资源价格PUT/open-api/v1/resources/{resourceId}/price读写修改资源服务价格
更新资源排班PUT/open-api/v1/resources/{resourceId}/schedule读写配置资源工作时间
查询资源可用性GET/open-api/v1/resources/{resourceId}/availability只读查询资源可用时段
查询资源统计GET/open-api/v1/resources/statistics只读获取资源使用统计

实名认证 API ​

需要权限：real_name_auth

接口方法路径权限说明
提交身份证识别POST/open-api/v1/real-name-auth/submit-id-card读写OCR 识别身份证并记录信息
获取人脸核身参数GET/open-api/v1/real-name-auth/face-auth-params只读获取发起人脸核身所需参数
查询人脸核身结果GET/open-api/v1/real-name-auth/face-auth-result只读查询人脸比对是否通过
查询认证状态GET/open-api/v1/real-name-auth/status只读获取用户实名认证状态

支付宝授权 API ​

需要权限：alipay_auth

接口方法路径权限说明
获取支付宝授权配置GET/open-api/alipay-auth/config只读获取支付宝 OAuth 授权参数
绑定支付宝账号POST/open-api/alipay-auth/bind读写使用授权码绑定支付宝账号
查询支付宝绑定状态GET/open-api/alipay-auth/binding只读查询用户绑定状态
解绑支付宝账号POST/open-api/alipay-auth/unbind读写解除支付宝账号绑定

提现 API ​

需要权限：withdraw

接口方法路径权限说明
创建提现申请POST/open-api/withdraw/create读写发起提现到支付宝
查询提现状态GET/open-api/withdraw/get只读查询提现订单状态

权限说明 ​

每个 API 模块需要单独申请权限，权限分为三个级别：

权限级别说明
只读（READ）仅可调用查询类接口
读写（WRITE）可调用查询和写操作接口
完全（FULL）包含只读和读写，以及删除等高危操作

调用限制 ​

认证等级QPS 限制日调用量上限
L1 个人100100,000
L2 企业5001,000,000

超过限制返回 HTTP 429 状态码，响应头中包含：

Header说明
X-RateLimit-Limit限流阈值
X-RateLimit-Remaining剩余可用次数
X-RateLimit-Reset限流重置时间（秒级时间戳）

商数通开放平台

Copyright © 2026 商数通科技