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

POST /v1/items/{id}/variants

scope​

write_items

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

名前位置型必須説明
idパスstring必須対象のリソース ID
Idempotency-Keyヘッダーstring必須冪等キー（必須）。UUID v4 を推奨します。同一キーの再送は最初の結果をそのまま再生し、応答に Idempotent-Replay: true が付きます。同一キーで異なるボディを送ると 422 になるため、リトライは必ず同一リクエストで行ってください
skuボディstring必須バリエーションの商品コード
axis_valuesボディarray必須追加するバリエーションの軸の値。商品の全軸を過不足なく指定します
priceボディobject任意このバリエーションの価格。null で商品の価格を使う
inventoryボディinteger任意初期在庫のみ。以後は在庫 EP（variant_id 指定）で更新
discount_rateボディinteger任意このバリエーションの割引率（%）
statusボディenum(activeinactive)任意

レスポンスの例​

{
  "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"
      }
    ]
  }
}

解説​

バリエーション（variant）を追加します。軸（色・サイズ等）は商品作成時に確定しているため、ここでは既存の軸の値の組合せだけを指定できます（未宣言の値は 422、同じ組合せの重複は 409）。inventory は初期在庫のみで、以後の増減は在庫更新 API（variant_id 指定）で行います。Idempotency-Key 必須。

エラーレスポンスの例​

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

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