BASE API

API リファレンス / 商品

種類編集

指定した種類の種類名・種類コード・JAN / GTIN を変更します。

変更するフィールドだけを指定できます。 省略したフィールドは変更しません。 種類コード・JAN / GTIN は、null を指定すると値をクリアできます。 ただし、種類名には null や空文字を指定できません。

在庫数は PUT /api/items/{id}/stock で変更することができます。

POST /api/items/{id}/variations/{variation_id}
スコープ items.readitems.update

リクエスト例

curl 
curl -X POST "https://apiv2.thebase.com/api/items/123/variations/678" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "identifier": "string",
  "barcode": "string"
}'

パラメータ

id string · path 必須
商品 ID（1 以上の整数を文字列で表したもの）
variation_id string · path 必須
種類 ID（1 以上の整数を文字列で表したもの）

リクエストボディ application/json

  • namestring任意1 文字以上 / 255 文字以下
    種類名（1〜255 文字）。絵文字などの 4 バイト文字は使用できません。
  • identifierstring任意nullable50 文字以下 / pattern: ^[a-zA-Z0-9_-]+$
    種類コード（最大 50 文字）。半角英数字と「_」「-」のみ指定できます。省略時は変更しません。null を指定すると値をクリアします。
  • barcodestring任意nullable50 文字以下 / pattern: ^[a-zA-Z0-9_-]+$
    JAN / GTIN（最大 50 文字）。半角英数字と「_」「-」のみ指定できます。省略時は変更しません。null を指定すると値をクリアします。

レスポンス

200 更新成功。更新された種類の ID を返します。

200 のレスポンスボディ（application/json）:

  • variation_idinteger必須≥ 0
    作成・編集された種類の ID

エラー

エラーは application/problem+json の Problem 形式で返します。 認証・スコープ・予期しない内部エラーなど、すべてのエンドポイントに共通のエラーと 構造・判別方法は エラーレスポンス を参照してください。

このエンドポイントが返すその他のエラーは次のとおりです。

400 /errors/request/malformed-body リクエストボディをこのエンドポイントが要求する形式として解釈できない場合に返します。
400 /errors/request/invalid-params 1 つ以上のパスパラメータがエンドポイントのスキーマを満たさない場合に返します。
400 /errors/items/invalid-body リクエストボディがエンドポイントのスキーマを満たさない場合に返します。
404 /errors/items/not-found 指定した商品が存在しない、または呼び出し元から参照できない場合に返します。1 リクエストで複数の商品を指定するエンドポイント（並び順の変更など）では、そのいずれかが参照できない場合に返します。
404 /errors/items/variation-not-found 指定した種類が存在しない、対象の商品に属していない、または呼び出し元から参照できない場合に返します。
413 /errors/request/body-too-large JSON リクエストボディが 1 MiB の上限を超える場合に返します。
415 /errors/request/unsupported-media-type JSON 形式のリクエストボディを要求するエンドポイントに、対応していない Content-Type が指定された、または Content-Type が指定されていない場合に返します。
422 /errors/items/write-rejected 商品の作成・編集・削除を業務ルールにより実行できない場合に返します (型整合性違反、種別不可変、ドメイン制約違反など)。細分化された Problem type に対応しない理由のときに返します。
502 /errors/internal/bad-gateway BASE API が処理を完了するために必要な内部処理で不整合が発生した場合に返します。
504 /errors/internal/gateway-timeout BASE API が処理を完了するために必要な内部処理が制限時間内に完了しなかった場合に返します。