メインコンテンツへスキップ
商品を有効化または無効化します。有効な商品は購入可能で、無効な商品はチェックアウトから非表示になります。
POST /v1/actions/onetime-product/update-status
認証: API Key

リクエストボディ

フィールド必須説明
idstringYes商品 ID(Short ID フォーマット PROD_xxx
statusstringYesactive または 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意味推奨処理
400Missing required field: idid が指定されていませんボディを修正して再送信
400Invalid ID format指定された Short ID をデコードできませんでしたid のフォーマットを修正して再送信
400Invalid or missing status (must be 'active' or 'inactive')statusactive または inactive ではありませんactive または inactive を指定して再送信
400Product X has no version in environment Y商品が対象環境にまだバージョンを持たない(例:prod 未公開で状態切替を試みた)先に Publish Product で商品を対象環境に公開
404Product not found商品が存在しないかアクセスできませんid が現在のマーチャントに属することを確認
500Internal server errorサーバ側の予期しない障害指数バックオフでリトライ(5s 開始、最大 3 回)