如果您拥有其它渠道的预约系统（比如有赞商城，或独立网店），但是希望把这些渠道所收到的订单数据汇集到Darkroom「暗房」 进行统一管理，那么这个API接口正是您所需要的。「暗房」的API接口，目前仅限专业版 商家使用。使用API之前，您需要先联系DR客服生成一对API秘钥。对于中小型机构，我们更建议您直接使用「暗房」官方自带的在线预约模块。
通过传递订单信息以及关联的顾客资料，在Darkroom「暗房」后台产生一个新的订单。请求路径:
| 参数名 | 必须/可选 | 参数类型 | 备注/示例 |
|---|---|---|---|
order_id |
必须 |
字符串 |
唯一的订单编号示例值："ABC1234" |
order_date |
必须 |
字符串 |
拍摄日期示例值："2024-11-21" |
order_hour |
必须 |
字符串 |
拍摄当天的开始时间示例值："10:30:00" |
order_plans |
必须 |
JSON |
该订单所包含的服务项目的ID、单价和数量；可包含多个服务项目注意：服务项目的ID，必须与Darkroom「暗房」后台里的「系统ID」一致示例值："[{\"id\":\"newborn\",\"price\":\"100.00\",\"num\":\"1\"},{\"id\":\"family\",\"price\":\"200.00\",\"num\":\"2\"}]" |
store_id |
可选 |
字符串 |
订单所属的门店编码（如果只有一家门店，本字段可留空）注意：门店的编码，必须与Darkroom「暗房」后台里的「门店编码」一致示例值："xihu-store" |
customer_name |
必须 |
字符串 |
顾客的名字(称呼)示例值："董小姐" |
customer_mobile |
必须 |
字符串 |
顾客的手机号示例值："13011112222" |
customer_gender |
可选 |
字符串 |
顾客的性别
|
customer_area_code |
可选 |
字符串 |
顾客手机号的国家代码，默认为+86；
|
customer_email |
可选 |
字符串 |
顾客的电子邮箱示例值："test_customer@example.com" |
wx_openid |
可选 |
字符串 |
顾客的微信OpenID示例值："oT7gusAoz1IEesyqEvPDTPVATK4I" |
wx_avatar |
可选 |
字符串 |
顾客的微信头像的图片网址示例值："http://thirdwx.qlogo.cn/mmopen/..." |
kid_name |
可选 |
字符串 |
参与拍摄的儿童的名字示例值："董小弟" |
kid_gender |
可选 |
字符串 |
参与拍摄的儿童的性别
|
kid_birthday |
可选 |
字符串 |
参与拍摄的儿童的生日示例值："2016-08-02" |
created_at |
可选 |
字符串 |
订单的生成时间（如果留空，则自动设置为API发起时间）示例值："2024-11-21 17:03:45" |
customer_remark |
可选 |
字符串 |
顾客写的备注示例值："我会自己化妆过来，不需要化妆师" |
team_remark |
可选 |
字符串 |
员工内部备注（对顾客不可见）示例值："这是张总介绍的重要顾客" |
prepay_amount |
可选 |
字符串 |
顾客预约时支付的订金金额示例值："120.00" |
prepay_method |
可选 |
字符串 |
订金的支付方式代码
|
prepay_remark |
可选 |
字符串 |
关于订金的备注示例值："交易号ABC1234567890XZY" |
curl -X POST -d '{"api_key":"ABC", "api_ts":1533435628, "api_sig":"....", "order_plans":"[{\"id\":\"newborn\",\"price\":\"100.00\",\"num\":\"1\"}]", .... }' -H "Content-Type: application/json" https://api.darkroom.net/v1.3/orders/create
{
"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：淘宝；dp：大众点评；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",
]
}
}
