API リファレンス / 商品

種類追加

リクエスト例

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

パラメータ

リクエストボディ 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 の場合は未設定です。

レスポンス

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

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

エラー

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

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