List Products#
Returns a paginated view of the shop's products. Inactive and out-of-stock products remain listed. Products with status: invalid, including logically deleted products, are excluded.
GET https://sdkapi.ideal.house/product-import/products?shopId=<SHOP_ID>&page=1&pageSize=20
Query Parameters#
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
shopId | string | Yes | Maximum 64 characters | Shop ID provided by Ideal House. |
page | number | No | Integer greater than or equal to 1 | Page number. Defaults to 1. |
pageSize | number | No | Integer from 1 to 100 | Products per page. Defaults to 20. |
cURL Example#
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>'
Response#
{
"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
}
Always use total, page, and pageSize to paginate until all products have been retrieved. Do not assume that a single response contains the complete catalog.