Activate or deactivate a product. Active products are purchasable; inactive products are hidden from checkout.
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": {
"id": "PROD_3kF9mNpQrStUvWxYz1A2bC",
"storeId": "STO_2aUyqjCzEIiEcYMKj7TZtw",
"prodVersionId": null,
"testVersionId": "PROD_7dG4hJkLmNpQrStUvWxYz1",
"prodStatus": "inactive",
"testStatus": "inactive",
"createdAt": "2026-01-15T10:30:00.000Z",
"updatedAt": "2026-01-15T13:00:00.000Z",
"version": {
"id": "PROD_7dG4hJkLmNpQrStUvWxYz1",
"productId": "PROD_3kF9mNpQrStUvWxYz1A2bC",
"versionNumber": 1,
"name": "Premium Template Pack",
"description": "50 premium design templates for your next project.",
"prices": {
"USD": { "amount": "49.00", "taxIncluded": false, "taxCategory": "digital_goods" },
"EUR": { "amount": "45.00", "taxIncluded": true, "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" },
"createdAt": "2026-01-15T10:30:00.000Z"
}
}
}
レスポンスフィールド
商品作成のレスポンスと同じです。
商品を inactive に設定するとチェックアウトから非表示になりますが、既存の注文には影響しません。既に商品を購入した顧客はアクセスを維持します。
エラーレスポンス
| ステータス | エラー | 説明 |
|---|
| 400 | Missing required field: id | id not provided |
| 400 | Invalid status value | status is not active or inactive |
| 400 | No version in current environment | Product has no version in the current environment (test/prod) |
| 404 | Product not found | Product does not exist or is not accessible |