预订信息校验(SPI)
收藏
我的收藏接口说明
用于消费者预订前的信息校验,包括库存和限购规则等,保障消费者提交订单后不会因为库存不足或其他业务规则被拒单
基本信息
Scope | life.capacity.trip_order_can_buy | |||
权限要求 | 景区行业解决方案-景区可订检查 | |||
回调场景 | 景区预订信息校验 |
超时时间为 2s
请求参数
名称 | 类型 | 是否必填 | 描述 | 示例值 |
account_id | string | 是 | 商家ID | |
poi_id | string | 是 | 抖音POI_ID(即门店id) | |
product_id | string | 是 | 抖音侧商品 ID | 1773200310436864 |
product_out_id | string | 否 | 第三方商品 ID | 1773200310436864 |
sku_id | string | 是 | 抖音侧票种规格 ID | 200001 |
sku_out_id | string | 否 | 第三方票种规格 ID(下单时请求有该数据) | 300001 |
count | int | 是 | 购买份数 | 3 |
traveler_info | object | 是 | 出行人群(对应商品 crowds) | |
-total_num | int32 | 是 | 出行人数 | 1 |
-diff_target_crowd | bool | 是 | 是否区分人群 | |
-crowd_list | list | 否 | 人群列表 | |
--crowd_type | int32 | 是 | 人群类型 Child=1 儿童 Adult=2 成人 Old=3 老人 Student=4 学生 Special=5 特殊人群 Male=6 男士 Female=7 女士 Group=8 团体 Couple=9 情侣 Military = 10 军人 Teacher = 11 教师 Disabled = 12 残疾 | |
--traveler_num | int32 | 是 | 此人群的适用人数 | |
amount | struct | 是 | 金额信息 | |
- pay_amount | int | 是 | 支付金额,分 | 8000 |
- origin_amount | int | 是 | 原始金额,分 | 10000 |
buyer | struct | 否 | 购买人信息,默认只强制留手机号(下单时请求有该数据) | |
- name | string | 是 | 姓名,加密,可能为空串,默认不强制购买人留姓名 | 小明 |
- phone | string | 是 | 联系电话,加密,肯定有 | 17812342702 |
book_start_day | string | 是 | 日历票下单参数,预定开始日期,yyyy-MM-dd | 2023-03-15 |
book_end_day | string | 是 | 日历票下单参数,预定结束日期,yyyy-MM-dd | 2023-03-16 |
tourists | list<struct> | 否 | 日历票下单参数,出行人信息(提单时无此字段) | |
- name | string | 否 | 姓名,加密 | 小红 |
- phone | string | 否 | 联系电话,加密 | 18112345678 |
- license_type | int | 否 | 证件类型 1 身份证 2 港澳通行证 3 台湾通行证 4 回乡证 5 台胞证 6 护照 7 外籍护照 8 外国人永久居留证 | 1 |
- license_id | string | 否 | 证件 ID,加密 | 11204416541220243X |
refund_rule | struct | 否 | 日历票下单参数,退改规则 | |
-auto_refund_time | int | 否 | 自动退,离园日 24 时往后推的秒数 | |
-can_refund_partly | bool | 否 | 是否支持部分退 | |
- refund_type | int | 是 | 退改类型,1 未使用随时退,2 不可退,3 有条件退 | 3 |
- refund_details | list<struct> | 否 | 退改详情,支持多个阶梯退 | |
-- refund_time | int | 是 | 当退改类型为有条件退时必填,入园日 24 时往前倒推的秒数 | 21600 |
-- refund_fee_type | int | 是 | 当退改类型为有条件退时必填,退改手续费类型,1 金额,2 比例 | 2 |
-- refund_fee | int | 是 | 当退改类型为有条件退时必填,退改手续费,如果类型为金额则单位为分,如果类型为比例则单位为万分位 | 1234 |
ticket_rule | struct | 是 | 票务规则,包含凭证方式、券码类型、券码服务商 | |
- code_sending_info | list<int32> | 是 | 凭证发放方式,多选 (建议全部写入list,凭证回调时,如果有额外类型的凭证会报错) | 1 身份证 2 券号 3 券码 6 链接URL[新增] |
- code_type | int32 | 是 | 券码类型,日历票 code_type = 2 | 2 第三方券 |
- url_type | int32 | 否 | 如果code_sending_info=6 凭证类型为url,则必填 | 1 静态二维码 2 其他 |
ticket_specification | struct | 否 | 日历票下单参数,票种规格说明 | |
- ticket_session | strcut | 否 | 场次 | |
-- ticket_session_name | string | 是 | 名称 | 上午场 |
-- ticket_session_time | string | 否 | 时间 | 8:00-9:00 |
- ticket_seat | string | 否 | 坐席 | 普通座 |
- ticket_area | string | 否 | 区域 | 上行 |
请求示例
响应参数
名称 | 类型 | 是否必填 | 描述 | 示例值 |
data | struct | 是 | | |
- error_code | int | 是 | 错误码,合法范围为 [0,999999] | 0 |
- description | string | 是 | 错误信息 | |
响应示例
{ "data": { "error_code": 0, "description": "", } }
错误码
error_code | 错误场景描述 | 商家原因描述(可自定义返回) |
0 | 成功 | |
1 | 库存不足 | |
2 | 商品已下架 | |
3 | 当前出行人已购票 | |
4 | 当前日期不可预订 | |
5 | 年龄不符合,仅限指定年龄的用户购买 | |
6 | 性别不符合,仅限指定性别的用户购买 | |
7 | 身份证限购,用户已达购买上限 | |
8 | 手机号限购,用户已达购买上限 | |
9 | 订单购买数量超过上限 | |
10 | 用户地区不符合,仅限特定地区的用户购买 | |
11 | 其他原因限购(请返回具体原因) | |
12 | 缺少手机号信息 | |
13 | 缺少证件信息 | |
14 | 缺少出行人姓名 | |
15 | 出行人数和份数不匹配 | |
19 | 手机号格式问题 | |
20 | 证件号格式问题 | |
21 | 姓名格式问题 | |
22 | 商家账户余额不足,无法下单(服务商场景使用) | |
23 | 价格不一致 | |
100 | 商家系统内 部异常,需要抖音侧重试调用 | |
999999 | 其他原因不可预订,请返回具体原因(抖音不重试调用) | |