Ideal House
Pular para o conteúdo

Listar Produtos#

Retorna uma visualização paginada dos produtos da loja. Produtos inativos e sem estoque permanecem listados. Produtos com status: invalid, incluindo produtos logicamente excluídos, são excluídos.

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

Parâmetros de Consulta#

CampoTipoObrigatórioRestriçõesDescrição
shopIdstringSimMáximo 64 caracteresShop ID fornecido por Ideal House.
pagenumberNãoInteiro maior ou igual a 1Número da página. Padrão é 1.
pageSizenumberNãoInteiro de 1 a 100Produtos por página. Padrão é 20.

Exemplo 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>'

Resposta#

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
}

Sempre use total, page e pageSize para paginação até que todos os produtos sejam recuperados. Não assuma que uma única resposta contenha o catálogo completo.