淘宝开放平台

登录
文档中心 > API类目 > 本地生活商户基础API

本地生活商户基础API

qimen.alibaba.alsc.merchant.spi.ext.ticket.query (凭证查询)

凭证查询

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
ticket_request_id String 必须 20190729111040030200660600011777
  • 最大长度：64
    		•  业务请求id
    ticket_codes String [] 必须
  • 最大列表长度：256
    		•  外部凭证code列表
    seller_id String 必须 2214167549216
  • 最大长度：32
    		•  口碑sellerId
    external_ticket_codes ExternalTicketCode 可选
  • 最大长度：64
    		•  服务商凭证列表
    • └ ticket_code
    • String
    • 可选
    • 123456789
    • 服务商码值
    • └ ticket_id
    • String
    • 可选
    • 2208185382357937167
    • 口碑凭证id

    响应参数

    名称 类型 示例值 描述
    ma_list TicketMa [] 凭证列表
    • └ valid_end
    • String
    • 2022-08-12 12:01:56
    • 码的有效期结束时间 时间格式 yyyy-MM-dd HH:mm:ss
    • └ valid_start
    • String
    • 2022-11-12 12:01:56
    • 码的有效期开始时间 时间格式 yyyy-MM-dd HH:mm:ss
    • └ num
    • String
    • 1
    • 总份数
    • └ quantity
    • String
    • 2
    • 可核销份数
    • └ total_count
    • String
    • 1
    • 总份数
    • └ status
    • String
    • INIT
    • 凭证状态:INIT=初始化,EFFECTIVE=可使用,USED=已使用,CANCELED=已作废
    • └ ticket_code
    • String
    • A123456789
    • 服务商码值
    • └ ticket_id
    • String
    • 2208185382357937167
    • 口碑凭证id
    biz_success String success 调用是否成功
    biz_code String success 返回错误码
    biz_msg String biz_success 返回错误信息

    请求示例

    {"ticket_request_id":"20190729111040030200660600011777","ticket_codes":[""],"seller_id":"2214167549216","external_ticket_codes":{"ticket_code":"123456789","ticket_id":"2208185382357937167"}}

    响应示例

    {
    "ma_list":[
        {
                "valid_end":"2022-08-12 12:01:56",
                "valid_start":"2022-11-12 12:01:56",
                "num":"1",
                "quantity":"2",
                "total_count":"1",
                "status":"INIT",
                "ticket_code":"A123456789",
                "ticket_id":"2208185382357937167"
        }
    ],
    "biz_success":"success",
    "biz_code":"success",
    "biz_msg":"biz_success"
}

    验签示例

    {"biz_code":"sign-check-failure","biz_msg":"Illegal request","biz_success":"不等于success"}

    错误码解释

    错误码 错误描述 解决方案

    API工具

    错误码查询工具 SDK下载

    FAQ

    有用( 0 ) 我要提问
    返回
    顶部