商品一覧の取得#

ショップの商品をページ単位で返します。非アクティブな商品と在庫切れの商品も一覧に含まれます。論理削除された商品を含め、status: invalid の商品は除外します。

http

GET https://sdkapi.ideal.house/product-import/products?shopId=<SHOP_ID>&page=1&pageSize=20

クエリパラメータ#

フィールド	型	必須	制約	説明
`shopId`	string	はい	最大 64 文字	Ideal House が提供する Shop ID。
`page`	number	いいえ	1 以上の整数	ページ番号。既定値は `1`。
`pageSize`	number	いいえ	1～100 の整数	ページごとの商品数。既定値は `20`。

cURL の例#

bash

curl --request GET \
  'https://sdkapi.ideal.house/product-import/products?shopId=shop_123&page=1&pageSize=20' \
  --header 'X-Client-Id: <YOUR_CLIENT_ID>' \
  --header 'X-Client-Secret: <YOUR_CLIENT_SECRET>'

レスポンス#

json

{
  "items": [
    {
      "id": "product_123",
      "shopId": "shop_123",
      "sku": "SKU-10001",
      "productCode": "SKU-10001",
      "externalProductId": "SKU-10001",
      "groupId": "mirror-series-01",
      "collectionId": null,
      "name": "Gold Wall Mirror",
      "title": "Gold Wall Mirror",
      "brand": "Example Brand",
      "productType": "Wall Art",
      "normalizedProductType": "wall_decors",
      "category": "Mirror",
      "style": null,
      "color": "Gold",
      "availability": "active",
      "imageUrl": "https://cdn.ideal.house/products/product_123.png",
      "previewImageUrl": "https://cdn.ideal.house/products/product_123-preview.png",
      "productUrl": "https://www.example.com/products/SKU-10001",
      "attributes": {
        "size": {
          "width": "24.0 in",
          "height": "36.0 in",
          "thickness": "2.0 in"
        }
      },
      "status": "active",
      "createdAt": "2026-07-21T06:30:00.000Z",
      "updatedAt": "2026-07-21T06:30:08.000Z"
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 20
}

必ず total、page、pageSize を使い、すべての商品を取得するまでページ単位で取得してください。一回のレスポンスにカタログ全体が含まれるとは限りません。