发起收银
接口说明
- 需要保证同一应用下每笔订单的 out_order_id 是唯一的
- 请做好 out_order_id 的订单创单幂等,超时可重试
- 国补订单每次仅能输入一行消费商品明细,将根据线下提供的买单门店和商品进行校验,若不符合则无法提交,有问题可联系平台BD 或 对接运营
- 国补订单分两种实名模式,默认是商家传入模式;企补订单无需传实名逻辑,若传入不阻碍,抖音不会消费
- 商家传入模式,需要传入用户实名信息(merchant_user_info)
- 抖音实名模式,不需要传入用户实名信息(merchant_user_info)
- 发起收银后超1h未支付系统会自动取消订单,可以接【订单取消消息通知Webhook】 感知取消动作
使用限制
SLA:支持的最大QPS:50;PCT99承诺值:100ms;
基本信息
| 名称 | 描述 |
|---|---|
| HTTP URL | https://open.douyin.com/goodlife/v1/homed/trade/payment/order/create/ |
| HTTP Method | POST |
| Scope | life.capacity.homed.trade.payment.order.create |
| 权限要求 |
|
请求参数
请求头
access-token必填String
示例:clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-type必填String
固定值"application/json"
Rpc-Transit-Life-AccountString
来客商户根账户ID
Body展开全部子属性
account_id必填String
必填,商家账户id
out_order_id必填String
必填,第三方订单ID(可作幂等键)
校验:String[0,50]
poi_id必填String
必填,抖音POI_ID(即门店id)
amountStruct
必填,金额信息
展开子属性
co_managed_poi_idString
开单时对应的被托管门店id,在共管全托管模式且由托管账户发起建单的场景下使用
craftsman_uidString
开单时对应的职人uid,平台若存在激励活动时的发放对象,优先级低于job_number
government_subsidy_order_typeInt32
下单类型: 0 普通下单;1 国补下单; 2 企补下单
job_numberString
开单时对应的店员工号,平台若存在激励活动时的发放对象,对应来客后台的职人工号字段
merchant_user_infoStruct
用户实名信息
展开子属性
remarkString
备注
校验:String[0,255]
sku_listList
必填,商品信息
展开子属性
voucher_info_listList
代金券优惠信息
展开子属性
请求示例
curl --location --request POST 'https://open.douyin.com/goodlife/v1/homed/trade/payment/order/create/' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \ --data '{"co_managed_poi_id":"EL9BipTfGh","amount":{"enterprise_subsidy_discount_amount":274637064570801487,"platform_subsidy_discount_amount":8328846298478037308,"total_amount":8875363110914894766,"pay_amount":5025880175517073334,"payment_coupon_amount":478219728429302942,"non_disaccountable_amount":2842201043975144348,"discount_amount":2545117354340562495,"after_discount_amount":3069555365840023073},"government_subsidy_order_type":2801846497120846779,"remark":"mQJXbf1T98","government_subsidy_info":"fO7mP6Gn6f","voucher_info_list":[{"voucher_amount":4843331739612321253,"voucher_code_type":4969011506747093032,"voucher_order_id":"q2UxYZwUuE","voucher_code":"L3s1FmoAx6"}],"account_id":"ZmbkM39A34","job_number":"WOY0KRDEGb","merchant_user_info":{"delivery_address":"YWl2tApGne","province_code":"4HjdhcwLnt","phone_number":"VWQNkSfQyq","city_code":"r6ZKVX1DII","identity_type":8268449653151400665,"district_code":"u99d1STTcS","identity_code":"1466PAXOJh","identity_name":"Xp8ir2P6AY"},"craftsman_uid":"rVMSJTpG2n","poi_id":"HNIJ8T9ShE","sku_list":[{"government_subsidy_info":"Ie7ID0f5hq","product_title":"JpLUFqkIVW","count":6335265561094049081,"unit_amount":820317712642458994}],"out_order_id":"lCyC0J7SPw"}'
响应参数
Body展开全部子属性
data必填Struct
展开子属性
extra必填Struct
扩展信息
展开子属性
applet_jump_urlString
订单详情页跳转短链(用于抖音小程序打开,暂不开放)
c_jump_short_urlString
订单详情页跳转短链(用于抖音app扫码打开)
external_jump_urlString
订单详情页跳转短链(用于从顾客手机的其它APP打开,全量开放)
pre_order_idString
抖音预订单ID
响应示例
正常响应示例异常响应示例
{ "external_jump_url": "gD2SHdMOha", "applet_jump_url": "ekMDqD7NAx", "extra": { "error_code": 0, "description": "", "sub_error_code": 0, "sub_description": "", "logid": "20260312135939BDE9F268A1BCD6EBB665", "now": 1773295182 }, "pre_order_id": "DzFvni0Dvg", "c_jump_short_url": "Ci9UbZ1DAb", "data": { "error_code": 0, "description": "" } }
错误码
| HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
|---|---|---|---|
| 200 | 2100001 | 未知错误 | 重试接口,重试3次仍报错联系抖音生活服务技术支持 |
| 200 | 2100004 | 系统繁忙,此时请开发者稍候再试 | 重试接口,重试3次仍报错联系抖音生活服务技术支持 |
| 200 | 2100005 | 参数不合法 | 更换参数 |
| 200 | 2119001 | 参数不合法 | 更换参数 |
| 200 | 2119002 | 系统繁忙,请稍候再试 | 重试 |
| 200 | 2119003 | 请求太过频繁,请稍后再试 | 重试 |
| 200 | 2119005 | 应用未获商家授权 | 联系合作商家在商家后台发起授权,并在服务商后台同意授权 |
| 200 | 2190002 | access_token无效 | 调用接口重新生成access_token |
| 200 | 2190004 | 应用未获得该能力, 请去https://open.douyin.com/申请 | 应用申请接口权限 |
| 200 | 2190008 | access_token过期,请刷新或重新授权 | 规范token刷新机制,检查是否有测试环境在同步刷新token |
| 200 | 3000001 | 根据实际业务错误返回 | 对照接口文档规范参数并重试 |
| 200 | 5000001 | 根据实际业务错误返回 | 联系抖音处理 |
| 200 | 3000003 | 以实际错误信息为准 | 联系抖音 |
| 200 | 3000002 | 以实际错误信息为准 | 联系抖音 |
| 200 | 3000001 | 以实际错误信息为准 | 对照接口文档规范参数修改参数并重试 |
| 200 | 5000001 | 系统错误,请重试 | 多次重试失败请联系抖音处理 |
| 200 | 3000001 | 以实际错误信息为准 | 详细错误描述信息 |
| 200 | 5000001 | 系统错误,请重试 | 多次重试失败请联系抖音处理 |
| 200 | 3000004 | 以实际错误信息为准 | 联系抖音 |
| 200 | 3000005 | 以实际错误信息为准 | 联系抖音 |
| 200 | 3000006 | 以实际错误信息为准 | 联系抖音 |
| 200 | 3000007 | 以实际错误信息为准 | 联系抖音 |
| 200 | 3000009 | 以实际错误信息为准 | 联系抖音 |
| 200 | 3000010 | 以实际错误信息为准 | 联系抖音 |
| 200 | 3000011 | 以实际错误信息为准 | 联系抖音 |
| 200 | 3000012 | 以实际错误信息为准 | 联系抖音 |
| 200 | 3000013 | 以实际错误信息为准 | 联系抖音 |
| 200 | 3000014 | 以实际错误信息为准 | 联系抖音 |
| 200 | 3000015 | 以实际错误信息为准 | 联系抖音 |
| 200 | 3000001 | 以实际错误信息为准 | 详见错误描述信息 |
| 200 | 3000019 | 以实际错误信息为准 | 详见错误描述信息 |
| 200 | 3000020 | 以实际错误信息为准 | 详见错误描述信息 |
