68 lines
2.3 KiB
Markdown
68 lines
2.3 KiB
Markdown
公共入参
|
||
参数名 类型 必须 详情描述
|
||
appkey String 是 平台分配的appId
|
||
version String 是 请求的API版本号，目前版本为1
|
||
timestamp Long 是 发起请求的Unix时间戳，单位为毫秒
|
||
|
||
|
||
服务入参
|
||
参数名 类型 必须 详情描述
|
||
oid String 是 快手订单号，示例：2319100000003246
|
||
eticketId String 否 电子凭证id，非必传
|
||
sendType String 是 卡券类型：虚拟卡-VIRTUAL （默认）实体卡-DELIVERY
|
||
eticketType String 否 业务类型：咨询快手开发同学，示例：DINING_OPEN_TICKET
|
||
ext String 否 额外字段，供商家使用
|
||
|
||
|
||
服务出参
|
||
参数名 类型 详情描述
|
||
result Integer 返回码，必传，1-成功、4012002-订单不存在、4012005-卡券不存在，必须按照错误码规范返回。「错误码规范」请参考对接文档。
|
||
errorMsg String 错误信息，非必传，当result != 1时必须返回明确且清晰的错误信息。禁止返回「null」、「无法排查的信息」、「error」等
|
||
data EticketsDetail 业务结果，非必传，当result=1时必须返回data
|
||
oid String 必传
|
||
快手订单号。示例：2319200000001216
|
||
sendType String 必传
|
||
卡券类型：虚拟卡-VIRTUAL （默认）实体卡-DELIVERY
|
||
sendNum Integer 必传
|
||
已发货数量，必须等于etickets列表的num之和
|
||
etickets List<ETicket> 必传
|
||
商家发码的卡券列表
|
||
id String 必传
|
||
卡号
|
||
code String 非必传，实体卡号，大闸蟹业务专用
|
||
status String 必传
|
||
未使用：UNUSED；
|
||
已消费(至少消费1次)：CONSUMED；
|
||
已销毁：DESTROYED；
|
||
num Integer 必传
|
||
数量，示例：1
|
||
validStartTime Long 必传
|
||
有效期：开始时间，毫秒时间戳
|
||
validEndTime Long 必传
|
||
有效期：结束时间，毫秒时间戳
|
||
eticketConsumeDetails List<EticketConsumeExt> 非必传
|
||
核销拓展信息
|
||
serialNum String 必传
|
||
核销流水号
|
||
consumeType String 必传
|
||
核销类型
|
||
consumeTime Long 必传
|
||
核销时间
|
||
appointmentTime Long 非必传
|
||
预约时间
|
||
storeName String 非必传
|
||
门店名称
|
||
storeAddress String 非必传
|
||
门店地址
|
||
expressCode String 非必传
|
||
物流编号
|
||
expressName String 非必传
|
||
物流名称
|
||
expressNo String 非必传
|
||
单
|
||
reason String 非必传
|
||
销毁原因
|
||
ext String 非必传
|
||
拓展字段
|
||
eticketType String 非必传
|
||
电子凭证类型，跟商家想要入驻的类目相关联，示例： DINING_OPEN_TICKET |