yml2213
f38efa2edf
- 新增 4 个回调接口：send-code/destroy-code/query-code/consume-code - 支持快手开放平台 MD5/HMAC_SHA256 签名验签 - send-code 回调自动创建 order/order_items/fulfillment_tasks/profiles - consume-code 回调与既有 flow.consume 结构兼容 - isKuaishouCloudTask 同时匹配 kuaishou-industry executor_key - claim 页面自动验证行业凭证 task，跳过核销码输入 - 退回时行业 task 跳过快手核销 API - 新增 KUASHOU_INDUSTRY_* 环境变量配置
59 lines
3.2 KiB
Markdown
59 lines
3.2 KiB
Markdown
integration.callback.virtual.eticket.consume
|
||
需用户授权
|
||
POST
|
||
电子凭证核销回调接口
|
||
更新时间: 2022-05-11 16:24:16
|
||
电子凭证核销回调接口
|
||
系统环境
|
||
环境 域名
|
||
线上环境（推荐） https://openapi.kwaixiaodian.com
|
||
线上环境（备用） https://open.kwaixiaodian.com
|
||
系统参数
|
||
参数名 类型 必须 详情描述
|
||
appkey String 是 平台分配的appId
|
||
timestamp Number 是 发起请求的Unix时间戳，单位为毫秒
|
||
access_token String 是 访问token，所有需用户授权API使用code模式获取，不需要用户授权API使用client_credentials获取，详情参考《授权说明》文档
|
||
version Number 是 请求的API版本号，目前版本为1
|
||
param JSON 是 业务参数，详见下方的请求入参
|
||
method String 是 请求的API英文名，详见各API定义
|
||
sign String 是 API入参的签名结果参数
|
||
signMethod String 是 签名算法，支持HMAC_SHA256和MD5，推荐使用HMAC_SHA256
|
||
请求参数
|
||
参数名 类型 必须 示例值 详情描述
|
||
oid String 是 231412412 快手订单号
|
||
etickets List<ETicket> 是 [{}] 电子凭证
|
||
id String 是 12313 电子凭证ID
|
||
code String 否 2131412 电子凭证Code（实体卡的Code）
|
||
num Integer 是 1 核销数量(订单数量)
|
||
goodsValue Long 否 10 销毁的总货值
|
||
status String 否 "SUCCESS","FAILED" "SUCCESS","FAILED"
|
||
销毁成功/失败
|
||
consumeTime Long 否 1543843735000 核销时间(消费者核销的时间)
|
||
status String 是 核销状态: 核销成功-CONSUMED 预约成功-APPOINTED 核销状态:
|
||
核销成功-CONSUMED
|
||
预约成功-APPOINTED
|
||
consumeType String 是 门店消费-consume， 门店自提-pickup， 物流发货-delivery， 预约发货-appointment_delivery 核销方式：
|
||
默认请使用
|
||
consume，其他场景请与产研沟通
|
||
storeName String 否 XXX线下店 核销门店名称(门店消费、门店自提时必传)
|
||
storeAddress String 否 XXX路CCC号 核销门店地址(门店消费、门店自提时必传)
|
||
expressNo String 否 EMS 仅在consumeType为预约发货场景下生效。
|
||
物流方式：圆通/韵达/顺丰/EMS(物流发货、预约发货方式必传)
|
||
expressCode String 否 12412412 仅在consumeType为预约发货场景下生效。
|
||
快递单号(预发发货方式必传)物流发货、预约发货方式必传)
|
||
appointmentTime String 否 123124124234523 仅在consumeType为门店自提场景下生效。
|
||
预约时间(预约发货方式必传)
|
||
eticketType String 否 DINING_OPEN_TICKET/DEFAULT_MEDICAL_TICKET 电子凭证类型，跟商家想要入驻的类目相关联，非必传，默认
|
||
DINING_OPEN_TICKET
|
||
ext String 否 {"key":"value"} 扩展信息(JSON格式)
|
||
token String 是 sdjafljasdlflnlxjlfjasldjfljkaw 鉴权Token，订单操作维度，在发码通知接口中下发
|
||
seriallNum String 否 D4F2D111FGG2341GH 核销序列号，对应某一次核销行为，必填！冲正时必须带上该值！
|
||
consumePoiId Long 否 657765522 消费门店的poi信息，必须是快手的POI，如果是百度、腾讯等图商的POI，请先用POI转换接口，将图商POI转换成快手POI
|
||
返回参数
|
||
参数名 类型 示例值 详情描述
|
||
code String 1 主返回码
|
||
msg String success 主返回信息
|
||
sub_code String 1 子返回码
|
||
sub_msg String success 子返回信息
|
||
result Integer 1 1-成功；其他-失败
|
||
error_msg String success 错误信息 |