LOGO

API文档 v1.3

最后更新:2018年8月20日

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

获取某个订单信息

通过订单号查询到该订单的详情、以及顾客一键登录的加密链接。请求路径:

GET    /orders/:order_id

通过CURL发送的请求示例:

curl -X GET -d '{"api_key":"ABC", "api_ts":1533435628, "api_sig":"...." }' -H "Content-Type: application/json" https://api.darkroom.net/v1.3/orders/123456

响应信息示例:


{
   "response": "ok",
   "error_code": 0,
   "error_msg": "",
   "order": {
      "id": "ABC1234", // 订单的唯一编号
      "date": "2018-08-05", // 订单的拍摄日期
      "hour": "10:30:00", // 订单的拍摄时间场次
      "status": "created", // 订单的当前状态(pending:尚未确认预约;created:预约成功/等待拍摄;uploading:原片上传中;choosing:顾客选片中;dispatching:需安排后期修片师;processing:后期修片进行中;downloading:顾客可下载;printing:产品印制中;closed:订单已完成;paused:有问题/暂停中;absent:爽约/未拍摄;canceled:订单已取消)
      "store_id": "xihu-store", // 订单所属的门店编号
      "created_at": "2018-08-05 16:38:33", // 订单的生成时间
      "coupon_code": "XXYYZZ", // 订单的优惠码
      "plans": [ // 订单里所包含的全部服务项目
         {
            "id": "newborn", // 服务项目的编号
            "name": "新生儿写真", // 服务项目的名称
            "price": "700.00", // 服务项目的实际成交价
            "number": 1
         },
         {
            "id": "family",
            "name": "亲子写真",
            "price": "500.00",
            "number": 1
         }
      ],
      "total_price": "1200.00", // 订单的总价
      "prepay": { // 已支付订金
         "amount": "200.00", // 已支付订金的金额
         "method": "ali",    // 订金的支付方式(alipay:支付宝接口;weixin:微信支付接口;wxmp:微信小程序支付;ali:支付宝(手动);wx:微信(手动);pos:POS机刷卡;bank:银行转账;manual:现金;card:会员储值卡;tb:淘宝;kbei:口碑网;grp:团购券;cp:优惠券;other:其它)
         "remark": "交易号:1234567890" // 订金备注
      },
      "contact": { // 实际拍摄人
         "name": "董小姐",
         "gender": "female",
         "area_code": "+86",
         "mobile": "13011112222",
         "email": "test_customer@example.com"
      },
      "kid": { // 参与拍摄的儿童
         "name": "董小弟",
         "gender": "boy",
         "birthday": "2016-08-02",
         "age": "年龄2岁"
      },
      "customer_remark": "", // 顾客在预约时留下的备注
      "team_remark": "", // 工作人员针对该订单的内部备注
      "auto_login_url": "https://..." // 给顾客一键登录选片下载的加密链接
   },
   "customer": { // 订单所属的顾客资料
      "id": "3456789", // 顾客的唯一编号
      "name": "董小姐", // 顾客的称呼
      "store_id": "xihu-store", // 顾客所属的门店编号
      "area_code": "+86",
      "mobile": "13011112222",
      "email": "test_customer@example.com",
      "gender": "female",
      "order_ids": [ // 顾客已预约过的所有订单编号
         "ABC1234",
         "XYZ5678",
      ]
   }
}

  • Made with
  • 杭州 滨江区