券状态批量查询
接口说明
用于批量查询抖音券码和三方券码的状态
1、支持查询提货券抖音券码和三方券码的状态。
2、核销开放过程中,如存在断网情况下,商家系统没办法及时收到核销状态,增加券状态查询接口,方便商家系统查询券码状态。
3、通过验券准备接口返回的加密 code 查询抖音券码状态。
基本信息
名称 | 描述 |
---|---|
HTTP URL | https://open.douyin.com/goodlife/v1/compre_retail/fulfilment/certificate/query/ |
HTTP Method | GET |
Scope | life.capacity.compre_retail_certificate_query |
权限要求 | 综合到店提货解决方案-提货券抖音码交易,提货券三方码交易能力 |
请求参数
请求头
access-token必填String
示例:clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-type必填String
固定值"application/json"
Query
encrypted_codeString
验券准备接口返回的加密券码
order_idString
订单id
请求示例
curl --location --request GET '/goodlife/v1/compre_retail/fulfilment/certificate/query/?encrypted_code=ffDD4CBXHx&order_id=1tLlOeYCID' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \
响应参数
Body展开全部子属性
data必填Struct
展开子属性
extraStruct
展开子属性
响应示例
正常响应示例异常响应示例
{ "data": { "certificates": [ { "additional_map": { "1": "uyILMUeXbZ" }, "amount": { "brand_ticket_amount": 8357158639585252000, "coupon_pay_amount": 7807497714196966000, "list_market_amount": 3619152578950003700, "merchant_ticket_amount": 4560406754322597400, "origin_list_market_amount": 4352579040395800000, "original_amount": 6694326159446408000, "original_currency": "A3VoTMGwWt", "pay_amount": 1837460149164296700, "payment_discount_amount": 906248503493487500, "platform_discount_amount": 5104683162675751000 }, "book_info": { "book_poi_id": "cjD4xHuEBg", "book_product_number": 3513574289915437000 }, "certificate_id": 40340243935541530, "code": "cws3HcqS5v", "encrypted_code": "e8H3fyOC0g", "expire_time": 5888656226836721000, "not_available_time_info": { "can_no_use_date": [ { "end_time": 9040272521292018000, "start_time": 5430971732306888000 } ], "can_no_use_week_day": [ 3182477009653998600 ], "fulfil_enable": false }, "off_peak_discount_info": { "has_off_peak_discount": false, "idle_time_limit_type": 1, "off_peak_time_range": [ { "daily_time_range_list": [ { "end_time": "IAapiuJ73f", "end_time_is_next_day": false, "start_time": "C0ElBGt4UD" } ], "end_time": 4482368287561413000, "start_time": 81831449023452850, "week_day_list": [ 1 ] } ] }, "period_card": { "period_type": 1 }, "reserve_info": { "order_reserve_user_info_list": [ { "credential_numb": "N7FHvcmraU", "credential_type": 1, "name": "TA0UfwjElB", "phone": "CkIeDIq1Gc" } ] }, "sku": { "account_id": "botujGbDuO", "groupon_type": 1, "market_price": 3686800331415622700, "product_id": "mt1YM5hWoB", "product_out_id": "HcVCfKrJkl", "sku_id": "d2LZwIQ4y2", "sku_out_id": "MwBaRekeyU", "sold_start_time": 559141672905138560, "third_sku_id": "ZEFaBbprkt", "title": "1o0wN21Vzg" }, "start_time": 1847684367554818000, "status": 1, "time_card": { "serial_amount_list": [ { "amount": { "brand_ticket_amount": 1593680747448080400, "coupon_pay_amount": 1992430894850719000, "list_market_amount": 1480303845681506800, "merchant_ticket_amount": 971988706139910900, "origin_list_market_amount": 788915051522937300, "original_amount": 4246645804976319000, "original_currency": "tS9JOrjB0Q", "pay_amount": 3381296529552896500, "payment_discount_amount": 7913994109094023000, "platform_discount_amount": 4774734410388958000 }, "serial_numb": 5334298521804750000 } ], "times_count": 6598224680460579000, "times_used": 4481550764903564000 }, "use_time_info": { "time_period_list": [ { "end_time": "M1qv3F85YQ", "end_time_is_next_day": false, "start_time": "TOdOYoDG8k" } ], "use_time_type": 1 }, "used_status_type": 1, "verify": { "can_cancel": false, "certificate_id": "84g0z3FKmF", "poi_id": 3392495962948926000, "times_card_serial_num": 4637733343372667000, "verifier_unique_id": "JRs2hQWQW6", "verify_id": "rJacp13kZ6", "verify_time": 8685657061963264000, "verify_type": 1 }, "verify_records": [ { "can_cancel": false, "certificate_id": "w7UEtIkEwl", "poi_id": 8762731658845330000, "times_card_serial_num": 4805067508546278000, "verifier_unique_id": "bBWgdyiT8H", "verify_id": "0HFc1dto99", "verify_time": 2573227616408257500, "verify_type": 1 } ] } ], "certificates_v2": [ { "additional_map": { "1": "CRsNJvHNQI" }, "amount": { "brand_ticket_amount": 1732774248132947000, "coupon_pay_amount": 5466668210686048000, "list_market_amount": 7153276670801893000, "merchant_ticket_amount": 5437520476186095000, "origin_list_market_amount": 263277126909104060, "original_amount": 2343392106112534000, "original_currency": "UxYzlhhvun", "pay_amount": 1246604906955555000, "payment_discount_amount": 8777412434407065000, "platform_discount_amount": 1861352403156947200 }, "book_info": { "book_poi_id": "LRpUfsBfrP", "book_product_number": 6224605326555846000 }, "certificate_id": 125451843249261810, "code": "Xol8vl0xpj", "encrypted_code": "l8J0AJdYfP", "expire_time": 4775373367967075000, "not_available_time_info": { "can_no_use_date": [ { "end_time": 9029854410889110000, "start_time": 4550403549563378000 } ], "can_no_use_week_day": [ 3252879261348353500 ], "fulfil_enable": false }, "off_peak_discount_info": { "has_off_peak_discount": false, "idle_time_limit_type": 1, "off_peak_time_range": [ { "daily_time_range_list": [ { "end_time": "XKIWBAHZwY", "end_time_is_next_day": false, "start_time": "0qSyINOln9" } ], "end_time": 4303893753096507400, "start_time": 1788299719004126700, "week_day_list": [ 1 ] } ] }, "period_card": { "period_type": 1 }, "reserve_info": { "order_reserve_user_info_list": [ { "credential_numb": "j22zeMykew", "credential_type": 1, "name": "roN2AjNcvt", "phone": "Ypnjb3Hfyv" } ] }, "sku": { "account_id": "10BKP8DcKD", "groupon_type": 1, "market_price": 7208486722720028000, "product_id": "MVAgLTWTDu", "product_out_id": "98qZmQU96G", "sku_id": "7229DtO88C", "sku_out_id": "12gF8Y6Sex", "sold_start_time": 1686581037456668000, "third_sku_id": "ixlIhTvcDs", "title": "Yvn1dj0Xjb" }, "start_time": 4495865421297407500, "status": 1, "time_card": { "serial_amount_list": [ { "amount": { "brand_ticket_amount": 3261062799856547300, "coupon_pay_amount": 7163076619342783000, "list_market_amount": 5177715257021877000, "merchant_ticket_amount": 7191692292507111000, "origin_list_market_amount": 8066336774513625000, "original_amount": 2572646666840376300, "original_currency": "1OgOzNXZA5", "pay_amount": 6421355762846010000, "payment_discount_amount": 5264689718262844000, "platform_discount_amount": 3617400034881739300 }, "serial_numb": 4750574331595699000 } ], "times_count": 6475167142850470000, "times_used": 4825116024161921000 }, "use_time_info": { "time_period_list": [ { "end_time": "ML2DvuSh3J", "end_time_is_next_day": false, "start_time": "AzjoGr2Yjk" } ], "use_time_type": 1 }, "used_status_type": 1, "verify": { "can_cancel": false, "certificate_id": "uTmR52T5nq", "poi_id": 8132391789364797000, "times_card_serial_num": 4586282792075720000, "verifier_unique_id": "4xqvR5evYz", "verify_id": "9fB2CTFYuc", "verify_time": 8841434190948871000, "verify_type": 1 }, "verify_records": [ { "can_cancel": false, "certificate_id": "uNHXTypiaL", "poi_id": 8930346993461892000, "times_card_serial_num": 2764819111680258600, "verifier_unique_id": "SWBpO7FfaZ", "verify_id": "vmsP1Kr0V5", "verify_time": 3444442507459414500, "verify_type": 1 } ] } ], "error_code": 0, "description": "" }, "extra": { "error_code": 0, "description": "", "sub_error_code": 0, "sub_description": "", "logid": "202412141738028C85F64D6CE2147AF797", "now": 1734169082 } }
错误码
HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
---|---|---|---|
200 | 2100001 | 未知错误 | 重试接口,重试3次仍报错联系抖音生活服务技术支持 |
200 | 2100004 | 系统繁忙,此时请开发者稍候再试 | 重试接口,重试3次仍报错联系抖音生活服务技术支持 |
200 | 2100005 | 参数不合法 | 更换参数 |
200 | 2190002 | access_token无效 | 调用接口重新生成access_token |
200 | 2190004 | 应用未获得该能力, 请去https://open.douyin.com/申请 | 应用申请接口权限 |
200 | 2190008 | access_token过期,请刷新或重新授权 | 规范token刷新机制,检查是否有测试环境在同步刷新token |
200 | 2119001 | 参数不合法 | 更换参数 |
200 | 2119002 | 系统繁忙,请稍候再试 | 重试 |
200 | 2119003 | 请求太过频繁,请稍后再试 | 重试 |
200 | 2119005 | 应用未获商家授权 | 联系合作商家在商家后台发起授权,并在服务商后台同意授权 |
200 | 3000001 | 根据实际业务错误返回 | 对照接口文档规范参数并重试 |
200 | 4000001 | 根据实际业务错误返回 | 补充参数 |
200 | 4000002 | 根据实际业务错误返回 | 对照接口文档规范参数并重试 |
200 | 5000001 | 根据实际业务错误返回 | 联系抖音处理 |
200 | 4000001 | 以实际错误信息为准 | |
200 | 5000001 | 服务器打瞌睡了,请稍后再试。 | |
200 | 3000001 | 以实际错误信息为准 |