LOGO

API文档 v1.3

最后更新:2021年8月31日

如果您拥有其它渠道的预约系统(比如有赞商城,或独立网店),但是希望把这些渠道所收到的订单数据汇集到Darkroom「暗房」 进行统一管理,那么这个API接口正是您所需要的。「暗房」的API接口,目前仅限专业版 商家使用。使用API之前,您需要先联系DR客服生成一对API秘钥。对于中小型机构,我们更建议您直接使用「暗房」官方自带的在线预约模块

获取门店优惠码

查询某个门店下的所有可用的门店优惠码:

GET    /stores/:store_id/coupons

发送参数列表:

参数名 必须/可选 参数类型 备注/示例
filter_plan_id
可选
字符串
筛选出适用于某个服务项目的优惠码
默认为空,表示不限制服务项目
示例值:"newborn"

通过CURL发送的请求示例:

curl -X GET -d '{"api_key":"ABC", "api_ts":1533435628, "api_sig":"....", "filter_plan_id":"newborn"}' -H "Content-Type: application/json" https://api.darkroom.net/v1.3/stores/xihu-store/schedules

响应信息示例:


{
   "response": "ok",
   "error_code": 0,
   "error_msg": "",
   "coupons": [
      {
         "code": "ECC6FEB3", // 优惠码
         "discount": "8.5", // 可享受85折(即:标价100元实付85元)
         "cashoff": 0, // 不再享受现金抵扣
         "expire_at": "2018-04-15 01:31:29", // 优惠码未来失效的时间
         "max_usage": 100, // 该优惠码最多可以使用100次
         "used_orders": 3 // 该优惠码目前已被3个订单使用
         "allow_plans": "all" // 该优惠码适用于该门店下的所有服务项目
      },
      {
         "code": "6CF9E6D5",
         "discount": "10.0", // 没有打折
         "cashoff": 20, // 但可享受现金抵扣20元(即:标价100元实付80元)
         "expire_at": "2018-04-30 12:00:00",
         "max_usage": 50,
         "used_orders": 22,
         "allow_plans": "newborn,family" // 该优惠码仅适用于newborn和family两个服务项目
      },
       // 如果discount小于10,且cashoff>0,则表示组合优惠(先打折再享受现金抵扣)
      {
         "code": "6DCF9E65",
         "discount": "7.0", // 先打7折
         "cashoff": 12, // 再抵扣现金12元(即:标价100元实付58元)
         "expire_at": "2018-04-30 12:00:00",
         "max_usage": 30,
         "used_orders": 10,
         "allow_plans": "newborn"
      },
   ]
}