跳转到主要内容
激活或停用商品。活跃商品可被购买;停用商品在收银台页面中隐藏。
POST /v1/actions/onetime-product/update-status
认证方式: API Key

请求体

字段类型必需说明
idstring商品 ID(Short ID 格式 PROD_xxx
statusstringactiveinactive

请求示例

import { ProductVersionStatus } from "@waffo/pancake-ts";

const { product } = await client.onetimeProducts.updateStatus({
  id: "PROD_3kF9mNpQrStUvWxYz1A2bC",
  status: ProductVersionStatus.Inactive,
});

成功响应 (200)

{
  "data": {
    "product": {
      "id": "PROD_3kF9mNpQrStUvWxYz1A2bC",
      "storeId": "STO_2aUyqjCzEIiEcYMKj7TZtw",
      "name": "Premium Template Pack",
      "description": "50 premium design templates for your next project.",
      "prices": {
        "USD": { "amount": "49.00", "taxCategory": "digital_goods" },
        "EUR": { "amount": "45.00", "taxCategory": "digital_goods" }
      },
      "media": [
        { "type": "image", "url": "https://example.com/templates-preview.png", "alt": "Template preview" }
      ],
      "successUrl": "https://example.com/thank-you",
      "metadata": { "category": "design", "fileCount": "50" },
      "status": "inactive",
      "createdAt": "2026-01-15T10:30:00.000Z",
      "updatedAt": "2026-01-15T13:00:00.000Z"
    }
  }
}

响应字段

创建商品响应 相同。
将商品设为 inactive 会在收银台页面中隐藏该商品,但不影响现有订单。已购买的客户仍保留访问权限。

错误响应

重试策略:4xx 一律不要重试 — 修正请求后重发。5xx 指数退避重试(起步 5s,最多 3 次)。
状态码errors[0].message含义推荐处理
400Missing required field: id未提供 id修正请求体后重发
400Invalid ID format提供的 Short ID 无法解码修正 id 格式后重发
400Invalid or missing status (must be 'active' or 'inactive')status 不是 activeinactive使用 activeinactive 后重发
400Product X has no version in environment Y商品在目标环境尚无版本(例如 prod 尚未发布即尝试切换状态)先通过 Publish Product 将商品发布到目标环境
404Product not found商品不存在或不可访问验证 id 是否属于当前商户
500Internal server error服务端意外失败指数退避重试(起步 5s,最多 3 次)