支付宝

同步商家券券码

开发环境

POST

/v3/alipay/marketing/ordervoucher/activity/{activity_id}/voucher/codedeposit

alipay.marketing.activity.ordervoucher

商家调用该接口同步导入商家券券码，接口同步返回导入结果。请在接收alipay.marketing.activity.message.created消息后，再进行调用。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://dev-cn.your-api-server.com/v3/alipay/marketing/ordervoucher/activity//voucher/codedeposit' \
--header 'Content-Type: application/json' \
--data-raw ''

响应示例

200 - 示例 1

{
  "fail_count": 1,
  "fail_voucher_code_detail_list": [
    {
      "error_code": "VOUCHER_CODE_DUPLICATE",
      "error_msg": "与之前导入的券码重复",
      "voucher_code": "789CE"
    }
  ],
  "success_count": 2,
  "success_voucher_code_list": "[\"123AB\",\"45zz6\"]"
}

请求参数

Path 参数

activity_id

string

活动id

必需

Body 参数application/json

merchant_access_mode

string

商户接入模式

可选

示例值:

AGENCY_MODE

out_biz_no

string

可选

外部业务单号，用作幂等控制。幂等作用：参数不变的情况下，再次请求返回与上一次相同的结果。外部接入方需保证业务单号唯一。

示例值:

20170101000001654bb46ba

voucher_codes

array[string]

可选

券码的数量列表。接口参数为列表类型。限制：目前最大上传 1000 个。单个code最长64位。商户上传的券code列表，code允许包含的字符有0-9、a-z、A-Z、-、_、+、=、|。

示例值:

["123AB","45zz6","789CE"]

示例

返回响应

🟢200common response

application/json

Body

fail_count

integer

导入失败的券码数量

可选

示例值:

fail_voucher_code_detail_list

array[object (FailVoucherCodeDetail) {3}]

可选

上传失败券码详情列表，包括上传失败的券码及对应的错误码和错误原因

error_code

string

券码导入失败错误码

可选

示例值:

VOUCHER_CODE_DUPLICATE

error_msg

string

可选

券码导入失败错误原因描述

示例值:

与之前导入的券码重复

voucher_code

string

导入失败的券码

可选

示例值:

789CE

success_count

integer

导入成功的券码数量

可选

示例值:

success_voucher_code_list

array[string]

上传成功的券码列表

可选

示例值:

["123AB","45zz6"]

🔴500请求失败

修改于 2023-11-22 05:56:24

创建商家券活动

券活动修改通知