API リファレンス / 商品

種類一覧取得

リクエスト例

curl -X GET "https://apiv2.thebase.com/api/items/123/variations" \
  -H "Authorization: Bearer <your-token>"

パラメータ

レスポンス

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

• variationsItemVariation[]必須
  種類の一覧（最大 1000 件）。表示順に並びます。種類を持たない商品では空配列です。
  • idinteger必須≥ 0
    種類 ID
  • namestring任意
    種類名（例: カラー・サイズの表示名）。種類名を持たない（種類コードのみを保持する）種類では省略されます。
  • stockinteger必須
    当該種類の在庫数
  • identifierstring必須nullable
    種類コード（種類ごとの商品コード）。未設定時は null です。
  • barcodestring必須nullable
    種類ごとの JAN / GTIN。未設定時は null です。
• _linksobject必須
  このリソースに関連する操作へのリンク集合。リソースの状態やトークンのスコープによってリンクの有無は変わりません。
  • add_item_variationLink必須
    種類追加
    • hrefstring (uri)必須
      エンドポイントの絶対 URL
    • method"GET" | "POST" | "PUT" | "DELETE"必須
      エンドポイントを呼び出す際に使う HTTP メソッド
    • document_hrefstring (uri)必須
      ドキュメントサイト上でこのエンドポイントを説明するページの URL
  • reorder_item_variationsLink必須
    種類の並び替え
    • hrefstring (uri)必須
      エンドポイントの絶対 URL
    • method"GET" | "POST" | "PUT" | "DELETE"必須
      エンドポイントを呼び出す際に使う HTTP メソッド
    • document_hrefstring (uri)必須
      ドキュメントサイト上でこのエンドポイントを説明するページの URL

エラー

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

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