API リファレンス / 商品カテゴリ

カテゴリ取得

リクエスト例

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

パラメータ

レスポンス

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

• idinteger必須≥ 0
  カテゴリ ID
• numberinteger必須≥ 0
  ショップ内で各カテゴリに割り振られる番号
• namestring必須
  カテゴリの表示名
• parentItemCategory必須nullable
  上位カテゴリ。最上位カテゴリでは null です。
  • idinteger必須≥ 0
    カテゴリ ID
  • numberinteger必須≥ 0
    ショップ内で各カテゴリに割り振られる番号
  • namestring必須
    カテゴリの表示名
  • parentItemCategory必須nullable
    上位カテゴリ。最上位カテゴリでは null です。
    ↻ ItemCategory を再帰参照
• _linksobject必須
  このリソースに関連する操作へのリンク集合。リソースの状態やトークンのスコープによってリンクの有無は変わりません。
  • update_item_categoryLink必須
    カテゴリ編集
    • hrefstring (uri)必須
      エンドポイントの絶対 URL
    • method"GET" | "POST" | "PUT" | "DELETE"必須
      エンドポイントを呼び出す際に使う HTTP メソッド
    • document_hrefstring (uri)必須
      ドキュメントサイト上でこのエンドポイントを説明するページの URL
  • delete_item_categoryLink必須
    カテゴリ削除
    • hrefstring (uri)必須
      エンドポイントの絶対 URL
    • method"GET" | "POST" | "PUT" | "DELETE"必須
      エンドポイントを呼び出す際に使う HTTP メソッド
    • document_hrefstring (uri)必須
      ドキュメントサイト上でこのエンドポイントを説明するページの URL
  • update_item_category_list_orderLink必須
    カテゴリの並び順を変更する
    • hrefstring (uri)必須
      エンドポイントの絶対 URL
    • method"GET" | "POST" | "PUT" | "DELETE"必須
      エンドポイントを呼び出す際に使う HTTP メソッド
    • document_hrefstring (uri)必須
      ドキュメントサイト上でこのエンドポイントを説明するページの URL

エラー

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

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