メインコンテンツまでスキップ

PATCH /v1/items/{id}/variants/{variantId}

scope​

write_items

リクエストパラメーター​

名前位置型必須説明
idパスstring必須対象のリソース ID
variantIdパスstring必須対象のリソース ID
Idempotency-Keyヘッダーstring必須冪等キー（必須）。UUID v4 を推奨します。同一キーの再送は最初の結果をそのまま再生し、応答に Idempotent-Replay: true が付きます。同一キーで異なるボディを送ると 422 になるため、リトライは必ず同一リクエストで行ってください
skuボディstring任意バリエーションの商品コード
priceボディobject任意このバリエーションの価格。null で商品の価格を使う
discount_rateボディinteger任意このバリエーションの割引率（%）
statusボディenum(activeinactive)任意
inventoryボディobject任意⚠️ ここでは変更できません。 在庫は PATCH /v1/items/{id}/stock に variant_id を添えて更新します
axis_valuesボディobject任意⚠️ 変更できません。 軸の組合せは作成時に確定します。送ると 409

レスポンスの例​

{
  "data": {
    "id": "string",
    "item_id": "string",
    "sku": "string",
    "name": "string",
    "price": {
      "amount": 0,
      "currency": "JPY"
    },
    "discount_rate": 0,
    "inventory": 0,
    "status": "active",
    "axis_values": [
      {
        "axis": "string",
        "value": "string"
      }
    ]
  }
}

解説​

バリエーションを編集します（price / discount_rate / status / sku）。販売終了は status: inactive で表します（削除 API は提供していません。行を残すことで注文履歴の参照が壊れません）。inventory は 400（在庫更新 API へ）、軸の割り当て変更も 400 です。Idempotency-Key 必須。

エラーレスポンスの例​

{
  "error": {
    "code": "insufficient_scope",
    "message": "requires scope 'write_items'",
    "request_id": "req_01H..."
  }
}

返しうるエラー: 400 / 401 / 403 / 404 / 409 / 503