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

qimen.alibaba.alsc.merchant.spi.ext.ticket.send (同步发码通知)

同步发码通知

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
ticket_request_id String 必须 20190729111040030200660600011777
  • 最大长度:64
  • 业务请求id
    order_no String 必须 20190917001640000300330080685221
  • 最大长度:64
  • 口碑子订单号, 即alsc_sub_order_no
    alipay_partner_id String 必须 2088001969797048
  • 最大长度:32
  • 口碑商户PID
    merchant_id String 可选 625644896785646464
  • 最大长度:64
  • 码商合作商户Id
    send_order_no String 必须 20190917001640000300330080685221
  • 最大长度:64
  • 口碑商品发货单号
    mobile String 可选 13888888888
  • 最大长度:11
  • 手机号码
    item_id String 必须 2017122020076004000022044209
  • 最大长度:64
  • 口碑商品Id
    item_title String 必须 商品标题
  • 最大长度:128
  • 商品标题
    out_item_id String 必须 外部商品id
  • 最大长度:64
  • 外部商品id
    amount String 必须 2
  • 最大长度:10
  • 发码份数,可以理解为商品购买数量
    frequency String 可选 3
  • 最大长度:10
  • 次卡可用次数,非次卡不返回
    valid_start String 必须 2019-12-21 23:11:23
  • 最大长度:32
  • 码的有效期开始时间 时间格式 yyyy-MM-dd HH:mm:ss
    valid_end String 必须 2019-12-21 23:11:23
  • 最大长度:32
  • 码的有效期结束时间 时间格式 yyyy-MM-dd HH:mm:ss
    send_token String 必须 2017122020076004000022044209
  • 最大长度:32
  • 验证串,码商回调发码时必须回传,否则验证失败,同一笔订单的token唯一不变
    ticket_ids String [] 可选
  • 最大列表长度:999
  • ["\"id1\""],实际都有值, 网关自动加的转义字符,对接方需兼容
    tp_order_no String 可选 20190917001640000300330080685220 口碑tp主订单号
    tp_sub_order_no String 可选 20190917001640000300330080685222 口碑tp子订单号
    alsc_order_no String 可选 20190917001640000300330080685223 口碑主订单号
    buyer_pay_amount String 可选 45.00 用户实付金额,单位为元,精确到小数点后两位,单个商品购买多份的场景,返回总商家实收金额
    receipt_amount String 可选 49.00 商家实收金额,单位为元,精确到小数点后两位,单个商品购买多份的场景,返回总商家实收金额
    discount_amount String 可选 1.00 商家优惠金额,单位为元,精确到小数点后两位,单个商品购买多份的场景,返回总商家优惠金额
    koubei_subsidy_amount String 可选 4.00 口碑补贴金额,单位为元,精确到小数点后两位,单个商品购买多份的场景,返回总口碑补贴金额

    响应参数

    名称 类型 示例值 描述
    ma_list TicketMa [] 码列表,sync_deliver=true时必填
    • └ password
    • String
    • 23123123213
    • 码密码,可选
    • └ num
    • String
    • 8
    • 份数
    • └ ticket_code
    • String
    • 1232312323122312
    • 码值 code。核销二维码生成规则:优先用url生成,url为空,再用code生成。
    • └ url
    • String
    • xxx
    • 三方核销url。核销二维码生成规则:优先用url生成,url为空,再用code生成。
    • └ ticketId
    • String
    • xxxx
    • 本地凭证id(对应入参ticket_ids中的id)
    biz_code String success 业务返回码,"success"为成功,其他为失败
    biz_msg String 交易已被支付 业务返回码描述
    biz_success String success 接口调用成功,传固定值"success"
    sync_deliver Boolean true 代表是同步发码还是异步发码
    can_retry Boolean false 业务失败时,can_retry代表是否可以重试发码, can_retry=ture,本地侧会重试调用发码, can_retry=false 本地侧会推进到发货失败,不重试

    请求示例

    {"order_no":"20190917001640000300330080685221","valid_end":"2019-12-21 23:11:23","ticket_request_id":"20190729111040030200660600011777","amount":"2","send_token":"2017122020076004000022044209","item_id":"2017122020076004000022044209","discount_amount":"1.00","alsc_order_no":"20190917001640000300330080685223","mobile":"13888888888","merchant_id":"625644896785646464","tp_order_no":"20190917001640000300330080685220","alipay_partner_id":"2088001969797048","frequency":"3","tp_sub_order_no":"20190917001640000300330080685222","valid_start":"2019-12-21 23:11:23","ticket_ids":[""],"send_order_no":"20190917001640000300330080685221","out_item_id":"外部商品id","receipt_amount":"49.00","item_title":"商品标题","buyer_pay_amount":"45.00","koubei_subsidy_amount":"4.00"}

    响应示例

    {
        "ma_list":[
            {
                    "password":"23123123213",
                    "num":"8",
                    "ticket_code":"1232312323122312",
                    "url":"xxx",
                    "ticketId":"xxxx"
            }
        ],
        "biz_code":"success",
        "biz_msg":"交易已被支付",
        "biz_success":"success",
        "sync_deliver":true,
        "can_retry":false
    }

    验签示例

    {"biz_code":"sign-check-failure","biz_msg":"Illegal request","biz_success":"INVOKE_FAIL"}

    错误码解释

    错误码 错误描述 解决方案
    response-body-parse-error
    isp.http-read-timeout

    API工具

    FAQ

    返回
    顶部