画像一覧取得

指定した商品に登録されている画像を、表示順で取得します。

各画像の ID と画像 URL を返します。 画像が登録されていない場合は、空配列を返します。

GET /api/items/{id}/images
スコープ items.read

リクエスト例

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

パラメータ

id string · path 必須
商品 ID(1 以上の整数を文字列で表したもの)

レスポンス

200 取得成功。商品画像の一覧を表示順で返します。

200 のレスポンスボディ(application/json):

  • imagesItemImage[]必須
    商品画像の一覧(最大 20 件)。表示順に並びます。
    • idinteger必須≥ 0
      画像 ID
    • urlstring (uri)必須
      画像の公開 URL。アップロードされたままのサイズで返します。
    • scaled_urlstring (uri)必須
      縦横比を保ったまま幅を変えた画像の URL。幅 640px を指定した例です。URL に含まれる幅の値を変えると、任意の幅で取得できます。
    • square_urlstring (uri)必須
      中央を切り抜いて正方形にした画像の URL。一辺 900px を指定した例です。URL に含まれる寸法の値を変えると、任意の大きさで取得できます。
  • _linksobject必須
    このリソースに関連する操作へのリンク集合。リソースの状態やトークンのスコープによってリンクの有無は変わりません。
    • add_item_imageLink必須
      • hrefstring (uri)必須
        エンドポイントの絶対 URL
      • method"GET" | "POST" | "PUT" | "DELETE"必須
        エンドポイントを呼び出す際に使う HTTP メソッド
      • document_hrefstring (uri)必須
        ドキュメントサイト上でこのエンドポイントを説明するページの URL
    • reorder_item_imagesLink必須
      • hrefstring (uri)必須
        エンドポイントの絶対 URL
      • method"GET" | "POST" | "PUT" | "DELETE"必須
        エンドポイントを呼び出す際に使う HTTP メソッド
      • document_hrefstring (uri)必須
        ドキュメントサイト上でこのエンドポイントを説明するページの URL
    • create_file_uploadLink必須
      • hrefstring (uri)必須
        エンドポイントの絶対 URL
      • method"GET" | "POST" | "PUT" | "DELETE"必須
        エンドポイントを呼び出す際に使う HTTP メソッド
      • document_hrefstring (uri)必須
        ドキュメントサイト上でこのエンドポイントを説明するページの URL

エラー

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

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

400 /errors/request/invalid-params 1 つ以上のパスパラメータがエンドポイントのスキーマを満たさない場合に返します。
404 /errors/items/not-found 指定した商品が存在しない、または呼び出し元から参照できない場合に返します。1 リクエストで複数の商品を指定するエンドポイント(並び順の変更など)では、そのいずれかが参照できない場合に返します。