激活或停用商品。活跃商品可被购买;停用商品在收银台页面中隐藏。
POST /v1/actions/onetime-product/update-status
认证方式: API Key
请求体
| 字段 | 类型 | 必需 | 说明 |
|---|
id | string | 是 | 商品 ID(Short ID 格式 PROD_xxx) |
status | string | 是 | active 或 inactive |
请求示例
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 | 含义 | 推荐处理 |
|---|
| 400 | Missing required field: id | 未提供 id | 修正请求体后重发 |
| 400 | Invalid ID format | 提供的 Short ID 无法解码 | 修正 id 格式后重发 |
| 400 | Invalid or missing status (must be 'active' or 'inactive') | status 不是 active 或 inactive | 使用 active 或 inactive 后重发 |
| 400 | Product X has no version in environment Y | 商品在目标环境尚无版本(例如 prod 尚未发布即尝试切换状态) | 先通过 Publish Product 将商品发布到目标环境 |
| 404 | Product not found | 商品不存在或不可访问 | 验证 id 是否属于当前商户 |
| 500 | Internal server error | 服务端意外失败 | 指数退避重试(起步 5s,最多 3 次) |