景区订单状态查询(SPI)
收藏
我的收藏接口说明
抖音在某些场景下需要主动查询商家/第三方的日历票订单核销状态。对接方返回查询订单的核销状态,进而做下一步订单流转处理。
基本信息
Scope | life.capacity.trip_order_query | |||
权限要求 | 景区行业解决方案-景区订单状态查询 | |||
回调场景 | 景区查询订单状态 |
请求头
- •Content-Type:
application/json
- •X-Bytedance-Logid: 请求 logid, 用于问题排查用
- •x-life-clientkey: 服务商应用的 client_key
- •X-life-sign: 请求签名,签名规则
请求参数
名称 | 类型 | 是否必填 | 描述 | 示例值 |
order_id | string | 是 | 抖音侧订单 ID | 100001 |
out_order_id | string | 否 | 第三方订单 ID | 200001 |
请求示例
响应参数
名称 | 类型 | 是否必填 | 描述 | 示例值 |
data | struct | 是 | | |
- error_code | int | 是 | 错误码 | 0 |
- description | string | 是 | 错误信息 | |
- order_out_id | string | 是 | 第三方订单 ID | 20001 |
- total_voucher_quantity | int | 是 | 第三方凭证总数量 | 5 |
- used_voucher_quantity | int | 是 | 第三方凭证已使用数量 (如果返回结果带 vouchers ,则该字段表示 vouchers 中状态为 1 的数量) | 3 |
- vouchers | list | 否 | 凭证列表(部分退需要) | |
-- entrance | struct | 是 | 景区的入园项目(若入园凭证是单独的凭证,则使用此字段用来传入园凭证。若不是单独的凭证,可使用自定义项目的字段传入) | |
---project_id | string | 是 | 入园项目的唯一标识,与projects中不能重复(核销时需要) | |
---status | int | 是 | 凭证状态 0 为未使用,1 为已使用
| |
--projects | list<object> | 否 | 可自定义的项目(例:景区项目索道A、索道B等) | |
---project_id | string | 是 | 园内项目的唯一标识,与projects中不能重复(核销时需要) | |
---status | int | 是 | 凭证状态;0为未使用,1为已使用
| |
响应示例
{ "data": { "error_code": 0, "description": "success", "order_out_id": "xxx", "total_voucher_quantity": 1, "used_voucher_quantity": 1, "vouchers": [ { "entrance": { "project_id": "1712026510515261441", "status": 1 }, "projects": { "project_id": "1712026510515261442", "status": 1 } } ] } }
错误码
- •重试(最多 15次)
- ◦创建订单失败(error_code!=0 )并且 error_code!=100
- ◦服务商返回结果不符合协议,比如字段类型错误
error_code | description | 备注 |
0 | | 成功 |
1 | ... | 其他异常 |
2 | ... | 三方没有该订单 |
100 | ... | 抖音侧需要重试,其他错误码抖音不重试 |