接口说明

提货券抖音券码的核销，每次都需要先调用本接口，优先查询订单的券列表，选择要验的券，再调用验券接口，核销券码，验券准备和验券接口的调用次数需要一一对应，如已经调用验券接口验券成功，则当前二维码会失效，无法继续使用验券准备接口，需要使用刷新的二维码再进行调用。

二维码扫出来是一个短链，示例：https://v.douyin.com/eHHc1ft/ ，扫码后并调用本接口可返回当前订单下可用的全部券码信息，如未返回券码信息，则说明该订单此刻无可用券码。
对短链做 HTTP 请求。得到对应的长链接是https://www.iesdouyin.com/share/commerce/coupon/I0ZwZEZpb2U1N0pjQVZxS2NJRTFSQW5WK1c4bmxvbnNWdUQ2Wk85Y1N0eHpRUFpMMmZwNTdFM2NKeWlFNDM2QT0/?schema_type=13&object_id=I0ZwZEZpb2U1N0pjQVZxS2NJRTFSQW5WK1c4bmxvbnNWdUQ2Wk85Y1N0eHpRUFpMMmZwNTdFM2NKeWlFNDM2QT0&utm_campaign=client_scan_share&app=aweme&utm_medium=ios&tt_from=scan_share&iid=&utm_source=scan_share。
链接中object_id参数的值即为本接口传入的 encrypted_data 参数 I0ZwZEZpb2U1N0pjQVZxS2NJRTFSQW5WK1c4bmxvbnNWdUQ2Wk85Y1N0eHpRUFpMMmZwNTdFM2NKeWlFNDM2QT0

请仅感知链接中的 object_id 参数。其他的参数、域名、路径等信息请不要感知。以后都有优化和调整的可能。

定期清理过期券，在清理前可以获取到已经过期的券，用此券核销会报错。
该接口只返回未使用状态的券信息。

基本信息

名称	描述
HTTP URL	https://open.douyin.com/goodlife/v1/compre_retail/fulfilment/certificate/prepare/
HTTP Method	GET
Scope	life.capacity.compre_retail_certificate_prepare
权限要求	提货券抖音码交易

请求参数

请求头

access-token必填String

示例：clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ

调用https://open.douyin.com/oauth/client_token/生成的token

content-type必填String

固定值"application/json"

Query

codeString

券码明文

encrypted_dataString

从二维码解析出来的标识

poi_idString

核销的抖音门店id

请求示例
curl --location --request GET '/goodlife/v1/compre_retail/fulfilment/certificate/prepare/?poi_id=VCMFoPKPaM&encrypted_data=OptyVP6S3U&code=EdlvJMj0mG' \
--header 'content-type: application/json' \
--header 'access-token: 0801121846735352506a356a6' \

响应参数

Body展开全部子属性

data必填Struct

响应信息

展开子属性

extraStruct

响应额外信息

展开子属性

响应示例
正常响应示例异常响应示例
{
  "data": {
    "certificates": [
      {
        "additional_map": {
          "1": "gLYzkCE5eq"
        },
        "amount": {
          "brand_ticket_amount": 3867441185569798000,
          "coupon_pay_amount": 5160352245783368000,
          "list_market_amount": 2117457468932920800,
          "merchant_ticket_amount": 2503835565768704500,
          "origin_list_market_amount": 8564077245221874000,
          "original_amount": 3902837472342583000,
          "original_currency": "ENStAilfmS",
          "pay_amount": 3082579286389351400,
          "payment_discount_amount": 1063205098010779100,
          "platform_discount_amount": 8616238783852886000
        },
        "book_info": {
          "book_poi_id": "nIISV49XhC",
          "book_product_number": 6748962138016370000
        },
        "certificate_id": 7932343023743070000,
        "code": "HxjYw433B1",
        "encrypted_code": "leZsTNWh5O",
        "expire_time": 6787605977237185000,
        "not_available_time_info": {
          "can_no_use_date": [
            {
              "end_time": 4452801127555703300,
              "start_time": 3838234080633279500
            }
          ],
          "can_no_use_week_day": [
            4577722189334577700
          ],
          "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": "M1ftrQw39l",
                  "end_time_is_next_day": false,
                  "start_time": "cf4MHPmtYo"
                }
              ],
              "end_time": 1027711906236873300,
              "start_time": 5923063437556932000,
              "week_day_list": [
                1
              ]
            }
          ]
        },
        "period_card": {
          "period_type": 1
        },
        "reserve_info": {
          "order_reserve_user_info_list": [
            {
              "credential_numb": "tVs6M3U0Nk",
              "credential_type": 1,
              "name": "sjeWNZL7QF",
              "phone": "Q6pTMsmrPX"
            }
          ]
        },
        "sku": {
          "account_id": "DGlNlteAtk",
          "groupon_type": 1,
          "market_price": 8277028370663772000,
          "product_id": "3nSvBk97Fe",
          "product_out_id": "odTqne7LrA",
          "sku_id": "666PE40dp4",
          "sku_out_id": "V96RI3ZIzw",
          "sold_start_time": 3739955144429669400,
          "third_sku_id": "dS5WA3lTdJ",
          "title": "lM9z6fno3Y"
        },
        "start_time": 2735061536387783700,
        "status": 1,
        "time_card": {
          "serial_amount_list": [
            {
              "amount": {
                "brand_ticket_amount": 1531921696635043600,
                "coupon_pay_amount": 6725688920434554000,
                "list_market_amount": 2429892162392013000,
                "merchant_ticket_amount": 3152825886887494000,
                "origin_list_market_amount": 2483381109869833700,
                "original_amount": 5619176306191517000,
                "original_currency": "4D69zNXVmp",
                "pay_amount": 666792447850474400,
                "payment_discount_amount": 9103922879232365000,
                "platform_discount_amount": 7793780499407354000
              },
              "serial_numb": 4648696713171575000
            }
          ],
          "times_count": 4047358839940373000,
          "times_used": 3629435532568429600
        },
        "use_time_info": {
          "time_period_list": [
            {
              "end_time": "f3Pyt4P4FU",
              "end_time_is_next_day": false,
              "start_time": "sadzEgI5O8"
            }
          ],
          "use_time_type": 1
        },
        "used_status_type": 1,
        "verify": {
          "can_cancel": false,
          "certificate_id": "iAlnhkTmvc",
          "poi_id": 8070251227551930000,
          "times_card_serial_num": 1675293223300007200,
          "verifier_unique_id": "ju4hJVpKYC",
          "verify_id": "tErzOX8yak",
          "verify_time": 7554596734503914000,
          "verify_type": 1
        },
        "verify_records": [
          {
            "can_cancel": false,
            "certificate_id": "UVSEGGq4Ni",
            "poi_id": 1757644867057771,
            "times_card_serial_num": 2709038175942488600,
            "verifier_unique_id": "WVCvSskMsq",
            "verify_id": "zB279oOTTv",
            "verify_time": 7954553906158809000,
            "verify_type": 1
          }
        ]
      }
    ],
    "certificates_v2": [
      {
        "additional_map": {
          "1": "vZps57vpud"
        },
        "amount": {
          "brand_ticket_amount": 1202130392913595000,
          "coupon_pay_amount": 8379094109107968000,
          "list_market_amount": 5583766321541381000,
          "merchant_ticket_amount": 5579068401647368000,
          "origin_list_market_amount": 1591039719241020000,
          "original_amount": 1021859937875618600,
          "original_currency": "WPsiIcgiFl",
          "pay_amount": 6947572112175519000,
          "payment_discount_amount": 4103972930743214000,
          "platform_discount_amount": 2548526801993584600
        },
        "book_info": {
          "book_poi_id": "qebstkxyFz",
          "book_product_number": 2568797682887414000
        },
        "certificate_id": 2904536949748909600,
        "code": "jqnDD6TULi",
        "encrypted_code": "6zEbZXqwlw",
        "expire_time": 5492009212083260000,
        "not_available_time_info": {
          "can_no_use_date": [
            {
              "end_time": 6263725936281201000,
              "start_time": 3697973942643666000
            }
          ],
          "can_no_use_week_day": [
            5603876771579188000
          ],
          "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": "1LbExmYlYD",
                  "end_time_is_next_day": false,
                  "start_time": "ghyY54DEaC"
                }
              ],
              "end_time": 2889577805313642500,
              "start_time": 3247116236708685000,
              "week_day_list": [
                1
              ]
            }
          ]
        },
        "period_card": {
          "period_type": 1
        },
        "reserve_info": {
          "order_reserve_user_info_list": [
            {
              "credential_numb": "K5UMZklsWj",
              "credential_type": 1,
              "name": "FRbAFRgV76",
              "phone": "YWVlLV93B9"
            }
          ]
        },
        "sku": {
          "account_id": "6fqzjiuVqm",
          "groupon_type": 1,
          "market_price": 3667463022261567000,
          "product_id": "MB6wsmt4Qd",
          "product_out_id": "vnNb4xlcQH",
          "sku_id": "zwQemKUr83",
          "sku_out_id": "tQTk7SDMpu",
          "sold_start_time": 7274247447161138000,
          "third_sku_id": "bDRMI3k6Cl",
          "title": "EZOLyY1KEh"
        },
        "start_time": 837148604187533400,
        "status": 1,
        "time_card": {
          "serial_amount_list": [
            {
              "amount": {
                "brand_ticket_amount": 4518458976656807400,
                "coupon_pay_amount": 4775119079461398000,
                "list_market_amount": 8215765542444716000,
                "merchant_ticket_amount": 1576981909910866400,
                "origin_list_market_amount": 1795616766323900000,
                "original_amount": 1360596770356139300,
                "original_currency": "JaK8R2QXQZ",
                "pay_amount": 9101939801810499000,
                "payment_discount_amount": 7243675626870632000,
                "platform_discount_amount": 7086693993577007000
              },
              "serial_numb": 585623278087945900
            }
          ],
          "times_count": 7900861511896660000,
          "times_used": 1285690278903750000
        },
        "use_time_info": {
          "time_period_list": [
            {
              "end_time": "R2I46w3DtK",
              "end_time_is_next_day": false,
              "start_time": "ax3hG0EyXZ"
            }
          ],
          "use_time_type": 1
        },
        "used_status_type": 1,
        "verify": {
          "can_cancel": false,
          "certificate_id": "1E8CJUWXg4",
          "poi_id": 2575221335132043300,
          "times_card_serial_num": 8517081108901292000,
          "verifier_unique_id": "MnDBDcRjm6",
          "verify_id": "u9yDjSob5k",
          "verify_time": 1697800591227924000,
          "verify_type": 1
        },
        "verify_records": [
          {
            "can_cancel": false,
            "certificate_id": "8HbXeMvfOH",
            "poi_id": 8572880140597829000,
            "times_card_serial_num": 7141385472616416000,
            "verifier_unique_id": "qEm2t51Ngm",
            "verify_id": "HBzT2okPXk",
            "verify_time": 8555983742807446000,
            "verify_type": 1
          }
        ]
      }
    ],
    "order_id": "duINQuVv7V",
    "verify_token": "NY7a2WQtex",
    "error_code": 0,
    "description": ""
  },
  "extra": {
    "error_code": 0,
    "description": "",
    "sub_error_code": 0,
    "sub_description": "",
    "logid": "2024120323342013ED90D480C60A3391D8",
    "now": 1733240060
  }
}

切换单列布局

错误码

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	5000001	服务器打瞌睡了，请稍后再试。
200	3000001	以实际错误信息为准

验券准备接口在线调试

接口说明

基本信息

请求参数

响应参数

错误码

验券准备接口