Detalhes do Produto
GET
/publics/products/{productId}
Retorna informações completas de um produto específico
Descrição
Endpoint responsável por retornar os detalhes completos de um produto 🛍️.
Inclui todas as informações relevantes do produto, como:
- Descrição completa
- Preço e disponibilidade
- Imagens e mídias
- Atributos e especificações técnicas
- Informações de categorias e marcas
Esse endpoint é ideal para exibir a página detalhada do produto no site ou aplicativo.
Parâmetros de Query
Parâmetros da URL
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| productId | integer | Sim | ID único do produto |
Parâmetros de Metadados (meta)
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| meta.dimensions.size | string | Não | Unidade de medida para dimensões. Valores aceitos: Meter, Centimeter |
| meta.dimensions.weight | string | Não | Unidade de medida para peso. Valores aceitos: Gram, Kilogram |
| meta.priceParameters | array | Não | Parâmetros para cálculo de preço personalizado |
| meta.priceParameters.*.code | string | Não | Código do parâmetro (exatamente 32 caracteres) |
| meta.priceParameters.*.quantity | integer | Não | Quantidade do item |
| meta.priceParameters.*.upsellId | integer | Não | ID do upsell relacionado |
| meta.priceParameters.*.productPairOfferId | integer | Não | ID da oferta de par de produtos |
Campos Disponíveis (fields)
| Campo | Descrição |
|---|---|
| brand | Informações completas da marca do produto |
| flags | Flags do produto (showInSite, saleWithoutStock, minimumStock) |
| mainUrl | URL principal do produto |
| secondaryUrls | URLs secundárias do produto |
| description | Descrições (short, full, searchDescription) |
| parentProduct | Produto pai do produto atual |
| indicatedProducts | Produtos indicados relacionados |
| relatedProducts | Produtos relacionados |
| tax | Informações de impostos e taxas |
| filters | Filtros e atributos aplicáveis |
| stockByStorage | Estoque por armazém |
| stock | Informações consolidadas de estoque |
| seals | Selos e certificações do produto |
| mainCategory | Categoria principal |
| categories | Todas as categorias do produto |
| categoryBreadcrumb | Breadcrumb de navegação de categorias |
| dimension | Dimensões físicas (peso, altura, largura, comprimento) |
| variation | Variações do produto (cores, tamanhos, etc) |
| media | Mídias (imagens, vídeos, arquivos) |
| price | Preço, promoções e parcelamento |
| priceRules | Regras de preço aplicadas |
| bannerGroups | Grupos de banners associados |
| review | Avaliações e reviews |
| status | Status do produto |
| haveChildren | Verifica se tem produtos filhos |
| restriction | Restrição de compra do produto (tradePolicyId, requiredAge) |
| availableCoupons | Retorna até 10 cupons aplicáveis ao produto |
Estrutura do field availableCoupons
Cada item do array representa um cupom aplicável ao produto. O nó discounts detalha as faixas de desconto:
1{2 "id": 15,3 "hash": "PROMO10",4 "discounts": [5 {6 "entityId": 15,7 "entity": "coupon",8 "itemAmount": 3,9 "value": 1010 }11 ],12 "createdAt": "2026-01-01 00:00:00",13 "updatedAt": "2026-01-01 00:00:00"14}| Campo | Tipo | Descrição |
|---|---|---|
id | integer | ID do cupom |
hash | string | Código do cupom (inserido pelo cliente no checkout) |
discounts[].entityId | integer | ID da entidade referenciada em entity |
discounts[].entity | string | Entidade que recebe o desconto |
discounts[].itemAmount | number | Quantidade mínima de itens para que o desconto em value seja aplicado |
discounts[].value | number | Valor do desconto aplicado quando itemAmount é atingido |
Exemplo de Requisição
1curl --request GET \2 --url https://sua-loja-uappi.com.br/api/v3/publics/products/{pŕoductId} \✅ Resposta de Sucesso
1{2 "id": 1234,3 "type": "product",4 "sku": "SMPH001",5 "name": "Smartphone XYZ Pro 128GB",6 "priority": 100,7 "basePrice": 1199.90,8 "active": true,9 "review": {10 "productId": 1234,11 "averageRating": 4.67,12 "quantityRating": 32813 },14 "isGiftCard": false,15 "stock": {16 "productId": 1234,17 "productStorageId": 1,18 "availableStock": 15,19 "reservedStock": 2,20 "updatedAt": "2024-10-01 14:30:00"21 },22 "stocks": [23 {24 "productId": 1234,25 "productStorageId": 1,26 "availableStock": 15,27 "reservedStock": 2,28 "updatedAt": "2024-10-01 14:30:00"29 },30 {31 "productId": 1234,32 "productStorageId": 2,33 "availableStock": 8,34 "reservedStock": 1,35 "updatedAt": "2024-10-01 14:30:00"36 }37 ],38 "originalPrice": {39 "comparisonPrice": 0,40 "salePrice": 0,41 "markup": 0,42 "ruleId": 0,43 "ruleTrigger": "original",44 "ruleName": "Original",45 "availableForSale": true,46 "basePrice": false,47 "priceWithDiscount": 0,48 "installments": [],49 "scheduling": null50 },51 "price": {52 "comparisonPrice": 1499.90,53 "salePrice": 1199.90,54 "markup": 25.02,55 "ruleId": 15,56 "ruleTrigger": "original",57 "ruleName": "Original",58 "availableForSale": true,59 "basePrice": false,60 "priceWithDiscount": 1199.90,61 "installments": [62 {63 "installment": 1,64 "installmentValue": 1199.90,65 "totalValue": 1199.90,66 "fee": null,67 "feeTotalValue": 068 },69 {70 "installment": 2,71 "installmentValue": 599.95,72 "totalValue": 1199.90,73 "fee": null,74 "feeTotalValue": 075 },76 {77 "installment": 12,78 "installmentValue": 99.99,79 "totalValue": 1199.88,80 "fee": null,81 "feeTotalValue": 082 }83 ],84 "scheduling": {85 "id": 46,86 "startDate": "2026-02-07 09:00:00",87 "endDate": "2026-10-30 23:59:59"88 }89 },90 "priceRules": null,91 "brand": {92 "id": 45,93 "code": "TECH",94 "name": "TechBrand",95 "logo": "https://cdn.loja.com.br/brands/techbrand-logo.jpg",96 "originalLogo": "https://cdn.loja.com.br/brands/techbrand-logo-original.jpg",97 "productOrdering": "name_asc",98 "active": true,99 "bannerGroups": [],100 "createdAt": "2023-10-04 19:11:08",101 "updatedAt": "2025-08-20 12:41:03",102 "url": "/marca/techbrand"103 },104 "flags": {105 "subscription": false,106 "service": false,107 "showInSite": true,108 "saleWithoutStock": false,109 "minimumStock": 5110 },111 "tax": {112 "mpn": "MPN123456",113 "ean": "7891234567890",114 "ncm": "85171231",115 "exclusive": false116 },117 "indicatedProducts": [118 {119 "id": 1234,120 "brandId": 1234,121 "brandName": "TopPhone",122 "mainCategoryId": 1,123 "mainCategoryName": "smartphone",124 "type": "product",125 "name": "Smartphone XYZ Pro 128GB",126 "sku": "SMPH001",127 "url": "/smartphone-xyz-pro-128gb",128 "comparisonPrice":2199.99,129 "stock":20,130 "medias":[131 {132 "id": 123,133 "type": "image",134 "title": "",135 "alternativeText": null,136 "file": "https://cdn.loja.com.br/upload/media/produto-media.webp",137 "originalFile": "https://cdn.loja.com.br/upload/media/produto-media.png",138 "size": null,139 "originalSize": null,140 "width": null,141 "height": null,142 "url": null143 }144 ],145 "combination":[1, 2, 3],146 "currentAttributes":[147 {148 "id":123,149 "name":"cor",150 "value":{151 "id":123,152 "label":"azul-escuro",153 "image":null,154 "originalImage":null,155 "color":"#00008B",156 "order":1157 }158 }159 ],160 "active": true161 }162 ],163 "relatedProducts": [164 {165 "id": 1234,166 "brandId": 1234,167 "brandName": "TopPhone",168 "mainCategoryId": 1,169 "mainCategoryName": "smartphone",170 "type": "product",171 "name": "Smartphone XYZ Pro 128GB",172 "sku": "SMPH001",173 "url": "/smartphone-xyz-pro-128gb",174 "comparisonPrice":2199.99,175 "stock":20,176 "medias":[177 {178 "id": 123,179 "type": "image",180 "title": "",181 "alternativeText": null,182 "file": "https://cdn.loja.com.br/upload/media/produto-media.webp",183 "originalFile": "https://cdn.loja.com.br/upload/media/produto-media.png",184 "size": null,185 "originalSize": null,186 "width": null,187 "height": null,188 "url": null189 }190 ],191 "combination":[1, 2, 3],192 "currentAttributes":[193 {194 "id":123,195 "name":"cor",196 "value":{197 "id":123,198 "label":"azul-escuro",199 "image":null,200 "originalImage":null,201 "color":"#00008B",202 "order":1203 }204 }205 ],206 "active": true207 }208 ],209 "filters": [210 {211 "id": 123,212 "productCategoryId": 1234,213 "name": "Marca",214 "active": true,215 "showInListing": true,216 "showInSpecificationTable": false,217 "type": "enum",218 "createdAt": "2025-01-14 10:31:00",219 "values": [220 {221 "id": 123,222 "name": "TechPhone",223 "image": null,224 "originalImage": null,225 "color": null,226 "order": 1,227 "value": null228 },229 {230 "id": 124,231 "name": "SmartScreen",232 "image": null,233 "originalImage": null,234 "color": null,235 "order": 1,236 "value": null237 }238 ]239 }240 ],241 "seals": [242 {243 "id": 5,244 "name": "Frete Grátis",245 "active": true,246 "textColor": "#FFFFFF",247 "sealColor": "#00A650",248 "image": "https://cdn.loja.com.br/seals/frete-gratis.png",249 "originalImage": "https://cdn.loja.com.br/seals/frete-gratis-original.png",250 "setting":{251 "id": 1234,252 "horizontalPosition": "left",253 "verticalPosition": "top",254 "proportionInProductDetail": 300,255 "proportionInProductShowcase": 300,256 "scheduling": {257 "id": 1234,258 "startDate": "2024-01-15 10:30:00",259 "endDate": "2024-01-30 10:30:00"260 }261 },262 "promotionLinkId":15,263 "createdAt":"2024-01-15 10:30:00",264 "updatedAt":"2024-01-15 10:30:00"265 }266 ],267 "mainCategory": {268 "id": 123,269 "name": "Smartphones",270 "url": "/smartphones"271 },272 "categories": [273 {274 "id": 100,275 "name": "Eletrônicos",276 "url": "/eletronicos"277 },278 {279 "id": 110,280 "name": "Telefonia",281 "url": "/eletronicos/telefonia"282 },283 {284 "id": 123,285 "name": "Smartphones",286 "url": "/eletronicos/telefonia/smartphones"287 }288 ],289 "categoryBreadcrumb": [290 {291 "id": 100,292 "name": "Eletrônicos",293 "url": "/eletronicos"294 },295 {296 "id": 110,297 "name": "Telefonia",298 "url": "/eletronicos/telefonia"299 },300 {301 "id": 123,302 "name": "Smartphones",303 "url": "/eletronicos/telefonia/smartphones"304 }305 ],306 "dimensions": {307 "shippingCargoTypeId": 1,308 "additionalTime": 0,309 "width": 7.5,310 "height": 15.2,311 "length": 0.8,312 "weight": 185313 },314 "parentProductId": null,315 "combination": [1234],316 "currentAttributes": [317 {318 "id": 1,319 "name": "Cor",320 "value": {321 "id": 123,322 "label": "Azul",323 "image": null,324 "originalImage": null,325 "color": "007BFF",326 "order": 1327 }328 }329 ],330 "variations": {331 "valueList": [332 1234333 ],334 "combinations": [335 {336 "productId": 1234,337 "brandId": 1,338 "brandName": "TechPhone",339 "mainCategoryId": 123,340 "mainCategoryName": "Tecnologia",341 "type": "variation",342 "sku": "ABC123",343 "name": "Variation Phone",344 "active": true,345 "url": "nice-phone-url",346 "comparisonPrice": 1800,347 "stock": 21,348 "medias": [349 {350 "id": 123,351 "type": "image",352 "title": "Variation Phone Image",353 "alternativeText": null,354 "file": "https://cdn.loja.com.br/upload/media.webp",355 "originalFile": "https://cdn.loja.com.br/upload/media.png",356 "size": null,357 "originalSize": null,358 "width": null,359 "height": null,360 "url": null361 }362 ],363 "combination": [364 1, 2365 ],366 "currentAttributes": [367 {368 "id": 1,369 "name": "Cor",370 "value": {371 "id": 1,372 "label": "Azul",373 "image": null,374 "originalImage": null,375 "color": "007BFF",376 "order": 1377 }378 }379 ]380 }381 ],382 "attributes": [383 {384 "id": 1,385 "name": "Cor",386 "displayName": "Cor",387 "includeSample": false,388 "values": [389 {390 "id": 1,391 "label": "Azul",392 "image": null,393 "originalImage": null,394 "color": "007BFF",395 "order": 1396 }397 ],398 "createdAt": "2025-07-23 22:50:28",399 "updatedAt": "2025-08-06 16:03:59"400 }401 ]402 },403 "medias": [404 {405 "id": 1234,406 "type": "image",407 "title": "Imagem Principal",408 "alternativeText": "Smartphone XYZ Pro vista frontal",409 "file": "https://cdn.loja.com.br/products/smartphone-xyz-pro-01.jpg",410 "originalFile": "https://cdn.loja.com.br/products/smartphone-xyz-pro-01-original.jpg",411 "size": 245680,412 "originalSize": 1567890,413 "width": 800,414 "height": 800,415 "url": "https://cdn.loja.com.br/products/smartphone-xyz-pro-01.jpg"416 }417 ],418 "bannerGroups": [419 "banner 1",420 "banner 2",421 "banner 3"422 ],423 "status": "available",424 "createdAt": "2024-01-15 10:30:00",425 "updatedAt": "2024-10-01 15:45:00",426 "url": "/smartphone-xyz-pro-128gb",427 "urls": [428 {429 "tradePolicyId": 1,430 "url": "/smartphone-xyz-pro-128gb",431 "redirect": false,432 "redirectCode": null,433 "target": null,434 "createdAt": "2024-01-15 10:30:00",435 "updatedAt": "2024-01-15 10:30:00"436 }437 ],438 "linkedTradePolicies": [1, 2, 3],439 "description": {440 "id": 1234,441 "productId": 1234,442 "tradePolicyId": 1,443 "name": "Smartphone XYZ Pro 128GB",444 "shortDescription": "O mais avançado smartphone com 128GB de armazenamento",445 "description": "<p>Smartphone com processador octa-core, câmera tripla de 64MP e bateria de longa duração...</p>",446 "searchDescription": "smartphone xyz pro 128gb android camera 64mp bateria",447 "videoUrl": "https://youtube.com/watch?v=example",448 "customDescription1": null,449 "customDescription2": null,450 "customDescription3": null,451 "measureTable": null,452 "seoTitle": "Smartphone XYZ Pro 128GB - Compre Agora",453 "seoDescription": "Compre o Smartphone XYZ Pro com 128GB de armazenamento. Câmera 64MP, processador rápido e entrega rápida.",454 "seoKeywords": "smartphone, xyz pro, 128gb, android",455 "seoCanonical": "https://loja.com.br/smartphone-xyz-pro-128gb",456 "seoSocialTitle": "Smartphone XYZ Pro 128GB",457 "seoSocialDescription": "O melhor smartphone do mercado",458 "seoTwitterImageUrl": "https://cdn.loja.com.br/products/smartphone-xyz-pro-twitter.jpg",459 "seoGraphImageUrl": "https://cdn.loja.com.br/products/smartphone-xyz-pro-og.jpg",460 "seoGoogleCategoryId": 2895,461 "seoIndexOnGoogle": true,462 "seoGoogleCondition": "new",463 "seoGoogleAgeGroup": "adult",464 "seoGoogleGender": "unisex",465 "seoStructuredData": null466 }467}⚠️ Possíveis erros:
Atenção: a seguir estão destacados os principais erros que podem ocorrer neste endpoint.
Os cenários descritos representam os erros mais relevantes do contexto atual, servindo como referência para entendimento e tratamento das falhas.
| errorCode | HTTP | Message |
|---|---|---|
| UAPPI_STORE_PRODUCT_NOT_FOUND | 404 | O produto solicitado não foi encontrado. |
Erros de Validação (422)
Se os parâmetros meta forem inválidos (valores fora do enum, tipo incorreto, tamanho inválido), a API retornará erro 422 com detalhes no campo errors.
Consulte a seção Parâmetros de Metadados (meta) acima para ver os valores aceitos e tipos esperados.
Buscar Produtos
GET
/publics/products/search/{search}
Realiza busca avançada de produtos por termo específico
Descrição
Endpoint responsável por buscar produtos a partir de termos de pesquisa 🔍🛍️.
Permite localizar produtos com base em:
- Nome do produto
- SKU
- Descrição de busca
- Descrição curta
Essa funcionalidade é útil para pesquisas rápidas e filtros de busca no site ou aplicativo.
Parâmetros de Query
Parâmetros da URL
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| search | string | Sim | Termo de busca para pesquisar produtos |
Parâmetros de Metadados (meta)
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| meta.dimensions.size | string | Não | Unidade de medida para dimensões. Valores aceitos: Meter, Centimeter |
| meta.dimensions.weight | string | Não | Unidade de medida para peso. Valores aceitos: Gram, Kilogram |
| meta.priceParameters | array | Não | Parâmetros para cálculo de preço personalizado |
| meta.priceParameters.*.code | string | Não | Código do parâmetro (exatamente 32 caracteres) |
| meta.priceParameters.*.quantity | integer | Não | Quantidade do item |
| meta.priceParameters.*.upsellId | integer | Não | ID do upsell relacionado |
| meta.priceParameters.*.productPairOfferId | integer | Não | ID da oferta de par de produtos |
Campos Disponíveis (fields)
Especifique apenas os campos necessários para otimizar a performance:
| Campo | Descrição |
|---|---|
| brand | Informações completas da marca do produto |
| flags | Flags do produto (showInSite, saleWithoutStock, minimumStock) |
| mainUrl | URL principal do produto |
| secondaryUrls | URLs secundárias do produto |
| description | Descrições (short, full, searchDescription) |
| parentProduct | Produto pai do produto atual |
| indicatedProducts | Produtos indicados relacionados |
| relatedProducts | Produtos relacionados |
| tax | Informações de impostos e taxas |
| filters | Filtros e atributos aplicáveis |
| stockByStorage | Estoque por armazém |
| stock | Informações consolidadas de estoque |
| seals | Selos e certificações do produto |
| mainCategory | Categoria principal |
| categories | Todas as categorias do produto |
| categoryBreadcrumb | Breadcrumb de navegação de categorias |
| dimension | Dimensões físicas (peso, altura, largura, comprimento) |
| variation | Variações do produto (cores, tamanhos, etc) |
| media | Mídias (imagens, vídeos, arquivos) |
| price | Preço, promoções e parcelamento |
| priceRules | Regras de preço aplicadas |
| bannerGroups | Grupos de banners associados |
| review | Avaliações e reviews |
| status | Status do produto |
| haveChildren | Verifica se tem produtos filhos |
| restriction | Restrição de compra do produto (tradePolicyId, requiredAge) |
| availableCoupons | Retorna até 10 cupons aplicáveis aos produtos da listagem |
Estrutura do field availableCoupons
Cada item do array representa um cupom aplicável ao produto. O nó discounts detalha as faixas de desconto:
1{2 "id": 15,3 "hash": "PROMO10",4 "discounts": [5 {6 "entityId": 15,7 "entity": "coupon",8 "itemAmount": 3,9 "value": 1010 }11 ],12 "createdAt": "2026-01-01 00:00:00",13 "updatedAt": "2026-01-01 00:00:00"14}| Campo | Tipo | Descrição |
|---|---|---|
id | integer | ID do cupom |
hash | string | Código do cupom (inserido pelo cliente no checkout) |
discounts[].entityId | integer | ID da entidade referenciada em entity |
discounts[].entity | string | Entidade que recebe o desconto |
discounts[].itemAmount | number | Quantidade mínima de itens para que o desconto em value seja aplicado |
discounts[].value | number | Valor do desconto aplicado quando itemAmount é atingido |
Campos de Condição Disponíveis
| Campo | Tipo | Descrição |
|---|---|---|
| id | integer | ID do produto |
| parentProductId | integer | ID do produto pai |
| brandId | integer | ID da marca |
| active | boolean | Produto ativo (true/false) |
| type | string | Tipo do produto |
| sku | string | SKU do produto |
| url | string | URL do produto |
| showInSite | boolean | Exibir no site |
| saleWithoutStock | boolean | Permitir venda sem estoque |
| minimumStock | integer | Estoque mínimo |
| category | integer | ID da categoria |
| mainCategory | integer | ID da categoria principal |
| salePrice | decimal | Preço de venda |
| comparisonPrice | decimal | Preço de comparação |
| priceDifference | decimal | Diferença entre preços |
| filter | object | Filtro por atributos |
| stock | integer | Quantidade em estoque |
| stockInStorage | integer | Estoque em armazém específico |
| productStorageId | integer | ID do armazém |
| name | string | Nome do produto |
| shortDescription | string | Descrição curta |
| description | string | Descrição completa |
| searchDescription | string | Descrição de busca |
| seal | integer | ID do selo |
| tradePolicyId | integer | ID da política comercial |
| productAttributeId | integer | ID do atributo |
| productAttributeValueId | integer | ID do valor do atributo |
| customerWishListId | integer | ID da lista de desejos |
| exclusive | boolean | Produto exclusivo |
| ean | string | Código EAN/GTIN |
| averageRating | decimal | Avaliação média (2 casas decimais, ex.: 4.67). Prefira >=/<= ao = |
| quantityRating | integer | Quantidade de avaliações |
| childrenAmount | integer | Quantidade de variações filhas |
| giftCard | boolean | Filtrar por gift card |
| variationsQuantity | integer | Filtrar produtos por quantidade de variações (independente de status de ativação) |
| availableVariationsQuantity | integer | Filtrar produtos por quantidade de variações disponíveis (ativas) |
| priceRuleCode | string | Filtrar produtos por código de regra de preço associada ao produto. |
Campos de Ordenação Disponíveis
| Campo | Descrição |
|---|---|
| id | ID do produto |
| priority | Prioridade de exibição |
| type | Tipo do produto |
| sku | SKU do produto |
| relevance | Relevância em busca |
| stock | Quantidade em estoque |
| stockByStorage | Estoque em armazém |
| name | Nome do produto |
| price | Preço do produto |
| hasStock | Disponibilidade (produtos com estoque primeiro) |
Exemplo de Requisição
1curl --request GET \2 --url {{MAIN_URL}}/publics/products/search/{search} \✅ Resposta de Sucesso
1{2 "type": "search",3 "entity": null,4 "menu": {5 "brands": [6 {7 "id": 10,8 "name": "TechBrand",9 "logo": "https://cdn.loja.com.br/brands/techbrand-logo.webp",10 "url":"/marca/techbrand",11 "productQuantity": 512 }13 ],14 "categories": [15 {16 "id": 123,17 "name": "Smartphones",18 "url": "tecnologia/smartphones",19 "productQuantity": 520 }21 ],22 "filters": [23 {24 "id": 123,25 "name": "Armazenamento:",26 "showInSpecificationTable": true,27 "values": {28 "0": {29 "id": 1234,30 "name": "120GB",31 "image": null,32 "originalImage": null,33 "color": null,34 "order": 0,35 "value": null,36 "productQuantity": 537 }38 },39 "productQuantity": 540 }41 ],42 "seals": [43 {44 "id":1234,45 "name":"Frete Grátis",46 "textColor":"#FFFFFF",47 "sealColor":"#00A650",48 "image":"https://cdn.loja.com.br/seals/frete-gratis.png",49 "productQuantity": 550 }51 ],52 "attributes": [53 {54 "id": 123,55 "name": "Cor",56 "displayName": "",57 "includeSample": false,58 "values": [59 {60 "id": 1234,61 "label": "Azul",62 "image": null,63 "originalImage": null,64 "color": "#007BFF",65 "order": 7,66 "productQuantity": 567 }68 ],69 "productQuantity": 5,70 "createdAt": "2024-01-15 10:30:00",71 "updatedAt": "2024-01-15 10:30:00"72 }73 ],74 "prices": [75 {76 "min": 1,77 "max": 10078 },79 ]80 },81 "content": [82 "registers": [83 {84 "id": 1234,85 "type": "product",86 "sku": "SMPH001",87 "name": "Smartphone XYZ Pro 128GB",88 "priority": 100,89 "basePrice": 1199.90,90 "active": true,91 "review": {92 "productId": 1234,93 "averageRating": 4.67,94 "quantityRating": 32895 },96 "isGiftCard": false,97 "stock": {98 "productId": 1234,99 "productStorageId": 1,100 "availableStock": 15,101 "reservedStock": 2,102 "updatedAt": "2024-10-01 14:30:00"103 },104 "stocks": [105 {106 "productId": 1234,107 "productStorageId": 1,108 "availableStock": 15,109 "reservedStock": 2,110 "updatedAt": "2024-10-01 14:30:00"111 },112 {113 "productId": 1234,114 "productStorageId": 2,115 "availableStock": 8,116 "reservedStock": 1,117 "updatedAt": "2024-10-01 14:30:00"118 }119 ],120 "originalPrice": {121 "comparisonPrice": 0,122 "salePrice": 0,123 "markup": 0,124 "ruleId": 0,125 "ruleTrigger": "original",126 "ruleName": "Original",127 "availableForSale": true,128 "basePrice": false,129 "priceWithDiscount": 0,130 "installments": [],131 "scheduling": null132 },133 "price": {134 "comparisonPrice": 1499.90,135 "salePrice": 1199.90,136 "markup": 25.02,137 "ruleId": 15,138 "ruleTrigger": "original",139 "ruleName": "Original",140 "availableForSale": true,141 "basePrice": false,142 "priceWithDiscount": 1199.90,143 "installments": [144 {145 "installment": 1,146 "installmentValue": 1199.90,147 "totalValue": 1199.90,148 "fee": null,149 "feeTotalValue": 0150 },151 {152 "installment": 2,153 "installmentValue": 599.95,154 "totalValue": 1199.90,155 "fee": null,156 "feeTotalValue": 0157 },158 {159 "installment": 12,160 "installmentValue": 99.99,161 "totalValue": 1199.88,162 "fee": null,163 "feeTotalValue": 0164 }165 ],166 "scheduling": {167 "id": 46,168 "startDate": "2026-02-07 09:00:00",169 "endDate": "2026-10-30 23:59:59"170 }171 },172 "priceRules": null,173 "brand": {174 "id": 45,175 "code": "TECH",176 "name": "TechBrand",177 "logo": "https://cdn.loja.com.br/brands/techbrand-logo.jpg",178 "originalLogo": "https://cdn.loja.com.br/brands/techbrand-logo-original.jpg",179 "productOrdering": "name_asc",180 "active": true,181 "bannerGroups": [],182 "createdAt": "2023-10-04 19:11:08",183 "updatedAt": "2025-08-20 12:41:03",184 "url": "/marca/techbrand"185 },186 "flags": {187 "subscription": false,188 "service": false,189 "showInSite": true,190 "saleWithoutStock": false,191 "minimumStock": 5192 },193 "tax": {194 "mpn": "MPN123456",195 "ean": "7891234567890",196 "ncm": "85171231",197 "exclusive": false198 },199 "indicatedProducts": [200 {201 "id": 1234,202 "brandId": 1234,203 "brandName": "TopPhone",204 "mainCategoryId": 1,205 "mainCategoryName": "smartphone",206 "type": "product",207 "name": "Smartphone XYZ Pro 128GB",208 "sku": "SMPH001",209 "url": "/smartphone-xyz-pro-128gb",210 "comparisonPrice":2199.99,211 "stock":20,212 "medias":[213 {214 "id": 123,215 "type": "image",216 "title": "",217 "alternativeText": null,218 "file": "https://cdn.loja.com.br/upload/media/produto-media.webp",219 "originalFile": "https://cdn.loja.com.br/upload/media/produto-media.png",220 "size": null,221 "originalSize": null,222 "width": null,223 "height": null,224 "url": null225 }226 ],227 "combination":[1, 2, 3],228 "currentAttributes":[229 {230 "id":123,231 "name":"cor",232 "value":{233 "id":123,234 "label":"azul-escuro",235 "image":null,236 "originalImage":null,237 "color":"#00008B",238 "order":1239 }240 }241 ],242 "active": true243 }244 ],245 "relatedProducts": [246 {247 "id": 1234,248 "brandId": 1234,249 "brandName": "TopPhone",250 "mainCategoryId": 1,251 "mainCategoryName": "smartphone",252 "type": "product",253 "name": "Smartphone XYZ Pro 128GB",254 "sku": "SMPH001",255 "url": "/smartphone-xyz-pro-128gb",256 "comparisonPrice":2199.99,257 "stock":20,258 "medias":[259 {260 "id": 123,261 "type": "image",262 "title": "",263 "alternativeText": null,264 "file": "https://cdn.loja.com.br/upload/media/produto-media.webp",265 "originalFile": "https://cdn.loja.com.br/upload/media/produto-media.png",266 "size": null,267 "originalSize": null,268 "width": null,269 "height": null,270 "url": null271 }272 ],273 "combination":[1, 2, 3],274 "currentAttributes":[275 {276 "id":123,277 "name":"cor",278 "value":{279 "id":123,280 "label":"azul-escuro",281 "image":null,282 "originalImage":null,283 "color":"#00008B",284 "order":1285 }286 }287 ],288 "active": true289 }290 ],291 "filters": [292 {293 "id": 123,294 "productCategoryId": 1234,295 "name": "Marca",296 "active": true,297 "showInListing": true,298 "showInSpecificationTable": false,299 "type": "enum",300 "createdAt": "2025-01-14 10:31:00",301 "values": [302 {303 "id": 123,304 "name": "TechPhone",305 "image": null,306 "originalImage": null,307 "color": null,308 "order": 1,309 "value": null310 },311 {312 "id": 124,313 "name": "SmartScreen",314 "image": null,315 "originalImage": null,316 "color": null,317 "order": 1,318 "value": null319 }320 ]321 }322 ],323 "seals": [324 {325 "id": 5,326 "name": "Frete Grátis",327 "active": true,328 "textColor": "#FFFFFF",329 "sealColor": "#00A650",330 "image": "https://cdn.loja.com.br/seals/frete-gratis.png",331 "originalImage": "https://cdn.loja.com.br/seals/frete-gratis-original.png",332 "setting":{333 "id": 1234,334 "horizontalPosition": "left",335 "verticalPosition": "top",336 "proportionInProductDetail": 300,337 "proportionInProductShowcase": 300,338 "scheduling": {339 "id": 1234,340 "startDate": "2024-01-15 10:30:00",341 "endDate": "2024-01-30 10:30:00"342 }343 },344 "promotionLinkId":15,345 "createdAt":"2024-01-15 10:30:00",346 "updatedAt":"2024-01-15 10:30:00"347 }348 ],349 "mainCategory": {350 "id": 123,351 "name": "Smartphones",352 "url": "/smartphones"353 },354 "categories": [355 {356 "id": 100,357 "name": "Eletrônicos",358 "url": "/eletronicos"359 },360 {361 "id": 110,362 "name": "Telefonia",363 "url": "/eletronicos/telefonia"364 },365 {366 "id": 123,367 "name": "Smartphones",368 "url": "/eletronicos/telefonia/smartphones"369 }370 ],371 "categoryBreadcrumb": [372 {373 "id": 100,374 "name": "Eletrônicos",375 "url": "/eletronicos"376 },377 {378 "id": 110,379 "name": "Telefonia",380 "url": "/eletronicos/telefonia"381 },382 {383 "id": 123,384 "name": "Smartphones",385 "url": "/eletronicos/telefonia/smartphones"386 }387 ],388 "dimensions": {389 "shippingCargoTypeId": 1,390 "additionalTime": 0,391 "width": 7.5,392 "height": 15.2,393 "length": 0.8,394 "weight": 185395 },396 "parentProductId": null,397 "combination": [1234],398 "currentAttributes": [399 {400 "id": 1,401 "name": "Cor",402 "value": {403 "id": 123,404 "label": "Azul",405 "image": null,406 "originalImage": null,407 "color": "007BFF",408 "order": 1409 }410 }411 ],412 "variations": {413 "valueList": [414 1234415 ],416 "combinations": [417 {418 "productId": 1234,419 "brandId": 1,420 "brandName": "TechPhone",421 "mainCategoryId": 123,422 "mainCategoryName": "Tecnologia",423 "type": "variation",424 "sku": "ABC123",425 "name": "Variation Phone",426 "active": true,427 "url": "nice-phone-url",428 "comparisonPrice": 1800,429 "stock": 21,430 "medias": [431 {432 "id": 123,433 "type": "image",434 "title": "Variation Phone Image",435 "alternativeText": null,436 "file": "https://cdn.loja.com.br/upload/media.webp",437 "originalFile": "https://cdn.loja.com.br/upload/media.png",438 "size": null,439 "originalSize": null,440 "width": null,441 "height": null,442 "url": null443 }444 ],445 "combination": [446 1, 2447 ],448 "currentAttributes": [449 {450 "id": 1,451 "name": "Cor",452 "value": {453 "id": 1,454 "label": "Azul",455 "image": null,456 "originalImage": null,457 "color": "007BFF",458 "order": 1459 }460 }461 ]462 }463 ],464 "attributes": [465 {466 "id": 1,467 "name": "Cor",468 "displayName": "Cor",469 "includeSample": false,470 "values": [471 {472 "id": 1,473 "label": "Azul",474 "image": null,475 "originalImage": null,476 "color": "007BFF",477 "order": 1478 }479 ],480 "createdAt": "2025-07-23 22:50:28",481 "updatedAt": "2025-08-06 16:03:59"482 }483 ]484 },485 "medias": [486 {487 "id": 1234,488 "type": "image",489 "title": "Imagem Principal",490 "alternativeText": "Smartphone XYZ Pro vista frontal",491 "file": "https://cdn.loja.com.br/products/smartphone-xyz-pro-01.jpg",492 "originalFile": "https://cdn.loja.com.br/products/smartphone-xyz-pro-01-original.jpg",493 "size": 245680,494 "originalSize": 1567890,495 "width": 800,496 "height": 800,497 "url": "https://cdn.loja.com.br/products/smartphone-xyz-pro-01.jpg"498 }499 ],500 "bannerGroups": [501 "banner 1",502 "banner 2",503 "banner 3"504 ],505 "status": "available",506 "createdAt": "2024-01-15 10:30:00",507 "updatedAt": "2024-10-01 15:45:00",508 "url": "/smartphone-xyz-pro-128gb",509 "urls": [510 {511 "tradePolicyId": 1,512 "url": "/smartphone-xyz-pro-128gb",513 "redirect": false,514 "redirectCode": null,515 "target": null,516 "createdAt": "2024-01-15T10:30:00Z",517 "updatedAt": "2024-01-15T10:30:00Z"518 }519 ],520 "linkedTradePolicies": [1, 2, 3],521 "description": {522 "id": 1234,523 "productId": 1234,524 "tradePolicyId": 1,525 "name": "Smartphone XYZ Pro 128GB",526 "shortDescription": "O mais avançado smartphone com 128GB de armazenamento",527 "description": "<p>Smartphone com processador octa-core, câmera tripla de 64MP e bateria de longa duração...</p>",528 "searchDescription": "smartphone xyz pro 128gb android camera 64mp bateria",529 "videoUrl": "https://youtube.com/watch?v=example",530 "customDescription1": null,531 "customDescription2": null,532 "customDescription3": null,533 "measureTable": null,534 "seoTitle": "Smartphone XYZ Pro 128GB - Compre Agora",535 "seoDescription": "Compre o Smartphone XYZ Pro com 128GB de armazenamento. Câmera 64MP, processador rápido e entrega rápida.",536 "seoKeywords": "smartphone, xyz pro, 128gb, android",537 "seoCanonical": "https://loja.com.br/smartphone-xyz-pro-128gb",538 "seoSocialTitle": "Smartphone XYZ Pro 128GB",539 "seoSocialDescription": "O melhor smartphone do mercado",540 "seoTwitterImageUrl": "https://cdn.loja.com.br/products/smartphone-xyz-pro-twitter.jpg",541 "seoGraphImageUrl": "https://cdn.loja.com.br/products/smartphone-xyz-pro-og.jpg",542 "seoGoogleCategoryId": 2895,543 "seoIndexOnGoogle": true,544 "seoGoogleCondition": "new",545 "seoGoogleAgeGroup": "adult",546 "seoGoogleGender": "unisex",547 "seoStructuredData": null548 }549 }550 ]551 ],552 "pagination": {553 "limit": 10,554 "offset": 0,555 "pages": 1,556 "registers": 2557 }558}Produto por Variação
GET
/publics/products/{productId}/variation/{attributeValueList}
Obtém detalhes de um produto específico baseado em variações selecionadas
Descrição
Endpoint responsável por retornar os detalhes de um produto com base nas variações selecionadas 🎨🛍️.
Permite obter informações específicas do produto de acordo com a combinação de atributos ou opções escolhidas, como:
- Tamanho
- Cor
- Modelo
- Outras variações configuradas
Ideal para atualizar a página do produto com informações corretas de preço, estoque e imagens conforme a escolha do cliente.
Parâmetros de Query
Parâmetros da URL
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| productId | integer | Sim | ID do produto pai |
| attributeValueList | string | Sim | Lista de IDs dos valores de atributos separados por hífen (ex: 5-12 para Cor=5 e Tamanho=12) |
Campos Disponíveis (fields)
Especifique apenas os campos necessários para otimizar a performance:
| Campo | Descrição |
|---|---|
| brand | Informações completas da marca do produto |
| flags | Flags do produto (showInSite, saleWithoutStock, minimumStock) |
| mainUrl | URL principal do produto |
| secondaryUrls | URLs secundárias do produto |
| description | Descrições (short, full, searchDescription) |
| parentProduct | Produto pai do produto atual |
| indicatedProducts | Produtos indicados relacionados |
| relatedProducts | Produtos relacionados |
| tax | Informações de impostos e taxas |
| filters | Filtros e atributos aplicáveis |
| stockByStorage | Estoque por armazém |
| stock | Informações consolidadas de estoque |
| seals | Selos e certificações do produto |
| mainCategory | Categoria principal |
| categories | Todas as categorias do produto |
| categoryBreadcrumb | Breadcrumb de navegação de categorias |
| dimension | Dimensões físicas (peso, altura, largura, comprimento) |
| variation | Variações do produto (cores, tamanhos, etc) |
| media | Mídias (imagens, vídeos, arquivos) |
| price | Preço, promoções e parcelamento |
| priceRules | Regras de preço aplicadas |
| bannerGroups | Grupos de banners associados |
| review | Avaliações e reviews |
| status | Status do produto |
| haveChildren | Verifica se tem produtos filhos |
| restriction | Restrição de compra do produto (tradePolicyId, requiredAge) |
| availableCoupons | Retorna até 10 cupons aplicáveis ao produto |
Estrutura do field availableCoupons
Cada item do array representa um cupom aplicável ao produto. O nó discounts detalha as faixas de desconto:
1{2 "id": 15,3 "hash": "PROMO10",4 "discounts": [5 {6 "entityId": 15,7 "entity": "coupon",8 "itemAmount": 3,9 "value": 1010 }11 ],12 "createdAt": "2026-01-01 00:00:00",13 "updatedAt": "2026-01-01 00:00:00"14}| Campo | Tipo | Descrição |
|---|---|---|
id | integer | ID do cupom |
hash | string | Código do cupom (inserido pelo cliente no checkout) |
discounts[].entityId | integer | ID da entidade referenciada em entity |
discounts[].entity | string | Entidade que recebe o desconto |
discounts[].itemAmount | number | Quantidade mínima de itens para que o desconto em value seja aplicado |
discounts[].value | number | Valor do desconto aplicado quando itemAmount é atingido |
Exemplo de Requisição
1curl --request GET \2 --url {{MAIN_URL}}/publics/products/{productId}/variation/{attributeValueList} \✅ Resposta de Sucesso
1{2 "id": 1234,3 "type": "variation",4 "sku": "SMPH001",5 "name": "Smartphone XYZ Pro 128GB",6 "priority": 100,7 "basePrice": 1199.90,8 "active": true,9 "review": {10 "productId": 1234,11 "averageRating": 4.67,12 "quantityRating": 32813 },14 "isGiftCard": false,15 "stock": {16 "productId": 1234,17 "productStorageId": 1,18 "availableStock": 15,19 "reservedStock": 2,20 "updatedAt": "2024-10-01 14:30:00"21 },22 "stocks": [23 {24 "productId": 1234,25 "productStorageId": 1,26 "availableStock": 15,27 "reservedStock": 2,28 "updatedAt": "2024-10-01 14:30:00"29 },30 {31 "productId": 1234,32 "productStorageId": 2,33 "availableStock": 8,34 "reservedStock": 1,35 "updatedAt": "2024-10-01 14:30:00"36 }37 ],38 "originalPrice": {39 "comparisonPrice": 0,40 "salePrice": 0,41 "markup": 0,42 "ruleId": 0,43 "ruleTrigger": "original",44 "ruleName": "Original",45 "availableForSale": true,46 "basePrice": false,47 "priceWithDiscount": 0,48 "installments": [],49 "scheduling": null50 },51 "price": {52 "comparisonPrice": 1499.90,53 "salePrice": 1199.90,54 "markup": 25.02,55 "ruleId": 15,56 "ruleTrigger": "original",57 "ruleName": "Original",58 "availableForSale": true,59 "basePrice": false,60 "priceWithDiscount": 1199.90,61 "installments": [62 {63 "installment": 1,64 "installmentValue": 1199.90,65 "totalValue": 1199.90,66 "fee": null,67 "feeTotalValue": 068 },69 {70 "installment": 2,71 "installmentValue": 599.95,72 "totalValue": 1199.90,73 "fee": null,74 "feeTotalValue": 075 },76 {77 "installment": 12,78 "installmentValue": 99.99,79 "totalValue": 1199.88,80 "fee": null,81 "feeTotalValue": 082 }83 ],84 "scheduling": {85 "id": 46,86 "startDate": "2026-02-07 09:00:00",87 "endDate": "2026-10-30 23:59:59"88 }89 },90 "priceRules": null,91 "brand": {92 "id": 45,93 "code": "TECH",94 "name": "TechBrand",95 "logo": "https://cdn.loja.com.br/brands/techbrand-logo.jpg",96 "originalLogo": "https://cdn.loja.com.br/brands/techbrand-logo-original.jpg",97 "productOrdering": "name_asc",98 "active": true,99 "bannerGroups": [],100 "createdAt": "2023-10-04 19:11:08",101 "updatedAt": "2025-08-20 12:41:03",102 "url": "/marca/techbrand"103 },104 "flags": {105 "subscription": false,106 "service": false,107 "showInSite": true,108 "saleWithoutStock": false,109 "minimumStock": 5110 },111 "tax": {112 "mpn": "MPN123456",113 "ean": "7891234567890",114 "ncm": "85171231",115 "exclusive": false116 },117 "indicatedProducts": [118 {119 "id": 1234,120 "brandId": 1234,121 "brandName": "TopPhone",122 "mainCategoryId": 1,123 "mainCategoryName": "smartphone",124 "type": "product",125 "name": "Smartphone XYZ Pro 128GB",126 "sku": "SMPH001",127 "url": "/smartphone-xyz-pro-128gb",128 "comparisonPrice":2199.99,129 "stock":20,130 "medias":[131 {132 "id": 123,133 "type": "image",134 "title": "",135 "alternativeText": null,136 "file": "https://cdn.loja.com.br/upload/media/produto-media.webp",137 "originalFile": "https://cdn.loja.com.br/upload/media/produto-media.png",138 "size": null,139 "originalSize": null,140 "width": null,141 "height": null,142 "url": null143 }144 ],145 "combination":[1, 2, 3],146 "currentAttributes":[147 {148 "id":123,149 "name":"cor",150 "value":{151 "id":123,152 "label":"azul-escuro",153 "image":null,154 "originalImage":null,155 "color":"#00008B",156 "order":1157 }158 }159 ],160 "active": true161 }162 ],163 "relatedProducts": [164 {165 "id": 1234,166 "brandId": 1234,167 "brandName": "TopPhone",168 "mainCategoryId": 1,169 "mainCategoryName": "smartphone",170 "type": "product",171 "name": "Smartphone XYZ Pro 128GB",172 "sku": "SMPH001",173 "url": "/smartphone-xyz-pro-128gb",174 "comparisonPrice":2199.99,175 "stock":20,176 "medias":[177 {178 "id": 123,179 "type": "image",180 "title": "",181 "alternativeText": null,182 "file": "https://cdn.loja.com.br/upload/media/produto-media.webp",183 "originalFile": "https://cdn.loja.com.br/upload/media/produto-media.png",184 "size": null,185 "originalSize": null,186 "width": null,187 "height": null,188 "url": null189 }190 ],191 "combination":[1, 2, 3],192 "currentAttributes":[193 {194 "id":123,195 "name":"cor",196 "value":{197 "id":123,198 "label":"azul-escuro",199 "image":null,200 "originalImage":null,201 "color":"#00008B",202 "order":1203 }204 }205 ],206 "active": true207 }208 ],209 "filters": [210 {211 "id": 123,212 "productCategoryId": 1234,213 "name": "Marca",214 "active": true,215 "showInListing": true,216 "showInSpecificationTable": false,217 "type": "enum",218 "createdAt": "2025-01-14 10:31:00",219 "values": [220 {221 "id": 123,222 "name": "TechPhone",223 "image": null,224 "originalImage": null,225 "color": null,226 "order": 1,227 "value": null228 },229 {230 "id": 124,231 "name": "SmartScreen",232 "image": null,233 "originalImage": null,234 "color": null,235 "order": 1,236 "value": null237 }238 ]239 }240 ],241 "seals": [242 {243 "id": 5,244 "name": "Frete Grátis",245 "active": true,246 "textColor": "#FFFFFF",247 "sealColor": "#00A650",248 "image": "https://cdn.loja.com.br/seals/frete-gratis.png",249 "originalImage": "https://cdn.loja.com.br/seals/frete-gratis-original.png",250 "setting":{251 "id": 1234,252 "horizontalPosition": "left",253 "verticalPosition": "top",254 "proportionInProductDetail": 300,255 "proportionInProductShowcase": 300,256 "scheduling": {257 "id": 1234,258 "startDate": "2024-01-15 10:30:00",259 "endDate": "2024-01-30 10:30:00"260 }261 },262 "promotionLinkId":15,263 "createdAt":"2024-01-15 10:30:00",264 "updatedAt":"2024-01-15 10:30:00"265 }266 ],267 "mainCategory": {268 "id": 123,269 "name": "Smartphones",270 "url": "/smartphones"271 },272 "categories": [273 {274 "id": 100,275 "name": "Eletrônicos",276 "url": "/eletronicos"277 },278 {279 "id": 110,280 "name": "Telefonia",281 "url": "/eletronicos/telefonia"282 },283 {284 "id": 123,285 "name": "Smartphones",286 "url": "/eletronicos/telefonia/smartphones"287 }288 ],289 "categoryBreadcrumb": [290 {291 "id": 100,292 "name": "Eletrônicos",293 "url": "/eletronicos"294 },295 {296 "id": 110,297 "name": "Telefonia",298 "url": "/eletronicos/telefonia"299 },300 {301 "id": 123,302 "name": "Smartphones",303 "url": "/eletronicos/telefonia/smartphones"304 }305 ],306 "dimensions": {307 "shippingCargoTypeId": 1,308 "additionalTime": 0,309 "width": 7.5,310 "height": 15.2,311 "length": 0.8,312 "weight": 185313 },314 "parentProductId": null,315 "combination": [1234],316 "currentAttributes": [317 {318 "id": 1,319 "name": "Cor",320 "value": {321 "id": 123,322 "label": "Azul",323 "image": null,324 "originalImage": null,325 "color": "007BFF",326 "order": 1327 }328 }329 ],330 "variations": {331 "valueList": [332 1234333 ],334 "combinations": [335 {336 "productId": 1234,337 "brandId": 1,338 "brandName": "TechPhone",339 "mainCategoryId": 123,340 "mainCategoryName": "Tecnologia",341 "type": "variation",342 "sku": "ABC123",343 "name": "Variation Phone",344 "active": true,345 "url": "nice-phone-url",346 "comparisonPrice": 1800,347 "stock": 21,348 "medias": [349 {350 "id": 123,351 "type": "image",352 "title": "Variation Phone Image",353 "alternativeText": null,354 "file": "https://cdn.loja.com.br/upload/media.webp",355 "originalFile": "https://cdn.loja.com.br/upload/media.png",356 "size": null,357 "originalSize": null,358 "width": null,359 "height": null,360 "url": null361 }362 ],363 "combination": [364 1, 2365 ],366 "currentAttributes": [367 {368 "id": 1,369 "name": "Cor",370 "value": {371 "id": 1,372 "label": "Azul",373 "image": null,374 "originalImage": null,375 "color": "007BFF",376 "order": 1377 }378 }379 ]380 }381 ],382 "attributes": [383 {384 "id": 1,385 "name": "Cor",386 "displayName": "Cor",387 "includeSample": false,388 "values": [389 {390 "id": 1,391 "label": "Azul",392 "image": null,393 "originalImage": null,394 "color": "007BFF",395 "order": 1396 }397 ],398 "createdAt": "2025-07-23 22:50:28",399 "updatedAt": "2025-08-06 16:03:59"400 }401 ]402 },403 "medias": [404 {405 "id": 1234,406 "type": "image",407 "title": "Imagem Principal",408 "alternativeText": "Smartphone XYZ Pro vista frontal",409 "file": "https://cdn.loja.com.br/products/smartphone-xyz-pro-01.jpg",410 "originalFile": "https://cdn.loja.com.br/products/smartphone-xyz-pro-01-original.jpg",411 "size": 245680,412 "originalSize": 1567890,413 "width": 800,414 "height": 800,415 "url": "https://cdn.loja.com.br/products/smartphone-xyz-pro-01.jpg"416 }417 ],418 "bannerGroups": [419 "banner 1",420 "banner 2",421 "banner 3"422 ],423 "status": "available",424 "createdAt": "2024-01-15 10:30:00",425 "updatedAt": "2024-10-01 15:45:00",426 "url": "/smartphone-xyz-pro-128gb",427 "urls": [428 {429 "tradePolicyId": 1,430 "url": "/smartphone-xyz-pro-128gb",431 "redirect": false,432 "redirectCode": null,433 "target": null,434 "createdAt": "2024-01-15 10:30:00",435 "updatedAt": "2024-01-15 10:30:00"436 }437 ],438 "linkedTradePolicies": [1, 2, 3],439 "description": {440 "id": 1234,441 "productId": 1234,442 "tradePolicyId": 1,443 "name": "Smartphone XYZ Pro 128GB",444 "shortDescription": "O mais avançado smartphone com 128GB de armazenamento",445 "description": "<p>Smartphone com processador octa-core, câmera tripla de 64MP e bateria de longa duração...</p>",446 "searchDescription": "smartphone xyz pro 128gb android camera 64mp bateria",447 "videoUrl": "https://youtube.com/watch?v=example",448 "customDescription1": null,449 "customDescription2": null,450 "customDescription3": null,451 "measureTable": null,452 "seoTitle": "Smartphone XYZ Pro 128GB - Compre Agora",453 "seoDescription": "Compre o Smartphone XYZ Pro com 128GB de armazenamento. Câmera 64MP, processador rápido e entrega rápida.",454 "seoKeywords": "smartphone, xyz pro, 128gb, android",455 "seoCanonical": "https://loja.com.br/smartphone-xyz-pro-128gb",456 "seoSocialTitle": "Smartphone XYZ Pro 128GB",457 "seoSocialDescription": "O melhor smartphone do mercado",458 "seoTwitterImageUrl": "https://cdn.loja.com.br/products/smartphone-xyz-pro-twitter.jpg",459 "seoGraphImageUrl": "https://cdn.loja.com.br/products/smartphone-xyz-pro-og.jpg",460 "seoGoogleCategoryId": 2895,461 "seoIndexOnGoogle": true,462 "seoGoogleCondition": "new",463 "seoGoogleAgeGroup": "adult",464 "seoGoogleGender": "unisex",465 "seoStructuredData": null466 }467}Compre Junto (Pair Offers)
GET
/publics/products/{productId}/pair-offers
Lista produtos recomendados para compra conjunta (Compre Junto)
Descrição
Endpoint responsável por buscar produtos complementares (Compre Junto) 🔗🛍️.
Ele retorna uma lista de produtos relacionados a um produto específico, permitindo sugerir itens que combinam ou que geralmente são adquiridos juntos, melhorando a experiência de compra e potencializando vendas.
Parâmetros de Query
Parâmetros da URL
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| productId | integer | Sim | ID do produto principal |
Parâmetros de Corpo
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| fields | array | Não | Array de campos específicos para retornar no produto |
| variationMap | array | Não | Mapeamento de variações selecionadas (formato: variationMap[produtoId]=variacaoId) |
Campos Disponíveis (fields)
Especifique apenas os campos necessários para otimizar a performance:
| Campo | Descrição |
|---|---|
| brand | Informações completas da marca do produto |
| flags | Flags do produto (showInSite, saleWithoutStock, minimumStock) |
| mainUrl | URL principal do produto |
| secondaryUrls | URLs secundárias do produto |
| description | Descrições (short, full, searchDescription) |
| parentProduct | Produto pai do produto atual |
| indicatedProducts | Produtos indicados relacionados |
| relatedProducts | Produtos relacionados |
| tax | Informações de impostos e taxas |
| filters | Filtros e atributos aplicáveis |
| stockByStorage | Estoque por armazém |
| stock | Informações consolidadas de estoque |
| seals | Selos e certificações do produto |
| mainCategory | Categoria principal |
| categories | Todas as categorias do produto |
| categoryBreadcrumb | Breadcrumb de navegação de categorias |
| dimension | Dimensões físicas (peso, altura, largura, comprimento) |
| variation | Variações do produto (cores, tamanhos, etc) |
| media | Mídias (imagens, vídeos, arquivos) |
| price | Preço, promoções e parcelamento |
| priceRules | Regras de preço aplicadas |
| bannerGroups | Grupos de banners associados |
| review | Avaliações e reviews |
| status | Status do produto |
| haveChildren | Verifica se tem produtos filhos |
| restriction | Restrição de compra do produto (tradePolicyId, requiredAge) |
| availableCoupons | Retorna até 10 cupons aplicáveis ao produto |
Estrutura do field availableCoupons
Cada item do array representa um cupom aplicável ao produto. O nó discounts detalha as faixas de desconto:
1{2 "id": 15,3 "hash": "PROMO10",4 "discounts": [5 {6 "entityId": 15,7 "entity": "coupon",8 "itemAmount": 3,9 "value": 1010 }11 ],12 "createdAt": "2026-01-01 00:00:00",13 "updatedAt": "2026-01-01 00:00:00"14}| Campo | Tipo | Descrição |
|---|---|---|
id | integer | ID do cupom |
hash | string | Código do cupom (inserido pelo cliente no checkout) |
discounts[].entityId | integer | ID da entidade referenciada em entity |
discounts[].entity | string | Entidade que recebe o desconto |
discounts[].itemAmount | number | Quantidade mínima de itens para que o desconto em value seja aplicado |
discounts[].value | number | Valor do desconto aplicado quando itemAmount é atingido |
Exemplo de Requisição
1curl --request GET \2 --url {{MAIN_URL}}/publics/products/{productId}/pair-offers \✅ Resposta de Sucesso
1[2 {3 "productId1": 1234,4 "productId2": 456,5 "target": "product2",6 "active": true,7 "createdAt": "2024-01-15T10:30:00Z",8 "priceRule": {9 "id": 123,10 "name": "pair-offer-price-rule",11 "trigger": "automatic",12 "ruleTarget": "product",13 "origin": "pair-offer",14 "applyInGroup": false,15 "updateComparisonPrice": "not-update",16 "basePriceField": "sale-price",17 "code": null,18 "beginQuantity": 0,19 "endQuantity": 0,20 "value": -20,21 "valueType": "percentage",22 "priority": 0,23 "active": true,24 "scheduling": null,25 "tradePolicies": [],26 "productIds": [],27 "productCategoryIds": [],28 "productBrandIds": [],29 "lastUpdateUserName": null,30 "createdAt": "2023-10-04 19:11:08",31 "updatedAt": "2025-08-20 12:41:03"32 },33 "price": {34 "comparisonPrice": 169.90,35 "discountValue": 25.48,36 "salePrice": 144.4237 },38 "products": [39 {40 "id": 1234,41 "type": "product",42 "sku": "SMPH001",43 "name": "Smartphone XYZ Pro 128GB",44 "priority": 100,45 "basePrice": 1199.90,46 "active": true,47 "review": {48 "productId":1234,49 "averageRating":5,50 "quantityRating":751 },52 "isGiftCard": false,53 "stock": {54 "productId": 1234,55 "productStorageId":123,56 "availableStock": 15,57 "reservedStock": 0,58 "updatedAt": "2024-01-15 10:30:00"59 },60 "stocks": null,61 "originalPrice": null,62 "price": {63 "comparisonPrice": 1499.90,64 "salePrice": 1199.90,65 "markup": 0,66 "ruleId":123,67 "ruleTrigger": "original",68 "ruleName": "original",69 "availableForSale": true,70 "basePrice":false,71 "priceWithDiscount": 1100.90,72 "installments": [],73 "scheduling": {74 "id": 46,75 "startDate": "2026-02-07 09:00:00",76 "endDate": "2026-10-30 23:59:59"77 }78 },79 "priceRules": null,80 "brand": {81 "id": 45,82 "code": "TECH",83 "name": "TechBrand",84 "logo": "https://cdn.loja.com.br/brands/techbrand-logo.jpg",85 "originalLogo": "https://cdn.loja.com.br/brands/techbrand-logo-original.jpg",86 "active": true,87 "url": "/marca/techbrand"88 },89 "flags": null,90 "tax": null,91 "indicatedProducts": null,92 "relatedProducts": null,93 "filters": null,94 "seals": null,95 "mainCategory": null96 "categories": [],97 "categoryBreacrumb": null,98 "dimensions": null,99 "parentProductId": null,100 "combination": [],101 "currentAttributes": null,102 "variations": null,103 "medias": [104 {105 "id": 123,106 "type": "image",107 "title": "",108 "alternativeText": null,109 "file": "\/upload\/media\/produto-media.webp",110 "originalFile": "\/upload\/media\/produto-media.png",111 "size": null,112 "originalSize": null,113 "width": null,114 "height": null,115 "url": null116 }117 ]118 "bannerGroups": [],119 "status": "available",120 "createdAt": "2024-01-15 10:30:00",121 "updatedAt": "2024-10-01 15:45:00",122 "url": "/smartphone-xyz-pro-128gb",123 "urls": [124 {125 "tradePolicyId": 1,126 "url": "/smartphone-xyz-pro-128gb",127 "redirect": false,128 "redirectCode": null,129 "target": null,130 "createdAt": "2024-01-15 10:30:00",131 "updatedAt": "2024-01-15 10:30:00"132 }133 ],134 "linkedTradePolicies": [1, 2, 3],135 "description": null136 }137 ]138 }139]Upsells por Localização
GET
/publics/products/upsells/{locationId}
Lista produtos de upsell configurados para uma localização específica
Descrição
Endpoint responsável por executar segmentação de produtos para upsell 📈🛍️.
Funciona da seguinte forma:
- Recebe localização do cliente e itens no corpo da requisição
- Retorna os produtos complementares ou sugestões de upsell disponíveis
- Permite otimizar a oferta de produtos relacionados de forma personalizada, aumentando a conversão e o ticket médio
Parâmetros de Query
Headers Obrigatórios
| Header | Valor | Descrição |
|---|---|---|
Content-Type | application/json | Tipo de conteúdo |
Parâmetros da URL
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| locationId | string | Sim | Identificador do local de exibição do upsell (ex: cart, checkout, product-detail, post-purchase, minicart) |
Campos Disponíveis (fields)
Especifique apenas os campos necessários para otimizar a performance:
| Campo | Descrição |
|---|---|
| brand | Informações completas da marca do produto |
| flags | Flags do produto (showInSite, saleWithoutStock, minimumStock) |
| mainUrl | URL principal do produto |
| secondaryUrls | URLs secundárias do produto |
| description | Descrições (short, full, searchDescription) |
| parentProduct | Produto pai do produto atual |
| indicatedProducts | Produtos indicados relacionados |
| relatedProducts | Produtos relacionados |
| tax | Informações de impostos e taxas |
| filters | Filtros e atributos aplicáveis |
| stockByStorage | Estoque por armazém |
| stock | Informações consolidadas de estoque |
| seals | Selos e certificações do produto |
| mainCategory | Categoria principal |
| categories | Todas as categorias do produto |
| categoryBreadcrumb | Breadcrumb de navegação de categorias |
| dimension | Dimensões físicas (peso, altura, largura, comprimento) |
| variation | Variações do produto (cores, tamanhos, etc) |
| media | Mídias (imagens, vídeos, arquivos) |
| price | Preço, promoções e parcelamento |
| priceRules | Regras de preço aplicadas |
| bannerGroups | Grupos de banners associados |
| review | Avaliações e reviews |
| status | Status do produto |
| haveChildren | Verifica se tem produtos filhos |
| restriction | Restrição de compra do produto (tradePolicyId, requiredAge) |
| availableCoupons | Retorna até 10 cupons aplicáveis ao produto |
Estrutura do field availableCoupons
Cada item do array representa um cupom aplicável ao produto. O nó discounts detalha as faixas de desconto:
1{2 "id": 15,3 "hash": "PROMO10",4 "discounts": [5 {6 "entityId": 15,7 "entity": "coupon",8 "itemAmount": 3,9 "value": 1010 }11 ],12 "createdAt": "2026-01-01 00:00:00",13 "updatedAt": "2026-01-01 00:00:00"14}| Campo | Tipo | Descrição |
|---|---|---|
id | integer | ID do cupom |
hash | string | Código do cupom (inserido pelo cliente no checkout) |
discounts[].entityId | integer | ID da entidade referenciada em entity |
discounts[].entity | string | Entidade que recebe o desconto |
discounts[].itemAmount | number | Quantidade mínima de itens para que o desconto em value seja aplicado |
discounts[].value | number | Valor do desconto aplicado quando itemAmount é atingido |
Parâmetros de Corpo
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| fields | array | Não | Array de campos específicos para retornar no produto |
| variationMap | array | Não | Mapeamento de variações selecionadas |
| segmentationItems | array | Não | Itens para segmentação de upsells personalizados |
| segmentationItems[].productId | integer | Não | ID do produto no carrinho |
| segmentationItems[].categoryId | integer | Não | ID da categoria do produto |
| segmentationItems[].brandId | integer | Não | ID da marca do produto |
| segmentationItems[].tradePolicyId | integer | Não | ID da política comercial |
| segmentationItems[].customerId | integer | Não | ID do cliente (se autenticado) |
| segmentationItems[].quantity | integer | Não | Quantidade do produto |
| segmentationItems[].value | number | Não | Valor total do produto |
Exemplo de Requisição
1curl --request GET \2 --url {{MAIN_URL}}/publics/products/upsells/{locationId} \✅ Resposta de Sucesso
1[2 {3 "id": 1234,4 "displayTitle": "Proteja seu investimento!",5 "displayDescription": "Adicione garantia estendida com 47% de desconto",6 "displayButtonText": "Adicionar Proteção",7 "quantity": 1,8 "upsellProduct": {9 "id": 1234,10 "type": "product",11 "sku": "SMPH001",12 "name": "Smartphone XYZ Pro 128GB",13 "priority": 100,14 "basePrice": 1199.90,15 "active": true,16 "review": {17 "productId": 1234,18 "averageRating": 4.67,19 "quantityRating": 32820 },21 "isGiftCard": false,22 "stock": {23 "productId": 1234,24 "productStorageId": 1,25 "availableStock": 15,26 "reservedStock": 2,27 "updatedAt": "2024-10-01 14:30:00"28 },29 "stocks": [30 {31 "productId": 1234,32 "productStorageId": 1,33 "availableStock": 15,34 "reservedStock": 2,35 "updatedAt": "2024-10-01 14:30:00"36 },37 {38 "productId": 1234,39 "productStorageId": 2,40 "availableStock": 8,41 "reservedStock": 1,42 "updatedAt": "2024-10-01 14:30:00"43 }44 ],45 "originalPrice": {46 "comparisonPrice": 0,47 "salePrice": 0,48 "markup": 0,49 "ruleId": 0,50 "ruleTrigger": "original",51 "ruleName": "Original",52 "availableForSale": true,53 "basePrice": false,54 "priceWithDiscount": 0,55 "installments": [],56 "scheduling": null57 },58 "price": {59 "comparisonPrice": 1499.90,60 "salePrice": 1199.90,61 "markup": 25.02,62 "ruleId": 15,63 "ruleTrigger": "original",64 "ruleName": "Original",65 "availableForSale": true,66 "basePrice": false,67 "priceWithDiscount": 1199.90,68 "installments": [69 {70 "installment": 1,71 "installmentValue": 1199.90,72 "totalValue": 1199.90,73 "fee": null,74 "feeTotalValue": 075 },76 {77 "installment": 2,78 "installmentValue": 599.95,79 "totalValue": 1199.90,80 "fee": null,81 "feeTotalValue": 082 },83 {84 "installment": 12,85 "installmentValue": 99.99,86 "totalValue": 1199.88,87 "fee": null,88 "feeTotalValue": 089 }90 ],91 "scheduling": {92 "id": 46,93 "startDate": "2026-02-07 09:00:00",94 "endDate": "2026-10-30 23:59:59"95 }96 },97 "priceRules": null,98 "brand": {99 "id": 45,100 "code": "TECH",101 "name": "TechBrand",102 "logo": "https://cdn.loja.com.br/brands/techbrand-logo.jpg",103 "originalLogo": "https://cdn.loja.com.br/brands/techbrand-logo-original.jpg",104 "productOrdering": "name_asc",105 "active": true,106 "bannerGroups": [],107 "createdAt": "2023-10-04 19:11:08",108 "updatedAt": "2025-08-20 12:41:03",109 "url": "/marca/techbrand"110 },111 "flags": {112 "subscription": false,113 "service": false,114 "showInSite": true,115 "saleWithoutStock": false,116 "minimumStock": 5117 },118 "tax": {119 "mpn": "MPN123456",120 "ean": "7891234567890",121 "ncm": "85171231",122 "exclusive": false123 },124 "indicatedProducts": [125 {126 "id": 1234,127 "brandId": 1234,128 "brandName": "TopPhone",129 "mainCategoryId": 1,130 "mainCategoryName": "smartphone",131 "type": "product",132 "name": "Smartphone XYZ Pro 128GB",133 "sku": "SMPH001",134 "url": "/smartphone-xyz-pro-128gb",135 "comparisonPrice":2199.99,136 "stock":20,137 "medias":[138 {139 "id": 123,140 "type": "image",141 "title": "",142 "alternativeText": null,143 "file": "https://cdn.loja.com.br/upload/media/produto-media.webp",144 "originalFile": "https://cdn.loja.com.br/upload/media/produto-media.png",145 "size": null,146 "originalSize": null,147 "width": null,148 "height": null,149 "url": null150 }151 ],152 "combination":[1, 2, 3],153 "currentAttributes":[154 {155 "id":123,156 "name":"cor",157 "value":{158 "id":123,159 "label":"azul-escuro",160 "image":null,161 "originalImage":null,162 "color":"#00008B",163 "order":1164 }165 }166 ],167 "active": true168 }169 ],170 "relatedProducts": [171 {172 "id": 1234,173 "brandId": 1234,174 "brandName": "TopPhone",175 "mainCategoryId": 1,176 "mainCategoryName": "smartphone",177 "type": "product",178 "name": "Smartphone XYZ Pro 128GB",179 "sku": "SMPH001",180 "url": "/smartphone-xyz-pro-128gb",181 "comparisonPrice":2199.99,182 "stock":20,183 "medias":[184 {185 "id": 123,186 "type": "image",187 "title": "",188 "alternativeText": null,189 "file": "https://cdn.loja.com.br/upload/media/produto-media.webp",190 "originalFile": "https://cdn.loja.com.br/upload/media/produto-media.png",191 "size": null,192 "originalSize": null,193 "width": null,194 "height": null,195 "url": null196 }197 ],198 "combination":[1, 2, 3],199 "currentAttributes":[200 {201 "id":123,202 "name":"cor",203 "value":{204 "id":123,205 "label":"azul-escuro",206 "image":null,207 "originalImage":null,208 "color":"#00008B",209 "order":1210 }211 }212 ],213 "active": true214 }215 ],216 "filters": [217 {218 "id": 123,219 "productCategoryId": 1234,220 "name": "Marca",221 "active": true,222 "showInListing": true,223 "showInSpecificationTable": false,224 "type": "enum",225 "createdAt": "2025-01-14 10:31:00",226 "values": [227 {228 "id": 123,229 "name": "TechPhone",230 "image": null,231 "originalImage": null,232 "color": null,233 "order": 1,234 "value": null235 },236 {237 "id": 124,238 "name": "SmartScreen",239 "image": null,240 "originalImage": null,241 "color": null,242 "order": 1,243 "value": null244 }245 ]246 }247 ],248 "seals": [249 {250 "id": 5,251 "name": "Frete Grátis",252 "active": true,253 "textColor": "#FFFFFF",254 "sealColor": "#00A650",255 "image": "https://cdn.loja.com.br/seals/frete-gratis.png",256 "originalImage": "https://cdn.loja.com.br/seals/frete-gratis-original.png",257 "setting":{258 "id": 1234,259 "horizontalPosition": "left",260 "verticalPosition": "top",261 "proportionInProductDetail": 300,262 "proportionInProductShowcase": 300,263 "scheduling": {264 "id": 1234,265 "startDate": "2024-01-15 10:30:00",266 "endDate": "2024-01-30 10:30:00"267 }268 },269 "promotionLinkId":15,270 "createdAt":"2024-01-15 10:30:00",271 "updatedAt":"2024-01-15 10:30:00"272 }273 ],274 "mainCategory": {275 "id": 123,276 "name": "Smartphones",277 "url": "/smartphones"278 },279 "categories": [280 {281 "id": 100,282 "name": "Eletrônicos",283 "url": "/eletronicos"284 },285 {286 "id": 110,287 "name": "Telefonia",288 "url": "/eletronicos/telefonia"289 },290 {291 "id": 123,292 "name": "Smartphones",293 "url": "/eletronicos/telefonia/smartphones"294 }295 ],296 "categoryBreadcrumb": [297 {298 "id": 100,299 "name": "Eletrônicos",300 "url": "/eletronicos"301 },302 {303 "id": 110,304 "name": "Telefonia",305 "url": "/eletronicos/telefonia"306 },307 {308 "id": 123,309 "name": "Smartphones",310 "url": "/eletronicos/telefonia/smartphones"311 }312 ],313 "dimensions": {314 "shippingCargoTypeId": 1,315 "additionalTime": 0,316 "width": 7.5,317 "height": 15.2,318 "length": 0.8,319 "weight": 185320 },321 "parentProductId": null,322 "combination": [1234],323 "currentAttributes": [324 {325 "id": 1,326 "name": "Cor",327 "value": {328 "id": 123,329 "label": "Azul",330 "image": null,331 "originalImage": null,332 "color": "007BFF",333 "order": 1334 }335 }336 ],337 "variations": {338 "valueList": [339 1234340 ],341 "combinations": [342 {343 "productId": 1234,344 "brandId": 1,345 "brandName": "TechPhone",346 "mainCategoryId": 123,347 "mainCategoryName": "Tecnologia",348 "type": "variation",349 "sku": "ABC123",350 "name": "Variation Phone",351 "active": true,352 "url": "nice-phone-url",353 "comparisonPrice": 1800,354 "stock": 21,355 "medias": [356 {357 "id": 123,358 "type": "image",359 "title": "Variation Phone Image",360 "alternativeText": null,361 "file": "https://cdn.loja.com.br/upload/media.webp",362 "originalFile": "https://cdn.loja.com.br/upload/media.png",363 "size": null,364 "originalSize": null,365 "width": null,366 "height": null,367 "url": null368 }369 ],370 "combination": [371 1, 2372 ],373 "currentAttributes": [374 {375 "id": 1,376 "name": "Cor",377 "value": {378 "id": 1,379 "label": "Azul",380 "image": null,381 "originalImage": null,382 "color": "007BFF",383 "order": 1384 }385 }386 ]387 }388 ],389 "attributes": [390 {391 "id": 1,392 "name": "Cor",393 "displayName": "Cor",394 "includeSample": false,395 "values": [396 {397 "id": 1,398 "label": "Azul",399 "image": null,400 "originalImage": null,401 "color": "007BFF",402 "order": 1403 }404 ],405 "createdAt": "2025-07-23 22:50:28",406 "updatedAt": "2025-08-06 16:03:59"407 }408 ]409 },410 "medias": [411 {412 "id": 1234,413 "type": "image",414 "title": "Imagem Principal",415 "alternativeText": "Smartphone XYZ Pro vista frontal",416 "file": "https://cdn.loja.com.br/products/smartphone-xyz-pro-01.jpg",417 "originalFile": "https://cdn.loja.com.br/products/smartphone-xyz-pro-01-original.jpg",418 "size": 245680,419 "originalSize": 1567890,420 "width": 800,421 "height": 800,422 "url": "https://cdn.loja.com.br/products/smartphone-xyz-pro-01.jpg"423 }424 ],425 "bannerGroups": [426 "banner 1",427 "banner 2",428 "banner 3"429 ],430 "status": "available",431 "createdAt": "2024-01-15 10:30:00",432 "updatedAt": "2024-10-01 15:45:00",433 "url": "/smartphone-xyz-pro-128gb",434 "urls": [435 {436 "tradePolicyId": 1,437 "url": "/smartphone-xyz-pro-128gb",438 "redirect": false,439 "redirectCode": null,440 "target": null,441 "createdAt": "2024-01-15 10:30:00",442 "updatedAt": "2024-01-15 10:30:00"443 }444 ],445 "linkedTradePolicies": [1, 2, 3],446 "description": {447 "id": 1234,448 "productId": 1234,449 "tradePolicyId": 1,450 "name": "Smartphone XYZ Pro 128GB",451 "shortDescription": "O mais avançado smartphone com 128GB de armazenamento",452 "description": "<p>Smartphone com processador octa-core, câmera tripla de 64MP e bateria de longa duração...</p>",453 "searchDescription": "smartphone xyz pro 128gb android camera 64mp bateria",454 "videoUrl": "https://youtube.com/watch?v=example",455 "customDescription1": null,456 "customDescription2": null,457 "customDescription3": null,458 "measureTable": null,459 "seoTitle": "Smartphone XYZ Pro 128GB - Compre Agora",460 "seoDescription": "Compre o Smartphone XYZ Pro com 128GB de armazenamento. Câmera 64MP, processador rápido e entrega rápida.",461 "seoKeywords": "smartphone, xyz pro, 128gb, android",462 "seoCanonical": "https://loja.com.br/smartphone-xyz-pro-128gb",463 "seoSocialTitle": "Smartphone XYZ Pro 128GB",464 "seoSocialDescription": "O melhor smartphone do mercado",465 "seoTwitterImageUrl": "https://cdn.loja.com.br/products/smartphone-xyz-pro-twitter.jpg",466 "seoGraphImageUrl": "https://cdn.loja.com.br/products/smartphone-xyz-pro-og.jpg",467 "seoGoogleCategoryId": 2895,468 "seoIndexOnGoogle": true,469 "seoGoogleCondition": "new",470 "seoGoogleAgeGroup": "adult",471 "seoGoogleGender": "unisex",472 "seoStructuredData": null473 }474 },475 "priceRules": [476 {477 "id": 123,478 "name": "product-price-rule",479 "trigger": "automatic",480 "ruleTarget": "product",481 "origin": "product",482 "applyInGroup": false,483 "updateComparisonPrice": "not-update",484 "basePriceField": "sale-price",485 "code": "product-123",486 "beginQuantity": 1,487 "endQuantity": 1,488 "value": -20,489 "valueType": "percentage",490 "priority": 1,491 "active": true,492 "scheduling": {493 "id":1234,494 "starDate":"2023-10-03 19:24:01",495 "endDate":null496 },497 "tradePolicies": [1, 2, 3],498 "productIds": [3, 2, 1, 5, 7],499 "productCategoryIds": [8, 9, 45, 12],500 "productBrandIds": [10, 7, 20, 36],501 "lastUpdateUserName": "Marcos Brandão",502 "createdAt": "2023-10-04 19:11:08",503 "updatedAt": "2025-08-20 12:41:03"504 }505 ],506 }507]Previsão de promocional
GET
/publics/products/promotional-forecast
Permite que o cliente possa ver ganhos promocionais com a compra
Descrição
Endpoint responsável por calcular os pontos de fidelidade que o cliente poderá receber ao comprar um determinado produto, e por retornar as promoções aplicáveis ao produto informado ⭐🎁.
O cálculo leva em conta:
- O produto selecionado
- A quantidade que será adquirida
Assim, é possível estimar corretamente os pontos que serão creditados ao cliente na finalização da compra.
Além do sistema de pontos, o endpoint também verifica as promoções aplicáveis ao produto informado. Essa verificação considera a quantidade e o preço vigente na avaliação.
Parâmetros de Query
Headers Obrigatórios
| Header | Valor | Descrição |
|---|---|---|
Content-Type | application/json | Tipo de conteúdo |
Parâmetros do Corpo
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
productId | integer | ✅ | Identificador do produto que deve ser avaliado os ganhos |
quantity | integer | ❌ | Quantidade do produto que o cliente pretende levar (padrão: 1) |
Exemplo de Requisição
1curl --request GET \2 --url {{MAIN_URL}}/publics/products/promotional-forecast \3 --data '{4 "productId": 1,5 "quantity": 36 }'✅ Resposta de Sucesso
A resposta reúne dois blocos: pointSystem, com a previsão de pontos de fidelidade, e promotions, com as promoções aplicáveis ao produto informado.
1{2 "pointSystem": {3 "name": "System Point",4 "pointValue": 0.01,5 "finalAmount": 12.93,6 "finalValue": 0.12937 },8 "promotions": [9 {10 "entity": {11 "entity": "promotion",12 "identifier": 42,13 "description": "10% de desconto na compra de 3 unidades ou mais",14 "type": "percentage",15 "target": "subtotal",16 "error": null17 },18 "target": "subtotal",19 "value": 1020 }21 ]22}Campos da resposta — promotions[]
| Campo | Tipo | Descrição | |
|---|---|---|---|
entity.entity | string | Tipo da entidade (promotion) | |
entity.identifier | integer | ID da promoção | |
entity.description | string | Descrição da promoção | |
entity.type | string | Tipo do desconto: percentage (percentual) ou value (valor fixo) | |
entity.target | string | Alvo do desconto: subtotal, shipping ou subtotal-shipping | |
entity.error | string\ | null | Erro no processamento, null quando bem-sucedido |
target | string | Mesmo valor de entity.target | |
value | number | Magnitude do desconto — percentual quando type = percentage, valor em reais quando type = value |
⚠️ Possíveis erros:
Atenção: a seguir estão destacados os principais erros que podem ocorrer neste endpoint.
Os cenários descritos representam os erros mais relevantes do contexto atual, servindo como referência para entendimento e tratamento das falhas.
| Código Interno | Código Http | Descrição |
|---|---|---|
| UAPPI_STORE_PRODUCT_NOT_FOUND | 404 | O produto solicitado não foi encontrado. |
Listagem de Produtos
GET
/products
Retorna lista paginada de produtos com filtros e ordenação avançada
Descrição
Endpoint responsável por listar todos os produtos cadastrados na loja 🛍️.
Trata-se de uma listagem pública, dedicada para clientes que vão visualizar os produtos da loja.
Por ser um endpoint público, a consulta está sujeita às regras de filtragem do contexto público, possuindo acesso limitado aos produtos cadastrados.
Parâmetros de Query
Parâmetros de Metadados (meta)
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| meta.dimensions.size | string | Não | Unidade de medida para dimensões. Valores aceitos: Meter, Centimeter |
| meta.dimensions.weight | string | Não | Unidade de medida para peso. Valores aceitos: Gram, Kilogram |
| meta.priceParameters | array | Não | Parâmetros para cálculo de preço personalizado |
| meta.priceParameters.*.code | string | Não | Código do parâmetro (exatamente 32 caracteres) |
| meta.priceParameters.*.quantity | integer | Não | Quantidade do item |
| meta.priceParameters.*.upsellId | integer | Não | ID do upsell relacionado |
| meta.priceParameters.*.productPairOfferId | integer | Não | ID da oferta de par de produtos |
Campos Disponíveis (fields)
Especifique apenas os campos necessários para otimizar a performance:
| Campo | Descrição |
|---|---|
| brand | Informações completas da marca do produto |
| flags | Flags do produto (showInSite, saleWithoutStock, minimumStock) |
| mainUrl | URL principal do produto |
| secondaryUrls | URLs secundárias do produto |
| description | Descrições (short, full, searchDescription) |
| parentProduct | Produto pai do produto atual |
| indicatedProducts | Produtos indicados relacionados |
| relatedProducts | Produtos relacionados |
| tax | Informações de impostos e taxas |
| filters | Filtros e atributos aplicáveis |
| stockByStorage | Estoque por armazém |
| stock | Informações consolidadas de estoque |
| seals | Selos e certificações do produto |
| mainCategory | Categoria principal |
| categories | Todas as categorias do produto |
| categoryBreadcrumb | Breadcrumb de navegação de categorias |
| dimension | Dimensões físicas (peso, altura, largura, comprimento) |
| variation | Variações do produto (cores, tamanhos, etc) |
| media | Mídias (imagens, vídeos, arquivos) |
| price | Preço, promoções e parcelamento |
| priceRules | Regras de preço aplicadas |
| bannerGroups | Grupos de banners associados |
| review | Avaliações e reviews |
| status | Status do produto |
| haveChildren | Verifica se tem produtos filhos |
| restriction | Restrição de compra do produto (tradePolicyId, requiredAge) |
| availableCoupons | Retorna até 10 cupons aplicáveis aos produtos da listagem |
Estrutura do field availableCoupons
Cada item do array representa um cupom aplicável ao produto. O nó discounts detalha as faixas de desconto:
1{2 "id": 15,3 "hash": "PROMO10",4 "discounts": [5 {6 "entityId": 15,7 "entity": "coupon",8 "itemAmount": 3,9 "value": 1010 }11 ],12 "createdAt": "2026-01-01 00:00:00",13 "updatedAt": "2026-01-01 00:00:00"14}| Campo | Tipo | Descrição |
|---|---|---|
id | integer | ID do cupom |
hash | string | Código do cupom (inserido pelo cliente no checkout) |
discounts[].entityId | integer | ID da entidade referenciada em entity |
discounts[].entity | string | Entidade que recebe o desconto |
discounts[].itemAmount | number | Quantidade mínima de itens para que o desconto em value seja aplicado |
discounts[].value | number | Valor do desconto aplicado quando itemAmount é atingido |
Campos de Condição Disponíveis
| Campo | Tipo | Descrição |
|---|---|---|
| id | integer | ID do produto |
| parentProductId | integer | ID do produto pai |
| brandId | integer | ID da marca |
| active | boolean | Produto ativo (true/false) |
| type | string | Tipo do produto |
| sku | string | SKU do produto |
| url | string | URL do produto |
| showInSite | boolean | Exibir no site |
| saleWithoutStock | boolean | Permitir venda sem estoque |
| minimumStock | integer | Estoque mínimo |
| category | integer | ID da categoria |
| mainCategory | integer | ID da categoria principal |
| salePrice | decimal | Preço de venda |
| comparisonPrice | decimal | Preço de comparação |
| priceDifference | decimal | Diferença entre preços |
| filter | object | Filtro por atributos |
| stock | integer | Quantidade em estoque |
| stockInStorage | integer | Estoque em armazém específico |
| productStorageId | integer | ID do armazém |
| name | string | Nome do produto |
| shortDescription | string | Descrição curta |
| description | string | Descrição completa |
| searchDescription | string | Descrição de busca |
| seal | integer | ID do selo |
| tradePolicyId | integer | ID da política comercial |
| productAttributeId | integer | ID do atributo |
| productAttributeValueId | integer | ID do valor do atributo |
| customerWishListId | integer | ID da lista de desejos |
| exclusive | boolean | Produto exclusivo |
| ean | string | Código EAN/GTIN |
| averageRating | decimal | Avaliação média (2 casas decimais, ex.: 4.67). Prefira >=/<= ao = |
| quantityRating | integer | Quantidade de avaliações |
| childrenAmount | integer | Quantidade de variações filhas |
| giftCard | boolean | Filtrar por gift card |
| variationsQuantity | integer | Filtrar produtos por quantidade de variações (independente de status de ativação) |
| availableVariationsQuantity | integer | Filtrar produtos por quantidade de variações disponíveis (ativas) |
| priceRuleCode | string | Filtrar produtos por código de regra de preço associada ao produto. |
Campos de Ordenação Disponíveis
| Campo | Descrição |
|---|---|
| id | ID do produto |
| priority | Prioridade de exibição |
| type | Tipo do produto |
| sku | SKU do produto |
| relevance | Relevância em busca |
| stock | Quantidade em estoque |
| stockByStorage | Estoque em armazém |
| name | Nome do produto |
| price | Preço do produto |
| hasStock | Disponibilidade (produtos com estoque primeiro) |
Exemplo de Requisição
1curl --request GET \2 --url {{MAIN_URL}}/publics/products \✅ Resposta de Sucesso
1{2 "registers": [3 {4 "id": 1234,5 "type": "product",6 "sku": "SMPH001",7 "name": "Smartphone XYZ Pro 128GB",8 "priority": 100,9 "basePrice": 1199.90,10 "active": true,11 "review": {12 "productId": 1234,13 "averageRating": 4.67,14 "quantityRating": 32815 },16 "isGiftCard": false,17 "stock": {18 "productId": 1234,19 "productStorageId": 1,20 "availableStock": 15,21 "reservedStock": 2,22 "updatedAt": "2024-10-01 14:30:00"23 },24 "stocks": [25 {26 "productId": 1234,27 "productStorageId": 1,28 "availableStock": 15,29 "reservedStock": 2,30 "updatedAt": "2024-10-01 14:30:00"31 },32 {33 "productId": 1234,34 "productStorageId": 2,35 "availableStock": 8,36 "reservedStock": 1,37 "updatedAt": "2024-10-01 14:30:00"38 }39 ],40 "originalPrice": {41 "comparisonPrice": 0,42 "salePrice": 0,43 "markup": 0,44 "ruleId": 0,45 "ruleTrigger": "original",46 "ruleName": "Original",47 "availableForSale": true,48 "basePrice": false,49 "priceWithDiscount": 0,50 "installments": [],51 "scheduling": null52 },53 "price": {54 "comparisonPrice": 1499.90,55 "salePrice": 1199.90,56 "markup": 25.02,57 "ruleId": 15,58 "ruleTrigger": "original",59 "ruleName": "Original",60 "availableForSale": true,61 "basePrice": false,62 "priceWithDiscount": 1199.90,63 "installments": [64 {65 "installment": 1,66 "installmentValue": 1199.90,67 "totalValue": 1199.90,68 "fee": null,69 "feeTotalValue": 070 },71 {72 "installment": 2,73 "installmentValue": 599.95,74 "totalValue": 1199.90,75 "fee": null,76 "feeTotalValue": 077 },78 {79 "installment": 12,80 "installmentValue": 99.99,81 "totalValue": 1199.88,82 "fee": null,83 "feeTotalValue": 084 }85 ],86 "scheduling": {87 "id": 46,88 "startDate": "2026-02-07 09:00:00",89 "endDate": "2026-10-30 23:59:59"90 }91 },92 "priceRules": null,93 "brand": {94 "id": 45,95 "code": "TECH",96 "name": "TechBrand",97 "logo": "https://cdn.loja.com.br/brands/techbrand-logo.jpg",98 "originalLogo": "https://cdn.loja.com.br/brands/techbrand-logo-original.jpg",99 "productOrdering": "name_asc",100 "active": true,101 "bannerGroups": [],102 "createdAt": "2023-10-04 19:11:08",103 "updatedAt": "2025-08-20 12:41:03",104 "url": "/marca/techbrand"105 },106 "flags": {107 "subscription": false,108 "service": false,109 "showInSite": true,110 "saleWithoutStock": false,111 "minimumStock": 5112 },113 "tax": {114 "mpn": "MPN123456",115 "ean": "7891234567890",116 "ncm": "85171231",117 "exclusive": false118 },119 "indicatedProducts": [120 {121 "id": 1234,122 "brandId": 1234,123 "brandName": "TopPhone",124 "mainCategoryId": 1,125 "mainCategoryName": "smartphone",126 "type": "product",127 "name": "Smartphone XYZ Pro 128GB",128 "sku": "SMPH001",129 "url": "/smartphone-xyz-pro-128gb",130 "comparisonPrice":2199.99,131 "stock":20,132 "medias":[133 {134 "id": 123,135 "type": "image",136 "title": "",137 "alternativeText": null,138 "file": "https://cdn.loja.com.br/upload/media/produto-media.webp",139 "originalFile": "https://cdn.loja.com.br/upload/media/produto-media.png",140 "size": null,141 "originalSize": null,142 "width": null,143 "height": null,144 "url": null145 }146 ],147 "combination":[1, 2, 3],148 "currentAttributes":[149 {150 "id":123,151 "name":"cor",152 "value":{153 "id":123,154 "label":"azul-escuro",155 "image":null,156 "originalImage":null,157 "color":"#00008B",158 "order":1159 }160 }161 ],162 "active": true163 }164 ],165 "relatedProducts": [166 {167 "id": 1234,168 "brandId": 1234,169 "brandName": "TopPhone",170 "mainCategoryId": 1,171 "mainCategoryName": "smartphone",172 "type": "product",173 "name": "Smartphone XYZ Pro 128GB",174 "sku": "SMPH001",175 "url": "/smartphone-xyz-pro-128gb",176 "comparisonPrice":2199.99,177 "stock":20,178 "medias":[179 {180 "id": 123,181 "type": "image",182 "title": "",183 "alternativeText": null,184 "file": "https://cdn.loja.com.br/upload/media/produto-media.webp",185 "originalFile": "https://cdn.loja.com.br/upload/media/produto-media.png",186 "size": null,187 "originalSize": null,188 "width": null,189 "height": null,190 "url": null191 }192 ],193 "combination":[1, 2, 3],194 "currentAttributes":[195 {196 "id":123,197 "name":"cor",198 "value":{199 "id":123,200 "label":"azul-escuro",201 "image":null,202 "originalImage":null,203 "color":"#00008B",204 "order":1205 }206 }207 ],208 "active": true209 }210 ],211 "filters": [212 {213 "id": 123,214 "productCategoryId": 1234,215 "name": "Marca",216 "active": true,217 "showInListing": true,218 "showInSpecificationTable": false,219 "type": "enum",220 "createdAt": "2025-01-14 10:31:00",221 "values": [222 {223 "id": 123,224 "name": "TechPhone",225 "image": null,226 "originalImage": null,227 "color": null,228 "order": 1,229 "value": null230 },231 {232 "id": 124,233 "name": "SmartScreen",234 "image": null,235 "originalImage": null,236 "color": null,237 "order": 1,238 "value": null239 }240 ]241 }242 ],243 "seals": [244 {245 "id": 5,246 "name": "Frete Grátis",247 "active": true,248 "textColor": "#FFFFFF",249 "sealColor": "#00A650",250 "image": "https://cdn.loja.com.br/seals/frete-gratis.png",251 "originalImage": "https://cdn.loja.com.br/seals/frete-gratis-original.png",252 "setting":{253 "id": 1234,254 "horizontalPosition": "left",255 "verticalPosition": "top",256 "proportionInProductDetail": 300,257 "proportionInProductShowcase": 300,258 "scheduling": {259 "id": 1234,260 "startDate": "2024-01-15 10:30:00",261 "endDate": "2024-01-30 10:30:00"262 }263 },264 "promotionLinkId":15,265 "createdAt":"2024-01-15 10:30:00",266 "updatedAt":"2024-01-15 10:30:00"267 }268 ],269 "mainCategory": {270 "id": 123,271 "name": "Smartphones",272 "url": "/smartphones"273 },274 "categories": [275 {276 "id": 100,277 "name": "Eletrônicos",278 "url": "/eletronicos"279 },280 {281 "id": 110,282 "name": "Telefonia",283 "url": "/eletronicos/telefonia"284 },285 {286 "id": 123,287 "name": "Smartphones",288 "url": "/eletronicos/telefonia/smartphones"289 }290 ],291 "categoryBreadcrumb": [292 {293 "id": 100,294 "name": "Eletrônicos",295 "url": "/eletronicos"296 },297 {298 "id": 110,299 "name": "Telefonia",300 "url": "/eletronicos/telefonia"301 },302 {303 "id": 123,304 "name": "Smartphones",305 "url": "/eletronicos/telefonia/smartphones"306 }307 ],308 "dimensions": {309 "shippingCargoTypeId": 1,310 "additionalTime": 0,311 "width": 7.5,312 "height": 15.2,313 "length": 0.8,314 "weight": 185315 },316 "parentProductId": null,317 "combination": [1234],318 "currentAttributes": [319 {320 "id": 1,321 "name": "Cor",322 "value": {323 "id": 123,324 "label": "Azul",325 "image": null,326 "originalImage": null,327 "color": "007BFF",328 "order": 1329 }330 }331 ],332 "variations": {333 "valueList": [334 1234335 ],336 "combinations": [337 {338 "productId": 1234,339 "brandId": 1,340 "brandName": "TechPhone",341 "mainCategoryId": 123,342 "mainCategoryName": "Tecnologia",343 "type": "variation",344 "sku": "ABC123",345 "name": "Variation Phone",346 "active": true,347 "url": "nice-phone-url",348 "comparisonPrice": 1800,349 "stock": 21,350 "medias": [351 {352 "id": 123,353 "type": "image",354 "title": "Variation Phone Image",355 "alternativeText": null,356 "file": "https://cdn.loja.com.br/upload/media.webp",357 "originalFile": "https://cdn.loja.com.br/upload/media.png",358 "size": null,359 "originalSize": null,360 "width": null,361 "height": null,362 "url": null363 }364 ],365 "combination": [366 1, 2367 ],368 "currentAttributes": [369 {370 "id": 1,371 "name": "Cor",372 "value": {373 "id": 1,374 "label": "Azul",375 "image": null,376 "originalImage": null,377 "color": "007BFF",378 "order": 1379 }380 }381 ]382 }383 ],384 "attributes": [385 {386 "id": 1,387 "name": "Cor",388 "displayName": "Cor",389 "includeSample": false,390 "values": [391 {392 "id": 1,393 "label": "Azul",394 "image": null,395 "originalImage": null,396 "color": "007BFF",397 "order": 1398 }399 ],400 "createdAt": "2025-07-23 22:50:28",401 "updatedAt": "2025-08-06 16:03:59"402 }403 ]404 },405 "medias": [406 {407 "id": 1234,408 "type": "image",409 "title": "Imagem Principal",410 "alternativeText": "Smartphone XYZ Pro vista frontal",411 "file": "https://cdn.loja.com.br/products/smartphone-xyz-pro-01.jpg",412 "originalFile": "https://cdn.loja.com.br/products/smartphone-xyz-pro-01-original.jpg",413 "size": 245680,414 "originalSize": 1567890,415 "width": 800,416 "height": 800,417 "url": "https://cdn.loja.com.br/products/smartphone-xyz-pro-01.jpg"418 }419 ],420 "bannerGroups": [421 "banner 1",422 "banner 2",423 "banner 3"424 ],425 "status": "available",426 "createdAt": "2024-01-15 10:30:00",427 "updatedAt": "2024-10-01 15:45:00",428 "url": "/smartphone-xyz-pro-128gb",429 "urls": [430 {431 "tradePolicyId": 1,432 "url": "/smartphone-xyz-pro-128gb",433 "redirect": false,434 "redirectCode": null,435 "target": null,436 "createdAt": "2024-01-15 10:30:00",437 "updatedAt": "2024-01-15 10:30:00"438 }439 ],440 "linkedTradePolicies": [1, 2, 3],441 "description": {442 "id": 1234,443 "productId": 1234,444 "tradePolicyId": 1,445 "name": "Smartphone XYZ Pro 128GB",446 "shortDescription": "O mais avançado smartphone com 128GB de armazenamento",447 "description": "<p>Smartphone com processador octa-core, câmera tripla de 64MP e bateria de longa duração...</p>",448 "searchDescription": "smartphone xyz pro 128gb android camera 64mp bateria",449 "videoUrl": "https://youtube.com/watch?v=example",450 "customDescription1": null,451 "customDescription2": null,452 "customDescription3": null,453 "measureTable": null,454 "seoTitle": "Smartphone XYZ Pro 128GB - Compre Agora",455 "seoDescription": "Compre o Smartphone XYZ Pro com 128GB de armazenamento. Câmera 64MP, processador rápido e entrega rápida.",456 "seoKeywords": "smartphone, xyz pro, 128gb, android",457 "seoCanonical": "https://loja.com.br/smartphone-xyz-pro-128gb",458 "seoSocialTitle": "Smartphone XYZ Pro 128GB",459 "seoSocialDescription": "O melhor smartphone do mercado",460 "seoTwitterImageUrl": "https://cdn.loja.com.br/products/smartphone-xyz-pro-twitter.jpg",461 "seoGraphImageUrl": "https://cdn.loja.com.br/products/smartphone-xyz-pro-og.jpg",462 "seoGoogleCategoryId": 2895,463 "seoIndexOnGoogle": true,464 "seoGoogleCondition": "new",465 "seoGoogleAgeGroup": "adult",466 "seoGoogleGender": "unisex",467 "seoStructuredData": null468 }469 }470 ],471 "pagination": {472 "limit": 10,473 "offset": 0,474 "pages": 16,475 "registers": 156476 }477}⚠️ Possíveis Erros
Esta rota não possui erros específicos de regra de negócio. Quando não há resultados para a consulta, a listagem retorna array vazio.
Erros de Validação (422)
Caso os parâmetros enviados em meta sejam inválidos — como:
- Valores fora do enum permitido
- Tipo de dado incorreto
- Tamanho inválido
A API retornará HTTP 422 (Unprocessable Entity), contendo os detalhes no campo errors.
Consulte a seção Parâmetros de Metadados (meta) para verificar os valores aceitos e os tipos esperados.