> ## Documentation Index
> Fetch the complete documentation index at: https://docs.waffo.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# 批量生成促销码

> 一次为优惠券生成 1–500 个随机促销码

为一张 `active` 的优惠券一次生成 1–500 个随机促销码。同一批的码共用相同的附加限制和 `batchId`，并在响应中一次性全部返回，例如可直接导出为一次性码的 CSV。

```
POST /v1/actions/promotion-code/generate-promotion-codes
```

**认证方式：** API Key

> [!WARNING]
>
> **务必带上 `X-Idempotency-Key`，并用同一个键重试。** 码是随机生成的，不带键重试会再生成一批。

## 请求体

| 字段 | 类型 | 必需 | 说明 |
| - | - | - | - |
| `couponId` | string | 是 | 优惠券 ID（Short ID 格式 `CPN_xxx`）。优惠券必须为 `active` |
| `count` | integer | 是 | 生成数量，1–500 |
| `prefix` | string | 否 | 码前缀，1–12 个字母、数字或 `-`，会转为大写 |
| `length` | integer | 否 | 随机部分长度，8–16，默认 `10`。由大写字母和数字组成，去掉了 `0`、`O`、`1`、`I`、`L` |
| `restrictions` | object | 否 | 应用到每一个码，字段与[创建促销码](https://docs.waffo.ai/zh/api-reference/endpoints/promotion-codes/create-promotion-code.md)相同；一次性码请设置 `maxRedemptions: 1` |

每个码由 `prefix` 加随机部分组成，例如 `VIP-7KQ2MZ9H3X`。生成的码不会与同一店铺、同一环境的有效码重复。

## 请求示例

```typescript SDK theme={"system"}
const { batchId, promotionCodes } = await client.promotionCodes.generate(
  {
    couponId: "CPN_5dXBtmF2HLlHfbPNm0Wcnz",
    count: 100,
    prefix: "vip-",
    length: 10,
    restrictions: { maxRedemptions: 1 },
  },
  { idempotencyKey: "MER_2aUyqjCzEIiEcYMKj7TZtw-7c41d0b2-93ae-4f68-b5d1-6a2e9f03c8d4" },
);
console.log(promotionCodes.length, promotionCodes[0].code); // => 100 "VIP-7KQ2MZ9H3X"
```

```bash cURL theme={"system"}
MERCHANT_ID="MER_2aUyqjCzEIiEcYMKj7TZtw"
IDEMPOTENCY_KEY="MER_2aUyqjCzEIiEcYMKj7TZtw-7c41d0b2-93ae-4f68-b5d1-6a2e9f03c8d4"
TIMESTAMP=$(date +%s)
BODY='{"couponId":"CPN_5dXBtmF2HLlHfbPNm0Wcnz","count":100,"prefix":"vip-","length":10,"restrictions":{"maxRedemptions":1}}'
BODY_HASH=$(echo -n "$BODY" | openssl dgst -sha256 -binary | base64 | tr -d '\n')
CANONICAL_REQUEST="POST
/v1/actions/promotion-code/generate-promotion-codes
$TIMESTAMP
$BODY_HASH"

SIGNATURE=$(echo -n "$CANONICAL_REQUEST" | openssl dgst -sha256 -sign private_key.pem | base64 | tr -d '\n')

curl -X POST "https://api.waffo.ai/v1/actions/promotion-code/generate-promotion-codes" \
  -H "Content-Type: application/json" \
  -H "X-Merchant-Id: $MERCHANT_ID" \
  -H "X-Timestamp: $TIMESTAMP" \
  -H "X-Signature: $SIGNATURE" \
  -H "X-Idempotency-Key: $IDEMPOTENCY_KEY" \
  -d "$BODY"
```

```python Python theme={"system"}
import hashlib, time, base64, json, requests
from cryptography.hazmat.primitives import hashes, serialization
from cryptography.hazmat.primitives.asymmetric import padding

merchant_id = "MER_2aUyqjCzEIiEcYMKj7TZtw"
timestamp = str(int(time.time()))
body = {
    "couponId": "CPN_5dXBtmF2HLlHfbPNm0Wcnz",
    "count": 100,
    "prefix": "vip-",
    "length": 10,
    "restrictions": {"maxRedemptions": 1},
}

body_json = json.dumps(body, separators=(",", ":"))
body_hash = base64.b64encode(hashlib.sha256(body_json.encode()).digest()).decode()
path = "/v1/actions/promotion-code/generate-promotion-codes"
canonical = f"POST\n{path}\n{timestamp}\n{body_hash}"

with open("private_key.pem", "rb") as f:
    private_key = serialization.load_pem_private_key(f.read(), password=None)

signature = base64.b64encode(
    private_key.sign(canonical.encode(), padding.PKCS1v15(), hashes.SHA256())
).decode()

resp = requests.post(
    f"https://api.waffo.ai{path}",
    headers={
        "Content-Type": "application/json",
        "X-Merchant-Id": merchant_id,
        "X-Timestamp": timestamp,
        "X-Signature": signature,
        "X-Idempotency-Key": "MER_2aUyqjCzEIiEcYMKj7TZtw-7c41d0b2-93ae-4f68-b5d1-6a2e9f03c8d4",
    },
    data=body_json,
)
print(resp.json())
```

## 成功响应 (200)

```json theme={"system"}
{
  "data": {
    "batchId": "9b2f6c1e-3d4a-4f5b-8c7d-1e2f3a4b5c6d",
    "promotionCodes": [
      {
        "id": "PMC_7fZDvoH4JNnJhdRPobYepB",
        "couponId": "CPN_5dXBtmF2HLlHfbPNm0Wcnz",
        "code": "VIP-7KQ2MZ9H3X",
        "status": "active",
        "restrictions": {
          "customerEmails": [],
          "perCustomerLimit": null,
          "maxRedemptions": 1,
          "expiresAt": "2026-12-01T00:00:00.000Z",
          "minimumAmount": null
        },
        "batchId": "9b2f6c1e-3d4a-4f5b-8c7d-1e2f3a4b5c6d",
        "createdAt": "2026-11-03T08:00:00.000Z"
      }
    ]
  }
}
```

## 响应字段

| 字段 | 类型 | 说明 |
| - | - | - |
| `batchId` | string | 本次生成的所有码共用的批次 ID。可按它过滤 GraphQL `promotionCodes`，重新读取这一批 |
| `promotionCodes` | array | 生成的促销码。每一项的字段与[创建促销码的响应](https://docs.waffo.ai/zh/api-reference/endpoints/promotion-codes/create-promotion-code.md)相同 |

## 错误响应

> **重试策略**：4xx 一律不要重试 — 修正请求后重发。5xx 指数退避重试（起步 5s，最多 3 次）。重试时始终使用同一个 `X-Idempotency-Key`。

| 状态码 | `errors[0].message` | 含义 | 推荐处理 |
| - | - | - | - |
| 400 | `Missing header: x-context-merchant-id` | 商户上下文 header 未透传 | 修正 SDK 配置 |
| 400 | `Missing or invalid header: x-context-environment` | 环境 header 缺失或不是 `test` / `prod` | 把 `X-Environment` 设为 `test` 或 `prod` |
| 400 | `Invalid JSON body` | 请求体不是合法 JSON | 修正请求体后重发 |
| 400 | `Missing required field: couponId` / `Missing required field: count` | 必填字段缺失 | 补齐字段后重发 |
| 400 | `Expected format: CPN_xxx, got "X"` | `couponId` 不是合法 Short ID | 使用 `CPN_` 前缀的 Short ID |
| 400 | `count must be an integer` / `count must be between 1 and 500` | `count` 超出范围 | 改为 1–500 的整数；更多的码请分多次生成 |
| 400 | `prefix must be 1-12 characters of letters, digits or '-'` | `prefix` 含非法字符或长度不符 | 修正 `prefix` 后重发 |
| 400 | `length must be an integer` / `length must be between 8 and 16` | `length` 超出范围 | 改为 8–16 的整数 |
| 400 | `restrictions.maxRedemptions must not exceed the coupon's maxRedemptions (X)` | 上限高于优惠券的上限 | 把 `maxRedemptions` 调到不超过优惠券的值 |
| 400 | `restrictions.expiresAt must not be later than the coupon's redeemBy (X)` | 到期时间晚于优惠券的到期时间 | 使用不晚于优惠券 `redeemBy` 的时间 |
| 400 | `restrictions.expiresAt must be more than 60 seconds in the future` | 传入的 `expiresAt` 距当前不足 60 秒，或已经过去 | 传入晚于当前时间 60 秒以上的 `expiresAt` |
| 400 | `restrictions.customerEmails[N] must be a valid email address` / `restrictions.customerEmails must not exceed 100 entries` | `customerEmails` 中的第 `N` 个（从 0 开始）不是有效邮箱，或列表超过 100 个 | 修正列表后重发 |
| 400 | `restrictions.firstTimeOnly is not supported` / `restrictions.dailyRedemptionLimit is not supported` | `restrictions` 带了 `firstTimeOnly` 或 `dailyRedemptionLimit`（任意值，含 `null` / `false`），暂不支持这两个字段 | 去掉该字段 |
| 400 | `restrictions.X must be an integer` / `restrictions.X must be at least 1` / `restrictions.X must not exceed 2147483647` | `perCustomerLimit` 或 `maxRedemptions` 不是正整数或过大。`X` 为对应字段，如 `restrictions.perCustomerLimit must be at least 1` | 改为 1 到 2147483647 之间的整数，或传 `null` |
| 400 | `restrictions.expiresAt must be an ISO 8601 datetime` | `expiresAt` 格式错误 | 传入带时区偏移（如 `Z`）的 ISO 8601 时间 |
| 400 | `X: Invalid input: expected Y, received Z` | 字段 `X` 的 JSON 类型不对，`X` 为完整字段路径，如 `length: Invalid input: expected number, received string`、`restrictions.maxRedemptions: Invalid input: expected number, received string` | 按上文的类型传该字段 |
| 400 | `restrictions.minimumAmount: At least one currency is required` | `minimumAmount` 是空对象 | 至少提供一个币种，或传 `null` |
| 400 | `restrictions.minimumAmount: Invalid currency code: "X". Must be 3 uppercase letters (e.g., "USD", "EUR", "JPY")` | `minimumAmount` 的 key 不是合法 ISO 4217 代码 | 改为 3 位大写字母 |
| 400 | `restrictions.minimumAmount: Invalid amount for X: "Y". Must be a positive number string (e.g., "5.00", "500")` | `minimumAmount` 的值不是正数字符串 | 改为正数十进制字符串 |
| 400 | `restrictions.minimumAmount: Invalid amount for X: "Y". X allows at most N decimal places` / `restrictions.minimumAmount: Invalid amount for X: "Y". X does not allow decimal places` | `minimumAmount` 的金额超出该币种的小数位（如 USD `"0.001"`、JPY `"5.5"`），服务端不做四舍五入 | 按币种小数位填写（USD 最多 2 位、JPY 为整数、BHD 最多 3 位） |
| 400 | `restrictions.minimumAmount: Invalid amount for X: "Y". Must be at least Z X` | `minimumAmount` 的金额换算后不足该币种的 1 个最小单位 | 至少填写该币种的最小单位（如 USD `"0.01"`） |
| 401 | `Authentication required` | 认证失败 | 检查 API Key、时间戳与签名 |
| 404 | `Coupon not found` | 优惠券不存在、属于其他商户，或在另一个环境中 | 核对 `couponId` 以及 API Key 所属环境 |
| 409 | `Coupon is not active (status: X)` / `Coupon is not active` | 优惠券为 `pending`（仍在创建中）、`failed` 或 `inactive` | 请改用有效的优惠券 |
| 409 | `Coupon has expired (redeemBy: X); new promotion codes cannot be added` | 优惠券已到期（距 `redeemBy` 不足 60 秒即视为到期），不论是否传入 `expiresAt` | 到期的优惠券不能再新增促销码，请新建优惠券 |
| 409 | `Generated codes kept colliding with existing codes; try a longer length or another prefix` | 随机码多次与已有的有效码重复，本次没有创建任何码 | 加大 `length` 或更换 `prefix` 后重试 |
| 409 | `Request is being processed` | 使用同一 `X-Idempotency-Key` 的请求仍在处理中 | **等待几秒后用同一个键重试** |
| 500 | `Internal server error` | 服务端意外失败 | 指数退避重试（起步 5s，最多 3 次），沿用同一个幂等键 |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.