Documentação de Produto

Visão Geral

O produto é a entidade central da loja, representando os itens disponíveis para venda ou exibição 🛍️.

Ele concentra todas as informações necessárias para comercialização, como preço, descrição, estoque, atributos, imagens, categorias e configurações específicas.

Os produtos podem ser configurados de forma flexível, permitindo:

Criação de variações
Definição de regras de venda
Associação com políticas comerciais
Personalização de conteúdo e SEO

Além disso, diversas entidades relacionadas são geradas automaticamente no momento do cadastro, garantindo que o produto esteja pronto para uso.

Entidades Envolvidas

Produto (Product)

Atributos e Valores (Attributes & Values)

Categoria (Category)

Marca (Brand)

Descrição (Description)

URL (Url)

Mídias (Media)

Dados Fiscais, Estoque e Dimensões

Entre várias outras entidades do sistema, sendo um dos pontos centrais da plataforma.

Notas e Considerações

Produtos podem possuir variações baseadas em atributos.
Podem ser configurados para diferentes políticas comerciais.
Diversas entidades são criadas automaticamente no cadastro inicial.
A correta configuração impacta diretamente na experiência do usuário e operação da loja ⚙️.

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 privada, exclusiva para usuários autenticados com permissão adequada.

Por não ser um endpoint público, a consulta não está sujeita às regras de filtragem do contexto público, permitindo acesso completo aos produtos cadastrados.

Parâmetros de Query

Headers Obrigatórios

Header	Valor	Descrição
`Authorization`	Bearer {token}	Token de autenticação

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

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}}/products \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
curl --request GET \
  --url {{MAIN_URL}}/products \
  --header "Authorization: Bearer SEU_TOKEN_AQUI" \

✅ 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": 328
15      },
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": 1499.90,
42        "salePrice":1199.90,
43        "markup": 0,
44        "ruleId": 0,
45        "ruleTrigger": "original",
46        "ruleName": "Original",
47        "availableForSale": true,
48        "basePrice": false,
49        "priceWithDiscount": 0,
50        "installments": [
51          {
52            "installment": 1,
53            "installmentValue": 1199.90,
54            "totalValue": 1199.90,
55            "fee": null,
56            "feeTotalValue": 0
57          }
58        ],
59        "scheduling": null
60      },
61      "price": {
62        "comparisonPrice": 1499.90,
63        "salePrice": 1199.90,
64        "markup": 25.02,
65        "ruleId": 15,
66        "ruleTrigger": "original",
67        "ruleName": "Original",
68        "availableForSale": true,
69        "basePrice": false,
70        "priceWithDiscount": 1199.90,
71        "installments": [
72          {
73            "installment": 1,
74            "installmentValue": 1199.90,
75            "totalValue": 1199.90,
76            "fee": null,
77            "feeTotalValue": 0
78          },
79          {
80            "installment": 2,
81            "installmentValue": 599.95,
82            "totalValue": 1199.90,
83            "fee": null,
84            "feeTotalValue": 0
85          },
86          {
87            "installment": 12,
88            "installmentValue": 99.99,
89            "totalValue": 1199.88,
90            "fee": null,
91            "feeTotalValue": 0
92          }
93        ],
94        "scheduling": {
95          "id": 46,
96          "startDate": "2026-02-07 09:00:00",
97          "endDate": "2026-10-30 23:59:59"
98        }
99      },
100      "priceRules": [
101        {
102          "id": 123,
103          "name": "product-price-rule",
104          "trigger": "automatic",
105          "ruleTarget": "product",
106          "origin": "product",
107          "applyInGroup": false,
108          "updateComparisonPrice": "not-update",
109          "basePriceField": "sale-price",
110          "code": "product-123",
111          "beginQuantity": 1,
112          "endQuantity": 1,
113          "value": -20,
114          "valueType": "percentage",
115          "priority": 1,
116          "active": true,
117          "scheduling": {
118            "id":1234,
119            "starDate":"2023-10-03 19:24:01",
120            "endDate":null
121          },
122          "tradePolicies": [1, 2, 3],
123          "productIds": [3, 2, 1, 5, 7],
124          "productCategoryIds": [8, 9, 45, 12],
125          "productBrandIds": [10, 7, 20, 36],
126          "lastUpdateUserName": "Marcos Brandão",
127          "createdAt": "2023-10-04 19:11:08",
128          "updatedAt": "2025-08-20 12:41:03"
129        }
130      ],
131      "brand": {
132        "id": 45,
133        "code": "TECH",
134        "name": "TechBrand",
135        "logo": "https://cdn.loja.com.br/brands/techbrand-logo.jpg",
136        "originalLogo": "https://cdn.loja.com.br/brands/techbrand-logo-original.jpg",
137        "productOrdering": "name_asc",
138        "active": true,
139        "bannerGroups": [],
140        "createdAt": "2023-10-04 19:11:08",
141        "updatedAt": "2025-08-20 12:41:03",
142        "url": "/marca/techbrand"
143      },
144      "flags": {
145        "subscription": false,
146        "service": false,
147        "showInSite": true,
148        "saleWithoutStock": false,
149        "minimumStock": 5
150      },
151      "tax": {
152        "mpn": "MPN123456",
153        "ean": "7891234567890",
154        "ncm": "85171231",
155        "exclusive": false
156      },
157      "indicatedProducts": [
158        {
159          "id": 1234,
160          "brandId": 1234,
161          "brandName": "TopPhone",
162          "mainCategoryId": 1,
163          "mainCategoryName": "smartphone",
164          "type": "product",
165          "name": "Smartphone XYZ Pro 128GB",
166          "sku": "SMPH001",
167          "url": "/smartphone-xyz-pro-128gb",
168          "comparisonPrice":2199.99,
169          "stock":20,
170          "medias":[
171            {
172              "id": 123,
173              "type": "image",
174              "title": "",
175              "alternativeText": null,
176              "file": "https://cdn.loja.com.br/upload/media/produto-media.webp",
177              "originalFile": "https://cdn.loja.com.br/upload/media/produto-media.png",
178              "size": null,
179              "originalSize": null,
180              "width": null,
181              "height": null,
182              "url": null
183            }
184          ],
185          "combination":[1, 2, 3],
186          "currentAttributes":[
187            {
188              "id":123,
189              "name":"cor",
190              "value":{
191                "id":123,
192                "label":"azul-escuro",
193                "image":null,
194                "originalImage":null,
195                "color":"#00008B",
196                "order":1
197              }
198            }
199          ],
200          "active": true
201        }
202      ],
203      "relatedProducts": [
204        {
205          "id": 1234,
206          "brandId": 1234,
207          "brandName": "TopPhone",
208          "mainCategoryId": 1,
209          "mainCategoryName": "smartphone",
210          "type": "product",
211          "name": "Smartphone XYZ Pro 128GB",
212          "sku": "SMPH001",
213          "url": "/smartphone-xyz-pro-128gb",
214          "comparisonPrice":2199.99,
215          "stock":20,
216          "medias":[
217            {
218              "id": 123,
219              "type": "image",
220              "title": "",
221              "alternativeText": null,
222              "file": "https://cdn.loja.com.br/upload/media/produto-media.webp",
223              "originalFile": "https://cdn.loja.com.br/upload/media/produto-media.png",
224              "size": null,
225              "originalSize": null,
226              "width": null,
227              "height": null,
228              "url": null
229            }
230          ],
231          "combination":[1, 2, 3],
232          "currentAttributes":[
233            {
234              "id":123,
235              "name":"cor",
236              "value":{
237                "id":123,
238                "label":"azul-escuro",
239                "image":null,
240                "originalImage":null,
241                "color":"#00008B",
242                "order":1
243              }
244            }
245          ],
246          "active": true
247        }
248      ],
249      "filters": [
250        {
251          "id": 123,
252          "productCategoryId": 1234,
253          "name": "Marca",
254          "active": true,
255          "showInListing": true,
256          "showInSpecificationTable": false,
257          "type": "enum",
258          "createdAt": "2025-01-14 10:31:00",
259          "values": [
260            {
261              "id": 123,
262              "name": "TechPhone",
263              "image": null,
264              "originalImage": null,
265              "color": null,
266              "order": 1,
267              "value": null
268            },
269            {
270              "id": 124,
271              "name": "SmartScreen",
272              "image": null,
273              "originalImage": null,
274              "color": null,
275              "order": 1,
276              "value": null
277            }
278          ]
279        }
280      ],
281      "seals": [
282        {
283          "id": 5,
284          "name": "Frete Grátis",
285          "active": true,
286          "textColor": "#FFFFFF",
287          "sealColor": "#00A650",
288          "image": "https://cdn.loja.com.br/seals/frete-gratis.png",
289          "originalImage": "https://cdn.loja.com.br/seals/frete-gratis-original.png",
290          "setting":{
291            "id": 1234,
292            "horizontalPosition": "left",
293            "verticalPosition": "top",
294            "proportionInProductDetail": 300,
295            "proportionInProductShowcase": 300,
296            "scheduling": {
297              "id": 1234,
298              "startDate": "2024-01-15 10:30:00",
299              "endDate": "2024-01-30 10:30:00"
300            }
301          },
302          "promotionLinkId":15,
303          "createdAt":"2024-01-15 10:30:00",
304          "updatedAt":"2024-01-15 10:30:00"
305        }
306      ],
307      "mainCategory": {
308        "id": 123,
309        "name": "Smartphones",
310        "url": "/smartphones"
311      },
312      "categories": [
313        {
314          "id": 100,
315          "name": "Eletrônicos",
316          "url": "/eletronicos"
317        },
318        {
319          "id": 110,
320          "name": "Telefonia",
321          "url": "/eletronicos/telefonia"
322        },
323        {
324          "id": 123,
325          "name": "Smartphones",
326          "url": "/eletronicos/telefonia/smartphones"
327        }
328      ],
329      "categoryBreadcrumb": [
330        {
331          "id": 100,
332          "name": "Eletrônicos",
333          "url": "/eletronicos"
334        },
335        {
336          "id": 110,
337          "name": "Telefonia",
338          "url": "/eletronicos/telefonia"
339        },
340        {
341          "id": 123,
342          "name": "Smartphones",
343          "url": "/eletronicos/telefonia/smartphones"
344        }
345      ],
346      "dimensions": {
347        "shippingCargoTypeId": 1,
348        "additionalTime": 0,
349        "width": 7.5,
350        "height": 15.2,
351        "length": 0.8,
352        "weight": 185
353      },
354      "parentProductId": null,
355      "combination": [1234],
356      "currentAttributes": [
357        {
358          "id": 1,
359          "name": "Cor",
360          "value": {
361            "id": 123,
362            "label": "Azul",
363            "image": null,
364            "originalImage": null,
365            "color": "007BFF",
366            "order": 1
367          }
368        }
369      ],
370      "variations": {
371        "valueList": [
372          1234
373        ],
374        "combinations": [
375          {
376            "productId": 1234,
377            "brandId": 1,
378            "brandName": "TechPhone",
379            "mainCategoryId": 123,
380            "mainCategoryName": "Tecnologia",
381            "type": "variation",
382            "sku": "ABC123",
383            "name": "Variation Phone",
384            "active": true,
385            "url": "nice-phone-url",
386            "comparisonPrice": 1800,
387            "stock": 21,
388            "medias": [
389              {
390                "id": 123,
391                "type": "image",
392                "title": "Variation Phone Image",
393                "alternativeText": null,
394                "file": "https://cdn.loja.com.br/upload/media.webp",
395                "originalFile": "https://cdn.loja.com.br/upload/media.png",
396                "size": null,
397                "originalSize": null,
398                "width": null,
399                "height": null,
400                "url": null
401              }
402            ],
403            "combination": [
404              1, 2
405            ],
406            "currentAttributes": [
407              {
408                "id": 1,
409                "name": "Cor",
410                "value": {
411                  "id": 1,
412                  "label": "Azul",
413                  "image": null,
414                  "originalImage": null,
415                  "color": "007BFF",
416                  "order": 1
417                }
418              }
419            ]
420          }
421        ],
422        "attributes": [
423          {
424            "id": 1,
425            "name": "Cor",
426            "displayName": "Cor",
427            "includeSample": false,
428            "values": [
429              {
430                "id": 1,
431                "label": "Azul",
432                "image": null,
433                "originalImage": null,
434                "color": "007BFF",
435                "order": 1
436              }
437            ],
438            "createdAt": "2025-07-23 22:50:28",
439            "updatedAt": "2025-08-06 16:03:59"
440          }
441        ]
442      },
443      "medias": [
444        {
445          "id": 1234,
446          "type": "image",
447          "title": "Imagem Principal",
448          "alternativeText": "Smartphone XYZ Pro vista frontal",
449          "file": "https://cdn.loja.com.br/products/smartphone-xyz-pro-01.jpg",
450          "originalFile": "https://cdn.loja.com.br/products/smartphone-xyz-pro-01-original.jpg",
451          "size": 245680,
452          "originalSize": 1567890,
453          "width": 800,
454          "height": 800,
455          "url": "https://cdn.loja.com.br/products/smartphone-xyz-pro-01.jpg"
456        }
457      ],
458      "bannerGroups": [
459        "banner 1",
460        "banner 2",
461        "banner 3"
462      ],
463      "status": "available",
464      "createdAt": "2024-01-15 10:30:00",
465      "updatedAt": "2024-10-01 15:45:00",
466      "url": "/smartphone-xyz-pro-128gb",
467      "urls": [
468        {
469          "tradePolicyId": 1,
470          "url": "/smartphone-xyz-pro-128gb",
471          "redirect": false,
472          "redirectCode": null,
473          "target": null,
474          "createdAt": "2024-01-15T10:30:00Z",
475          "updatedAt": "2024-01-15T10:30:00Z"
476        }
477      ],
478      "linkedTradePolicies": [1, 2, 3],
479      "description": {
480        "id": 1234,
481        "productId": 1234,
482        "tradePolicyId": 1,
483        "name": "Smartphone XYZ Pro 128GB",
484        "shortDescription": "O mais avançado smartphone com 128GB de armazenamento",
485        "description": "<p>Smartphone com processador octa-core, câmera tripla de 64MP e bateria de longa duração...</p>",
486        "searchDescription": "smartphone xyz pro 128gb android camera 64mp bateria",
487        "videoUrl": "https://youtube.com/watch?v=example",
488        "customDescription1": null,
489        "customDescription2": null,
490        "customDescription3": null,
491        "measureTable": null,
492        "seoTitle": "Smartphone XYZ Pro 128GB - Compre Agora",
493        "seoDescription": "Compre o Smartphone XYZ Pro com 128GB de armazenamento. Câmera 64MP, processador rápido e entrega rápida.",
494        "seoKeywords": "smartphone, xyz pro, 128gb, android",
495        "seoCanonical": "https://loja.com.br/smartphone-xyz-pro-128gb",
496        "seoSocialTitle": "Smartphone XYZ Pro 128GB",
497        "seoSocialDescription": "O melhor smartphone do mercado",
498        "seoTwitterImageUrl": "https://cdn.loja.com.br/products/smartphone-xyz-pro-twitter.jpg",
499        "seoGraphImageUrl": "https://cdn.loja.com.br/products/smartphone-xyz-pro-og.jpg",
500        "seoGoogleCategoryId": 2895,
501        "seoIndexOnGoogle": true,
502        "seoGoogleCondition": "new",
503        "seoGoogleAgeGroup": "adult",
504        "seoGoogleGender": "unisex",
505        "seoStructuredData": null
506      }
507    }
508  ],
509  "pagination": {
510    "limit": 10,
511    "offset": 0,
512    "pages": 16,
513    "registers": 156
514  }
515}
{
  "registers": [
    {
      "id": 1234,
      "type": "product",
      "sku": "SMPH001",
      "name": "Smartphone XYZ Pro 128GB",
      "priority": 100,
      "basePrice": 1199.90,
      "active": true,
      "review": {
        "productId": 1234,
        "averageRating": 4.67,
        "quantityRating": 328
      },
      "isGiftCard": false,
      "stock": {
        "productId": 1234,
        "productStorageId": 1,
        "availableStock": 15,
        "reservedStock": 2,
        "updatedAt": "2024-10-01 14:30:00"
      },
      "stocks": [
        {
          "productId": 1234,
          "productStorageId": 1,
          "availableStock": 15,
          "reservedStock": 2,
          "updatedAt": "2024-10-01 14:30:00"
        },
        {
          "productId": 1234,
          "productStorageId": 2,
          "availableStock": 8,
          "reservedStock": 1,
          "updatedAt": "2024-10-01 14:30:00"
        }
      ],
      "originalPrice": {
        "comparisonPrice": 1499.90,
        "salePrice":1199.90,
        "markup": 0,
        "ruleId": 0,
        "ruleTrigger": "original",
        "ruleName": "Original",
        "availableForSale": true,
        "basePrice": false,
        "priceWithDiscount": 0,
        "installments": [
          {
            "installment": 1,
            "installmentValue": 1199.90,
            "totalValue": 1199.90,
            "fee": null,
            "feeTotalValue": 0
          }
        ],
        "scheduling": null
      },
      "price": {
        "comparisonPrice": 1499.90,
        "salePrice": 1199.90,
        "markup": 25.02,
        "ruleId": 15,
        "ruleTrigger": "original",
        "ruleName": "Original",
        "availableForSale": true,
        "basePrice": false,
        "priceWithDiscount": 1199.90,
        "installments": [
          {
            "installment": 1,
            "installmentValue": 1199.90,
            "totalValue": 1199.90,
            "fee": null,
            "feeTotalValue": 0
          },
          {
            "installment": 2,
            "installmentValue": 599.95,
            "totalValue": 1199.90,
            "fee": null,
            "feeTotalValue": 0
          },
          {
            "installment": 12,
            "installmentValue": 99.99,
            "totalValue": 1199.88,
            "fee": null,
            "feeTotalValue": 0
          }
        ],
        "scheduling": {
          "id": 46,
          "startDate": "2026-02-07 09:00:00",
          "endDate": "2026-10-30 23:59:59"
        }
      },
      "priceRules": [
        {
          "id": 123,
          "name": "product-price-rule",
          "trigger": "automatic",
          "ruleTarget": "product",
          "origin": "product",
          "applyInGroup": false,
          "updateComparisonPrice": "not-update",
          "basePriceField": "sale-price",
          "code": "product-123",
          "beginQuantity": 1,
          "endQuantity": 1,
          "value": -20,
          "valueType": "percentage",
          "priority": 1,
          "active": true,
          "scheduling": {
            "id":1234,
            "starDate":"2023-10-03 19:24:01",
            "endDate":null
          },
          "tradePolicies": [1, 2, 3],
          "productIds": [3, 2, 1, 5, 7],
          "productCategoryIds": [8, 9, 45, 12],
          "productBrandIds": [10, 7, 20, 36],
          "lastUpdateUserName": "Marcos Brandão",
          "createdAt": "2023-10-04 19:11:08",
          "updatedAt": "2025-08-20 12:41:03"
        }
      ],
      "brand": {
        "id": 45,
        "code": "TECH",
        "name": "TechBrand",
        "logo": "https://cdn.loja.com.br/brands/techbrand-logo.jpg",
        "originalLogo": "https://cdn.loja.com.br/brands/techbrand-logo-original.jpg",
        "productOrdering": "name_asc",
        "active": true,
        "bannerGroups": [],
        "createdAt": "2023-10-04 19:11:08",
        "updatedAt": "2025-08-20 12:41:03",
        "url": "/marca/techbrand"
      },
      "flags": {
        "subscription": false,
        "service": false,
        "showInSite": true,
        "saleWithoutStock": false,
        "minimumStock": 5
      },
      "tax": {
        "mpn": "MPN123456",
        "ean": "7891234567890",
        "ncm": "85171231",
        "exclusive": false
      },
      "indicatedProducts": [
        {
          "id": 1234,
          "brandId": 1234,
          "brandName": "TopPhone",
          "mainCategoryId": 1,
          "mainCategoryName": "smartphone",
          "type": "product",
          "name": "Smartphone XYZ Pro 128GB",
          "sku": "SMPH001",
          "url": "/smartphone-xyz-pro-128gb",
          "comparisonPrice":2199.99,
          "stock":20,
          "medias":[
            {
              "id": 123,
              "type": "image",
              "title": "",
              "alternativeText": null,
              "file": "https://cdn.loja.com.br/upload/media/produto-media.webp",
              "originalFile": "https://cdn.loja.com.br/upload/media/produto-media.png",
              "size": null,
              "originalSize": null,
              "width": null,
              "height": null,
              "url": null
            }
          ],
          "combination":[1, 2, 3],
          "currentAttributes":[
            {
              "id":123,
              "name":"cor",
              "value":{
                "id":123,
                "label":"azul-escuro",
                "image":null,
                "originalImage":null,
                "color":"#00008B",
                "order":1
              }
            }
          ],
          "active": true
        }
      ],
      "relatedProducts": [
        {
          "id": 1234,
          "brandId": 1234,
          "brandName": "TopPhone",
          "mainCategoryId": 1,
          "mainCategoryName": "smartphone",
          "type": "product",
          "name": "Smartphone XYZ Pro 128GB",
          "sku": "SMPH001",
          "url": "/smartphone-xyz-pro-128gb",
          "comparisonPrice":2199.99,
          "stock":20,
          "medias":[
            {
              "id": 123,
              "type": "image",
              "title": "",
              "alternativeText": null,
              "file": "https://cdn.loja.com.br/upload/media/produto-media.webp",
              "originalFile": "https://cdn.loja.com.br/upload/media/produto-media.png",
              "size": null,
              "originalSize": null,
              "width": null,
              "height": null,
              "url": null
            }
          ],
          "combination":[1, 2, 3],
          "currentAttributes":[
            {
              "id":123,
              "name":"cor",
              "value":{
                "id":123,
                "label":"azul-escuro",
                "image":null,
                "originalImage":null,
                "color":"#00008B",
                "order":1
              }
            }
          ],
          "active": true
        }
      ],
      "filters": [
        {
          "id": 123,
          "productCategoryId": 1234,
          "name": "Marca",
          "active": true,
          "showInListing": true,
          "showInSpecificationTable": false,
          "type": "enum",
          "createdAt": "2025-01-14 10:31:00",
          "values": [
            {
              "id": 123,
              "name": "TechPhone",
              "image": null,
              "originalImage": null,
              "color": null,
              "order": 1,
              "value": null
            },
            {
              "id": 124,
              "name": "SmartScreen",
              "image": null,
              "originalImage": null,
              "color": null,
              "order": 1,
              "value": null
            }
          ]
        }
      ],
      "seals": [
        {
          "id": 5,
          "name": "Frete Grátis",
          "active": true,
          "textColor": "#FFFFFF",
          "sealColor": "#00A650",
          "image": "https://cdn.loja.com.br/seals/frete-gratis.png",
          "originalImage": "https://cdn.loja.com.br/seals/frete-gratis-original.png",
          "setting":{
            "id": 1234,
            "horizontalPosition": "left",
            "verticalPosition": "top",
            "proportionInProductDetail": 300,
            "proportionInProductShowcase": 300,
            "scheduling": {
              "id": 1234,
              "startDate": "2024-01-15 10:30:00",
              "endDate": "2024-01-30 10:30:00"
            }
          },
          "promotionLinkId":15,
          "createdAt":"2024-01-15 10:30:00",
          "updatedAt":"2024-01-15 10:30:00"
        }
      ],
      "mainCategory": {
        "id": 123,
        "name": "Smartphones",
        "url": "/smartphones"
      },
      "categories": [
        {
          "id": 100,
          "name": "Eletrônicos",
          "url": "/eletronicos"
        },
        {
          "id": 110,
          "name": "Telefonia",
          "url": "/eletronicos/telefonia"
        },
        {
          "id": 123,
          "name": "Smartphones",
          "url": "/eletronicos/telefonia/smartphones"
        }
      ],
      "categoryBreadcrumb": [
        {
          "id": 100,
          "name": "Eletrônicos",
          "url": "/eletronicos"
        },
        {
          "id": 110,
          "name": "Telefonia",
          "url": "/eletronicos/telefonia"
        },
        {
          "id": 123,
          "name": "Smartphones",
          "url": "/eletronicos/telefonia/smartphones"
        }
      ],
      "dimensions": {
        "shippingCargoTypeId": 1,
        "additionalTime": 0,
        "width": 7.5,
        "height": 15.2,
        "length": 0.8,
        "weight": 185
      },
      "parentProductId": null,
      "combination": [1234],
      "currentAttributes": [
        {
          "id": 1,
          "name": "Cor",
          "value": {
            "id": 123,
            "label": "Azul",
            "image": null,
            "originalImage": null,
            "color": "007BFF",
            "order": 1
          }
        }
      ],
      "variations": {
        "valueList": [
          1234
        ],
        "combinations": [
          {
            "productId": 1234,
            "brandId": 1,
            "brandName": "TechPhone",
            "mainCategoryId": 123,
            "mainCategoryName": "Tecnologia",
            "type": "variation",
            "sku": "ABC123",
            "name": "Variation Phone",
            "active": true,
            "url": "nice-phone-url",
            "comparisonPrice": 1800,
            "stock": 21,
            "medias": [
              {
                "id": 123,
                "type": "image",
                "title": "Variation Phone Image",
                "alternativeText": null,
                "file": "https://cdn.loja.com.br/upload/media.webp",
                "originalFile": "https://cdn.loja.com.br/upload/media.png",
                "size": null,
                "originalSize": null,
                "width": null,
                "height": null,
                "url": null
              }
            ],
            "combination": [
              1, 2
            ],
            "currentAttributes": [
              {
                "id": 1,
                "name": "Cor",
                "value": {
                  "id": 1,
                  "label": "Azul",
                  "image": null,
                  "originalImage": null,
                  "color": "007BFF",
                  "order": 1
                }
              }
            ]
          }
        ],
        "attributes": [
          {
            "id": 1,
            "name": "Cor",
            "displayName": "Cor",
            "includeSample": false,
            "values": [
              {
                "id": 1,
                "label": "Azul",
                "image": null,
                "originalImage": null,
                "color": "007BFF",
                "order": 1
              }
            ],
            "createdAt": "2025-07-23 22:50:28",
            "updatedAt": "2025-08-06 16:03:59"
          }
        ]
      },
      "medias": [
        {
          "id": 1234,
          "type": "image",
          "title": "Imagem Principal",
          "alternativeText": "Smartphone XYZ Pro vista frontal",
          "file": "https://cdn.loja.com.br/products/smartphone-xyz-pro-01.jpg",
          "originalFile": "https://cdn.loja.com.br/products/smartphone-xyz-pro-01-original.jpg",
          "size": 245680,
          "originalSize": 1567890,
          "width": 800,
          "height": 800,
          "url": "https://cdn.loja.com.br/products/smartphone-xyz-pro-01.jpg"
        }
      ],
      "bannerGroups": [
        "banner 1",
        "banner 2",
        "banner 3"
      ],
      "status": "available",
      "createdAt": "2024-01-15 10:30:00",
      "updatedAt": "2024-10-01 15:45:00",
      "url": "/smartphone-xyz-pro-128gb",
      "urls": [
        {
          "tradePolicyId": 1,
          "url": "/smartphone-xyz-pro-128gb",
          "redirect": false,
          "redirectCode": null,
          "target": null,
          "createdAt": "2024-01-15T10:30:00Z",
          "updatedAt": "2024-01-15T10:30:00Z"
        }
      ],
      "linkedTradePolicies": [1, 2, 3],
      "description": {
        "id": 1234,
        "productId": 1234,
        "tradePolicyId": 1,
        "name": "Smartphone XYZ Pro 128GB",
        "shortDescription": "O mais avançado smartphone com 128GB de armazenamento",
        "description": "<p>Smartphone com processador octa-core, câmera tripla de 64MP e bateria de longa duração...</p>",
        "searchDescription": "smartphone xyz pro 128gb android camera 64mp bateria",
        "videoUrl": "https://youtube.com/watch?v=example",
        "customDescription1": null,
        "customDescription2": null,
        "customDescription3": null,
        "measureTable": null,
        "seoTitle": "Smartphone XYZ Pro 128GB - Compre Agora",
        "seoDescription": "Compre o Smartphone XYZ Pro com 128GB de armazenamento. Câmera 64MP, processador rápido e entrega rápida.",
        "seoKeywords": "smartphone, xyz pro, 128gb, android",
        "seoCanonical": "https://loja.com.br/smartphone-xyz-pro-128gb",
        "seoSocialTitle": "Smartphone XYZ Pro 128GB",
        "seoSocialDescription": "O melhor smartphone do mercado",
        "seoTwitterImageUrl": "https://cdn.loja.com.br/products/smartphone-xyz-pro-twitter.jpg",
        "seoGraphImageUrl": "https://cdn.loja.com.br/products/smartphone-xyz-pro-og.jpg",
        "seoGoogleCategoryId": 2895,
        "seoIndexOnGoogle": true,
        "seoGoogleCondition": "new",
        "seoGoogleAgeGroup": "adult",
        "seoGoogleGender": "unisex",
        "seoStructuredData": null
      }
    }
  ],
  "pagination": {
    "limit": 10,
    "offset": 0,
    "pages": 16,
    "registers": 156
  }
}

⚠️ 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.

Listagem de Produtos por política comercial

GET /products/trade-policy/{tradePolicyId}

Retorna lista paginada de produtos a partir de uma política comercial

Descrição

Endpoint responsável por retornar uma lista de produtos por política comercial 📦.

Atua em contexto administrativo, permitindo que o lojista visualize os produtos disponíveis dentro de uma política comercial específica.

Por meio desse endpoint, é possível consultar os produtos considerando as configurações aplicadas à política informada, facilitando a análise e o gerenciamento do catálogo nesse contexto.

Dessa forma, o lojista consegue entender quais produtos estão disponíveis e como se comportam dentro de determinada política comercial, garantindo maior controle sobre as estratégias de venda ⚙️.

Parâmetros

Headers Obrigatórios

Header	Valor	Descrição
`Authorization`	Bearer {userToken}	Token de autenticação

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

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) |

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}}/products/trade-policy/{tradePolicyId} \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
curl --request GET \
  --url {{MAIN_URL}}/products/trade-policy/{tradePolicyId} \
  --header "Authorization: Bearer SEU_TOKEN_AQUI" \

✅ 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": 328
15      },
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": 1499.90,
42        "salePrice":1199.90,
43        "markup": 0,
44        "ruleId": 0,
45        "ruleTrigger": "original",
46        "ruleName": "Original",
47        "availableForSale": true,
48        "basePrice": false,
49        "priceWithDiscount": 0,
50        "installments": [
51          {
52            "installment": 1,
53            "installmentValue": 1199.90,
54            "totalValue": 1199.90,
55            "fee": null,
56            "feeTotalValue": 0
57          }
58        ],
59        "scheduling": null
60      },
61      "price": {
62        "comparisonPrice": 1499.90,
63        "salePrice": 1199.90,
64        "markup": 25.02,
65        "ruleId": 15,
66        "ruleTrigger": "original",
67        "ruleName": "Original",
68        "availableForSale": true,
69        "basePrice": false,
70        "priceWithDiscount": 1199.90,
71        "installments": [
72          {
73            "installment": 1,
74            "installmentValue": 1199.90,
75            "totalValue": 1199.90,
76            "fee": null,
77            "feeTotalValue": 0
78          },
79          {
80            "installment": 2,
81            "installmentValue": 599.95,
82            "totalValue": 1199.90,
83            "fee": null,
84            "feeTotalValue": 0
85          },
86          {
87            "installment": 12,
88            "installmentValue": 99.99,
89            "totalValue": 1199.88,
90            "fee": null,
91            "feeTotalValue": 0
92          }
93        ],
94        "scheduling": {
95          "id": 46,
96          "startDate": "2026-02-07 09:00:00",
97          "endDate": "2026-10-30 23:59:59"
98        }
99      },
100      "priceRules": [
101        {
102          "id": 123,
103          "name": "product-price-rule",
104          "trigger": "automatic",
105          "ruleTarget": "product",
106          "origin": "product",
107          "applyInGroup": false,
108          "updateComparisonPrice": "not-update",
109          "basePriceField": "sale-price",
110          "code": "product-123",
111          "beginQuantity": 1,
112          "endQuantity": 1,
113          "value": -20,
114          "valueType": "percentage",
115          "priority": 1,
116          "active": true,
117          "scheduling": {
118            "id":1234,
119            "starDate":"2023-10-03 19:24:01",
120            "endDate":null
121          },
122          "tradePolicies": [1, 2, 3],
123          "productIds": [3, 2, 1, 5, 7],
124          "productCategoryIds": [8, 9, 45, 12],
125          "productBrandIds": [10, 7, 20, 36],
126          "lastUpdateUserName": "Marcos Brandão",
127          "createdAt": "2023-10-04 19:11:08",
128          "updatedAt": "2025-08-20 12:41:03"
129        }
130      ],
131      "brand": {
132        "id": 45,
133        "code": "TECH",
134        "name": "TechBrand",
135        "logo": "https://cdn.loja.com.br/brands/techbrand-logo.jpg",
136        "originalLogo": "https://cdn.loja.com.br/brands/techbrand-logo-original.jpg",
137        "productOrdering": "name_asc",
138        "active": true,
139        "bannerGroups": [],
140        "createdAt": "2023-10-04 19:11:08",
141        "updatedAt": "2025-08-20 12:41:03",
142        "url": "/marca/techbrand"
143      },
144      "flags": {
145        "subscription": false,
146        "service": false,
147        "showInSite": true,
148        "saleWithoutStock": false,
149        "minimumStock": 5
150      },
151      "tax": {
152        "mpn": "MPN123456",
153        "ean": "7891234567890",
154        "ncm": "85171231",
155        "exclusive": false
156      },
157      "indicatedProducts": [
158        {
159          "id": 1234,
160          "brandId": 1234,
161          "brandName": "TopPhone",
162          "mainCategoryId": 1,
163          "mainCategoryName": "smartphone",
164          "type": "product",
165          "name": "Smartphone XYZ Pro 128GB",
166          "sku": "SMPH001",
167          "url": "/smartphone-xyz-pro-128gb",
168          "comparisonPrice":2199.99,
169          "stock":20,
170          "medias":[
171            {
172              "id": 123,
173              "type": "image",
174              "title": "",
175              "alternativeText": null,
176              "file": "https://cdn.loja.com.br/upload/media/produto-media.webp",
177              "originalFile": "https://cdn.loja.com.br/upload/media/produto-media.png",
178              "size": null,
179              "originalSize": null,
180              "width": null,
181              "height": null,
182              "url": null
183            }
184          ],
185          "combination":[1, 2, 3],
186          "currentAttributes":[
187            {
188              "id":123,
189              "name":"cor",
190              "value":{
191                "id":123,
192                "label":"azul-escuro",
193                "image":null,
194                "originalImage":null,
195                "color":"#00008B",
196                "order":1
197              }
198            }
199          ],
200          "active": true
201        }
202      ],
203      "relatedProducts": [
204        {
205          "id": 1234,
206          "brandId": 1234,
207          "brandName": "TopPhone",
208          "mainCategoryId": 1,
209          "mainCategoryName": "smartphone",
210          "type": "product",
211          "name": "Smartphone XYZ Pro 128GB",
212          "sku": "SMPH001",
213          "url": "/smartphone-xyz-pro-128gb",
214          "comparisonPrice":2199.99,
215          "stock":20,
216          "medias":[
217            {
218              "id": 123,
219              "type": "image",
220              "title": "",
221              "alternativeText": null,
222              "file": "https://cdn.loja.com.br/upload/media/produto-media.webp",
223              "originalFile": "https://cdn.loja.com.br/upload/media/produto-media.png",
224              "size": null,
225              "originalSize": null,
226              "width": null,
227              "height": null,
228              "url": null
229            }
230          ],
231          "combination":[1, 2, 3],
232          "currentAttributes":[
233            {
234              "id":123,
235              "name":"cor",
236              "value":{
237                "id":123,
238                "label":"azul-escuro",
239                "image":null,
240                "originalImage":null,
241                "color":"#00008B",
242                "order":1
243              }
244            }
245          ],
246          "active": true
247        }
248      ],
249      "filters": [
250        {
251          "id": 123,
252          "productCategoryId": 1234,
253          "name": "Marca",
254          "active": true,
255          "showInListing": true,
256          "showInSpecificationTable": false,
257          "type": "enum",
258          "createdAt": "2025-01-14 10:31:00",
259          "values": [
260            {
261              "id": 123,
262              "name": "TechPhone",
263              "image": null,
264              "originalImage": null,
265              "color": null,
266              "order": 1,
267              "value": null
268            },
269            {
270              "id": 124,
271              "name": "SmartScreen",
272              "image": null,
273              "originalImage": null,
274              "color": null,
275              "order": 1,
276              "value": null
277            }
278          ]
279        }
280      ],
281      "seals": [
282        {
283          "id": 5,
284          "name": "Frete Grátis",
285          "active": true,
286          "textColor": "#FFFFFF",
287          "sealColor": "#00A650",
288          "image": "https://cdn.loja.com.br/seals/frete-gratis.png",
289          "originalImage": "https://cdn.loja.com.br/seals/frete-gratis-original.png",
290          "setting":{
291            "id": 1234,
292            "horizontalPosition": "left",
293            "verticalPosition": "top",
294            "proportionInProductDetail": 300,
295            "proportionInProductShowcase": 300,
296            "scheduling": {
297              "id": 1234,
298              "startDate": "2024-01-15 10:30:00",
299              "endDate": "2024-01-30 10:30:00"
300            }
301          },
302          "promotionLinkId":15,
303          "createdAt":"2024-01-15 10:30:00",
304          "updatedAt":"2024-01-15 10:30:00"
305        }
306      ],
307      "mainCategory": {
308        "id": 123,
309        "name": "Smartphones",
310        "url": "/smartphones"
311      },
312      "categories": [
313        {
314          "id": 100,
315          "name": "Eletrônicos",
316          "url": "/eletronicos"
317        },
318        {
319          "id": 110,
320          "name": "Telefonia",
321          "url": "/eletronicos/telefonia"
322        },
323        {
324          "id": 123,
325          "name": "Smartphones",
326          "url": "/eletronicos/telefonia/smartphones"
327        }
328      ],
329      "categoryBreadcrumb": [
330        {
331          "id": 100,
332          "name": "Eletrônicos",
333          "url": "/eletronicos"
334        },
335        {
336          "id": 110,
337          "name": "Telefonia",
338          "url": "/eletronicos/telefonia"
339        },
340        {
341          "id": 123,
342          "name": "Smartphones",
343          "url": "/eletronicos/telefonia/smartphones"
344        }
345      ],
346      "dimensions": {
347        "shippingCargoTypeId": 1,
348        "additionalTime": 0,
349        "width": 7.5,
350        "height": 15.2,
351        "length": 0.8,
352        "weight": 185
353      },
354      "parentProductId": null,
355      "combination": [1234],
356      "currentAttributes": [
357        {
358          "id": 1,
359          "name": "Cor",
360          "value": {
361            "id": 123,
362            "label": "Azul",
363            "image": null,
364            "originalImage": null,
365            "color": "007BFF",
366            "order": 1
367          }
368        }
369      ],
370      "variations": {
371        "valueList": [
372          1234
373        ],
374        "combinations": [
375          {
376            "productId": 1234,
377            "brandId": 1,
378            "brandName": "TechPhone",
379            "mainCategoryId": 123,
380            "mainCategoryName": "Tecnologia",
381            "type": "variation",
382            "sku": "ABC123",
383            "name": "Variation Phone",
384            "active": true,
385            "url": "nice-phone-url",
386            "comparisonPrice": 1800,
387            "stock": 21,
388            "medias": [
389              {
390                "id": 123,
391                "type": "image",
392                "title": "Variation Phone Image",
393                "alternativeText": null,
394                "file": "https://cdn.loja.com.br/upload/media.webp",
395                "originalFile": "https://cdn.loja.com.br/upload/media.png",
396                "size": null,
397                "originalSize": null,
398                "width": null,
399                "height": null,
400                "url": null
401              }
402            ],
403            "combination": [
404              1, 2
405            ],
406            "currentAttributes": [
407              {
408                "id": 1,
409                "name": "Cor",
410                "value": {
411                  "id": 1,
412                  "label": "Azul",
413                  "image": null,
414                  "originalImage": null,
415                  "color": "007BFF",
416                  "order": 1
417                }
418              }
419            ]
420          }
421        ],
422        "attributes": [
423          {
424            "id": 1,
425            "name": "Cor",
426            "displayName": "Cor",
427            "includeSample": false,
428            "values": [
429              {
430                "id": 1,
431                "label": "Azul",
432                "image": null,
433                "originalImage": null,
434                "color": "007BFF",
435                "order": 1
436              }
437            ],
438            "createdAt": "2025-07-23 22:50:28",
439            "updatedAt": "2025-08-06 16:03:59"
440          }
441        ]
442      },
443      "medias": [
444        {
445          "id": 1234,
446          "type": "image",
447          "title": "Imagem Principal",
448          "alternativeText": "Smartphone XYZ Pro vista frontal",
449          "file": "https://cdn.loja.com.br/products/smartphone-xyz-pro-01.jpg",
450          "originalFile": "https://cdn.loja.com.br/products/smartphone-xyz-pro-01-original.jpg",
451          "size": 245680,
452          "originalSize": 1567890,
453          "width": 800,
454          "height": 800,
455          "url": "https://cdn.loja.com.br/products/smartphone-xyz-pro-01.jpg"
456        }
457      ],
458      "bannerGroups": [
459        "banner 1",
460        "banner 2",
461        "banner 3"
462      ],
463      "status": "available",
464      "createdAt": "2024-01-15 10:30:00",
465      "updatedAt": "2024-10-01 15:45:00",
466      "url": "/smartphone-xyz-pro-128gb",
467      "urls": [
468        {
469          "tradePolicyId": 1,
470          "url": "/smartphone-xyz-pro-128gb",
471          "redirect": false,
472          "redirectCode": null,
473          "target": null,
474          "createdAt": "2024-01-15T10:30:00Z",
475          "updatedAt": "2024-01-15T10:30:00Z"
476        }
477      ],
478      "linkedTradePolicies": [1, 2, 3],
479      "description": {
480        "id": 1234,
481        "productId": 1234,
482        "tradePolicyId": 1,
483        "name": "Smartphone XYZ Pro 128GB",
484        "shortDescription": "O mais avançado smartphone com 128GB de armazenamento",
485        "description": "<p>Smartphone com processador octa-core, câmera tripla de 64MP e bateria de longa duração...</p>",
486        "searchDescription": "smartphone xyz pro 128gb android camera 64mp bateria",
487        "videoUrl": "https://youtube.com/watch?v=example",
488        "customDescription1": null,
489        "customDescription2": null,
490        "customDescription3": null,
491        "measureTable": null,
492        "seoTitle": "Smartphone XYZ Pro 128GB - Compre Agora",
493        "seoDescription": "Compre o Smartphone XYZ Pro com 128GB de armazenamento. Câmera 64MP, processador rápido e entrega rápida.",
494        "seoKeywords": "smartphone, xyz pro, 128gb, android",
495        "seoCanonical": "https://loja.com.br/smartphone-xyz-pro-128gb",
496        "seoSocialTitle": "Smartphone XYZ Pro 128GB",
497        "seoSocialDescription": "O melhor smartphone do mercado",
498        "seoTwitterImageUrl": "https://cdn.loja.com.br/products/smartphone-xyz-pro-twitter.jpg",
499        "seoGraphImageUrl": "https://cdn.loja.com.br/products/smartphone-xyz-pro-og.jpg",
500        "seoGoogleCategoryId": 2895,
501        "seoIndexOnGoogle": true,
502        "seoGoogleCondition": "new",
503        "seoGoogleAgeGroup": "adult",
504        "seoGoogleGender": "unisex",
505        "seoStructuredData": null
506      }
507    }
508  ],
509  "pagination": {
510    "limit": 10,
511    "offset": 0,
512    "pages": 16,
513    "registers": 156
514  }
515}
{
  "registers": [
    {
      "id": 1234,
      "type": "product",
      "sku": "SMPH001",
      "name": "Smartphone XYZ Pro 128GB",
      "priority": 100,
      "basePrice": 1199.90,
      "active": true,
      "review": {
        "productId": 1234,
        "averageRating": 4.67,
        "quantityRating": 328
      },
      "isGiftCard": false,
      "stock": {
        "productId": 1234,
        "productStorageId": 1,
        "availableStock": 15,
        "reservedStock": 2,
        "updatedAt": "2024-10-01 14:30:00"
      },
      "stocks": [
        {
          "productId": 1234,
          "productStorageId": 1,
          "availableStock": 15,
          "reservedStock": 2,
          "updatedAt": "2024-10-01 14:30:00"
        },
        {
          "productId": 1234,
          "productStorageId": 2,
          "availableStock": 8,
          "reservedStock": 1,
          "updatedAt": "2024-10-01 14:30:00"
        }
      ],
      "originalPrice": {
        "comparisonPrice": 1499.90,
        "salePrice":1199.90,
        "markup": 0,
        "ruleId": 0,
        "ruleTrigger": "original",
        "ruleName": "Original",
        "availableForSale": true,
        "basePrice": false,
        "priceWithDiscount": 0,
        "installments": [
          {
            "installment": 1,
            "installmentValue": 1199.90,
            "totalValue": 1199.90,
            "fee": null,
            "feeTotalValue": 0
          }
        ],
        "scheduling": null
      },
      "price": {
        "comparisonPrice": 1499.90,
        "salePrice": 1199.90,
        "markup": 25.02,
        "ruleId": 15,
        "ruleTrigger": "original",
        "ruleName": "Original",
        "availableForSale": true,
        "basePrice": false,
        "priceWithDiscount": 1199.90,
        "installments": [
          {
            "installment": 1,
            "installmentValue": 1199.90,
            "totalValue": 1199.90,
            "fee": null,
            "feeTotalValue": 0
          },
          {
            "installment": 2,
            "installmentValue": 599.95,
            "totalValue": 1199.90,
            "fee": null,
            "feeTotalValue": 0
          },
          {
            "installment": 12,
            "installmentValue": 99.99,
            "totalValue": 1199.88,
            "fee": null,
            "feeTotalValue": 0
          }
        ],
        "scheduling": {
          "id": 46,
          "startDate": "2026-02-07 09:00:00",
          "endDate": "2026-10-30 23:59:59"
        }
      },
      "priceRules": [
        {
          "id": 123,
          "name": "product-price-rule",
          "trigger": "automatic",
          "ruleTarget": "product",
          "origin": "product",
          "applyInGroup": false,
          "updateComparisonPrice": "not-update",
          "basePriceField": "sale-price",
          "code": "product-123",
          "beginQuantity": 1,
          "endQuantity": 1,
          "value": -20,
          "valueType": "percentage",
          "priority": 1,
          "active": true,
          "scheduling": {
            "id":1234,
            "starDate":"2023-10-03 19:24:01",
            "endDate":null
          },
          "tradePolicies": [1, 2, 3],
          "productIds": [3, 2, 1, 5, 7],
          "productCategoryIds": [8, 9, 45, 12],
          "productBrandIds": [10, 7, 20, 36],
          "lastUpdateUserName": "Marcos Brandão",
          "createdAt": "2023-10-04 19:11:08",
          "updatedAt": "2025-08-20 12:41:03"
        }
      ],
      "brand": {
        "id": 45,
        "code": "TECH",
        "name": "TechBrand",
        "logo": "https://cdn.loja.com.br/brands/techbrand-logo.jpg",
        "originalLogo": "https://cdn.loja.com.br/brands/techbrand-logo-original.jpg",
        "productOrdering": "name_asc",
        "active": true,
        "bannerGroups": [],
        "createdAt": "2023-10-04 19:11:08",
        "updatedAt": "2025-08-20 12:41:03",
        "url": "/marca/techbrand"
      },
      "flags": {
        "subscription": false,
        "service": false,
        "showInSite": true,
        "saleWithoutStock": false,
        "minimumStock": 5
      },
      "tax": {
        "mpn": "MPN123456",
        "ean": "7891234567890",
        "ncm": "85171231",
        "exclusive": false
      },
      "indicatedProducts": [
        {
          "id": 1234,
          "brandId": 1234,
          "brandName": "TopPhone",
          "mainCategoryId": 1,
          "mainCategoryName": "smartphone",
          "type": "product",
          "name": "Smartphone XYZ Pro 128GB",
          "sku": "SMPH001",
          "url": "/smartphone-xyz-pro-128gb",
          "comparisonPrice":2199.99,
          "stock":20,
          "medias":[
            {
              "id": 123,
              "type": "image",
              "title": "",
              "alternativeText": null,
              "file": "https://cdn.loja.com.br/upload/media/produto-media.webp",
              "originalFile": "https://cdn.loja.com.br/upload/media/produto-media.png",
              "size": null,
              "originalSize": null,
              "width": null,
              "height": null,
              "url": null
            }
          ],
          "combination":[1, 2, 3],
          "currentAttributes":[
            {
              "id":123,
              "name":"cor",
              "value":{
                "id":123,
                "label":"azul-escuro",
                "image":null,
                "originalImage":null,
                "color":"#00008B",
                "order":1
              }
            }
          ],
          "active": true
        }
      ],
      "relatedProducts": [
        {
          "id": 1234,
          "brandId": 1234,
          "brandName": "TopPhone",
          "mainCategoryId": 1,
          "mainCategoryName": "smartphone",
          "type": "product",
          "name": "Smartphone XYZ Pro 128GB",
          "sku": "SMPH001",
          "url": "/smartphone-xyz-pro-128gb",
          "comparisonPrice":2199.99,
          "stock":20,
          "medias":[
            {
              "id": 123,
              "type": "image",
              "title": "",
              "alternativeText": null,
              "file": "https://cdn.loja.com.br/upload/media/produto-media.webp",
              "originalFile": "https://cdn.loja.com.br/upload/media/produto-media.png",
              "size": null,
              "originalSize": null,
              "width": null,
              "height": null,
              "url": null
            }
          ],
          "combination":[1, 2, 3],
          "currentAttributes":[
            {
              "id":123,
              "name":"cor",
              "value":{
                "id":123,
                "label":"azul-escuro",
                "image":null,
                "originalImage":null,
                "color":"#00008B",
                "order":1
              }
            }
          ],
          "active": true
        }
      ],
      "filters": [
        {
          "id": 123,
          "productCategoryId": 1234,
          "name": "Marca",
          "active": true,
          "showInListing": true,
          "showInSpecificationTable": false,
          "type": "enum",
          "createdAt": "2025-01-14 10:31:00",
          "values": [
            {
              "id": 123,
              "name": "TechPhone",
              "image": null,
              "originalImage": null,
              "color": null,
              "order": 1,
              "value": null
            },
            {
              "id": 124,
              "name": "SmartScreen",
              "image": null,
              "originalImage": null,
              "color": null,
              "order": 1,
              "value": null
            }
          ]
        }
      ],
      "seals": [
        {
          "id": 5,
          "name": "Frete Grátis",
          "active": true,
          "textColor": "#FFFFFF",
          "sealColor": "#00A650",
          "image": "https://cdn.loja.com.br/seals/frete-gratis.png",
          "originalImage": "https://cdn.loja.com.br/seals/frete-gratis-original.png",
          "setting":{
            "id": 1234,
            "horizontalPosition": "left",
            "verticalPosition": "top",
            "proportionInProductDetail": 300,
            "proportionInProductShowcase": 300,
            "scheduling": {
              "id": 1234,
              "startDate": "2024-01-15 10:30:00",
              "endDate": "2024-01-30 10:30:00"
            }
          },
          "promotionLinkId":15,
          "createdAt":"2024-01-15 10:30:00",
          "updatedAt":"2024-01-15 10:30:00"
        }
      ],
      "mainCategory": {
        "id": 123,
        "name": "Smartphones",
        "url": "/smartphones"
      },
      "categories": [
        {
          "id": 100,
          "name": "Eletrônicos",
          "url": "/eletronicos"
        },
        {
          "id": 110,
          "name": "Telefonia",
          "url": "/eletronicos/telefonia"
        },
        {
          "id": 123,
          "name": "Smartphones",
          "url": "/eletronicos/telefonia/smartphones"
        }
      ],
      "categoryBreadcrumb": [
        {
          "id": 100,
          "name": "Eletrônicos",
          "url": "/eletronicos"
        },
        {
          "id": 110,
          "name": "Telefonia",
          "url": "/eletronicos/telefonia"
        },
        {
          "id": 123,
          "name": "Smartphones",
          "url": "/eletronicos/telefonia/smartphones"
        }
      ],
      "dimensions": {
        "shippingCargoTypeId": 1,
        "additionalTime": 0,
        "width": 7.5,
        "height": 15.2,
        "length": 0.8,
        "weight": 185
      },
      "parentProductId": null,
      "combination": [1234],
      "currentAttributes": [
        {
          "id": 1,
          "name": "Cor",
          "value": {
            "id": 123,
            "label": "Azul",
            "image": null,
            "originalImage": null,
            "color": "007BFF",
            "order": 1
          }
        }
      ],
      "variations": {
        "valueList": [
          1234
        ],
        "combinations": [
          {
            "productId": 1234,
            "brandId": 1,
            "brandName": "TechPhone",
            "mainCategoryId": 123,
            "mainCategoryName": "Tecnologia",
            "type": "variation",
            "sku": "ABC123",
            "name": "Variation Phone",
            "active": true,
            "url": "nice-phone-url",
            "comparisonPrice": 1800,
            "stock": 21,
            "medias": [
              {
                "id": 123,
                "type": "image",
                "title": "Variation Phone Image",
                "alternativeText": null,
                "file": "https://cdn.loja.com.br/upload/media.webp",
                "originalFile": "https://cdn.loja.com.br/upload/media.png",
                "size": null,
                "originalSize": null,
                "width": null,
                "height": null,
                "url": null
              }
            ],
            "combination": [
              1, 2
            ],
            "currentAttributes": [
              {
                "id": 1,
                "name": "Cor",
                "value": {
                  "id": 1,
                  "label": "Azul",
                  "image": null,
                  "originalImage": null,
                  "color": "007BFF",
                  "order": 1
                }
              }
            ]
          }
        ],
        "attributes": [
          {
            "id": 1,
            "name": "Cor",
            "displayName": "Cor",
            "includeSample": false,
            "values": [
              {
                "id": 1,
                "label": "Azul",
                "image": null,
                "originalImage": null,
                "color": "007BFF",
                "order": 1
              }
            ],
            "createdAt": "2025-07-23 22:50:28",
            "updatedAt": "2025-08-06 16:03:59"
          }
        ]
      },
      "medias": [
        {
          "id": 1234,
          "type": "image",
          "title": "Imagem Principal",
          "alternativeText": "Smartphone XYZ Pro vista frontal",
          "file": "https://cdn.loja.com.br/products/smartphone-xyz-pro-01.jpg",
          "originalFile": "https://cdn.loja.com.br/products/smartphone-xyz-pro-01-original.jpg",
          "size": 245680,
          "originalSize": 1567890,
          "width": 800,
          "height": 800,
          "url": "https://cdn.loja.com.br/products/smartphone-xyz-pro-01.jpg"
        }
      ],
      "bannerGroups": [
        "banner 1",
        "banner 2",
        "banner 3"
      ],
      "status": "available",
      "createdAt": "2024-01-15 10:30:00",
      "updatedAt": "2024-10-01 15:45:00",
      "url": "/smartphone-xyz-pro-128gb",
      "urls": [
        {
          "tradePolicyId": 1,
          "url": "/smartphone-xyz-pro-128gb",
          "redirect": false,
          "redirectCode": null,
          "target": null,
          "createdAt": "2024-01-15T10:30:00Z",
          "updatedAt": "2024-01-15T10:30:00Z"
        }
      ],
      "linkedTradePolicies": [1, 2, 3],
      "description": {
        "id": 1234,
        "productId": 1234,
        "tradePolicyId": 1,
        "name": "Smartphone XYZ Pro 128GB",
        "shortDescription": "O mais avançado smartphone com 128GB de armazenamento",
        "description": "<p>Smartphone com processador octa-core, câmera tripla de 64MP e bateria de longa duração...</p>",
        "searchDescription": "smartphone xyz pro 128gb android camera 64mp bateria",
        "videoUrl": "https://youtube.com/watch?v=example",
        "customDescription1": null,
        "customDescription2": null,
        "customDescription3": null,
        "measureTable": null,
        "seoTitle": "Smartphone XYZ Pro 128GB - Compre Agora",
        "seoDescription": "Compre o Smartphone XYZ Pro com 128GB de armazenamento. Câmera 64MP, processador rápido e entrega rápida.",
        "seoKeywords": "smartphone, xyz pro, 128gb, android",
        "seoCanonical": "https://loja.com.br/smartphone-xyz-pro-128gb",
        "seoSocialTitle": "Smartphone XYZ Pro 128GB",
        "seoSocialDescription": "O melhor smartphone do mercado",
        "seoTwitterImageUrl": "https://cdn.loja.com.br/products/smartphone-xyz-pro-twitter.jpg",
        "seoGraphImageUrl": "https://cdn.loja.com.br/products/smartphone-xyz-pro-og.jpg",
        "seoGoogleCategoryId": 2895,
        "seoIndexOnGoogle": true,
        "seoGoogleCondition": "new",
        "seoGoogleAgeGroup": "adult",
        "seoGoogleGender": "unisex",
        "seoStructuredData": null
      }
    }
  ],
  "pagination": {
    "limit": 10,
    "offset": 0,
    "pages": 16,
    "registers": 156
  }
}

⚠️ 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.

Detalhes do Produto

GET /products/{productId}

Retorna informações completas de um produto específico

Descrição

Endpoint responsável por retornar os detalhes completos de um produto 🛍️.

Atua em contexto administrativo, permitindo que o lojista visualize todas as informações cadastradas do produto e realize configurações quando necessário.

Por meio desse endpoint, é possível acessar dados completos do produto, incluindo:

Descrição completa
Preço e disponibilidade
Imagens e mídias
Atributos e especificações técnicas
Informações de categorias e marcas

Essas informações permitem que o lojista analise, revise e configure o produto conforme desejado, garantindo que os dados exibidos no catálogo estejam corretos e atualizados ⚙️.

Parâmetros

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

Exemplo de Requisição

1curl --request GET \
2  --url {{MAIN_URL}}/products/{productId} \
curl --request GET \
  --url {{MAIN_URL}}/products/{productId} \

✅ 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": 328
13  },
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": null
50  },
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": 0
68      },
69      {
70        "installment": 2,
71        "installmentValue": 599.95,
72        "totalValue": 1199.90,
73        "fee": null,
74        "feeTotalValue": 0
75      },
76      {
77        "installment": 12,
78        "installmentValue": 99.99,
79        "totalValue": 1199.88,
80        "fee": null,
81        "feeTotalValue": 0
82      }
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": 5
110  },
111  "tax": {
112    "mpn": "MPN123456",
113    "ean": "7891234567890",
114    "ncm": "85171231",
115    "exclusive": false
116  },
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": null
143        }
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":1
157          }
158        }
159      ],
160      "active": true
161    }
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": null
189        }
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":1
203          }
204        }
205      ],
206      "active": true
207    }
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": null
228        },
229        {
230          "id": 124,
231          "name": "SmartScreen",
232          "image": null,
233          "originalImage": null,
234          "color": null,
235          "order": 1,
236          "value": null
237        }
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": 185
313  },
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": 1
327      }
328    }
329  ],
330  "variations": {
331    "valueList": [
332      1234
333    ],
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": null
361          }
362        ],
363        "combination": [
364          1, 2
365        ],
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": 1
377            }
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": 1
396          }
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": null
466  }
467}
{
  "id": 1234,
  "type": "product",
  "sku": "SMPH001",
  "name": "Smartphone XYZ Pro 128GB",
  "priority": 100,
  "basePrice": 1199.90,
  "active": true,
  "review": {
    "productId": 1234,
    "averageRating": 4.67,
    "quantityRating": 328
  },
  "isGiftCard": false,
  "stock": {
    "productId": 1234,
    "productStorageId": 1,
    "availableStock": 15,
    "reservedStock": 2,
    "updatedAt": "2024-10-01 14:30:00"
  },
  "stocks": [
    {
      "productId": 1234,
      "productStorageId": 1,
      "availableStock": 15,
      "reservedStock": 2,
      "updatedAt": "2024-10-01 14:30:00"
    },
    {
      "productId": 1234,
      "productStorageId": 2,
      "availableStock": 8,
      "reservedStock": 1,
      "updatedAt": "2024-10-01 14:30:00"
    }
  ],
  "originalPrice": {
    "comparisonPrice": 0,
    "salePrice": 0,
    "markup": 0,
    "ruleId": 0,
    "ruleTrigger": "original",
    "ruleName": "Original",
    "availableForSale": true,
    "basePrice": false,
    "priceWithDiscount": 0,
    "installments": [],
    "scheduling": null
  },
  "price": {
    "comparisonPrice": 1499.90,
    "salePrice": 1199.90,
    "markup": 25.02,
    "ruleId": 15,
    "ruleTrigger": "original",
    "ruleName": "Original",
    "availableForSale": true,
    "basePrice": false,
    "priceWithDiscount": 1199.90,
    "installments": [
      {
        "installment": 1,
        "installmentValue": 1199.90,
        "totalValue": 1199.90,
        "fee": null,
        "feeTotalValue": 0
      },
      {
        "installment": 2,
        "installmentValue": 599.95,
        "totalValue": 1199.90,
        "fee": null,
        "feeTotalValue": 0
      },
      {
        "installment": 12,
        "installmentValue": 99.99,
        "totalValue": 1199.88,
        "fee": null,
        "feeTotalValue": 0
      }
    ],
    "scheduling": {
      "id": 46,
      "startDate": "2026-02-07 09:00:00",
      "endDate": "2026-10-30 23:59:59"
    }
  },
  "priceRules": null,
  "brand": {
    "id": 45,
    "code": "TECH",
    "name": "TechBrand",
    "logo": "https://cdn.loja.com.br/brands/techbrand-logo.jpg",
    "originalLogo": "https://cdn.loja.com.br/brands/techbrand-logo-original.jpg",
    "productOrdering": "name_asc",
    "active": true,
    "bannerGroups": [],
    "createdAt": "2023-10-04 19:11:08",
    "updatedAt": "2025-08-20 12:41:03",
    "url": "/marca/techbrand"
  },
  "flags": {
    "subscription": false,
    "service": false,
    "showInSite": true,
    "saleWithoutStock": false,
    "minimumStock": 5
  },
  "tax": {
    "mpn": "MPN123456",
    "ean": "7891234567890",
    "ncm": "85171231",
    "exclusive": false
  },
  "indicatedProducts": [
    {
      "id": 1234,
      "brandId": 1234,
      "brandName": "TopPhone",
      "mainCategoryId": 1,
      "mainCategoryName": "smartphone",
      "type": "product",
      "name": "Smartphone XYZ Pro 128GB",
      "sku": "SMPH001",
      "url": "/smartphone-xyz-pro-128gb",
      "comparisonPrice":2199.99,
      "stock":20,
      "medias":[
        {
          "id": 123,
          "type": "image",
          "title": "",
          "alternativeText": null,
          "file": "https://cdn.loja.com.br/upload/media/produto-media.webp",
          "originalFile": "https://cdn.loja.com.br/upload/media/produto-media.png",
          "size": null,
          "originalSize": null,
          "width": null,
          "height": null,
          "url": null
        }
      ],
      "combination":[1, 2, 3],
      "currentAttributes":[
        {
          "id":123,
          "name":"cor",
          "value":{
            "id":123,
            "label":"azul-escuro",
            "image":null,
            "originalImage":null,
            "color":"#00008B",
            "order":1
          }
        }
      ],
      "active": true
    }
  ],
  "relatedProducts": [
    {
      "id": 1234,
      "brandId": 1234,
      "brandName": "TopPhone",
      "mainCategoryId": 1,
      "mainCategoryName": "smartphone",
      "type": "product",
      "name": "Smartphone XYZ Pro 128GB",
      "sku": "SMPH001",
      "url": "/smartphone-xyz-pro-128gb",
      "comparisonPrice":2199.99,
      "stock":20,
      "medias":[
        {
          "id": 123,
          "type": "image",
          "title": "",
          "alternativeText": null,
          "file": "https://cdn.loja.com.br/upload/media/produto-media.webp",
          "originalFile": "https://cdn.loja.com.br/upload/media/produto-media.png",
          "size": null,
          "originalSize": null,
          "width": null,
          "height": null,
          "url": null
        }
      ],
      "combination":[1, 2, 3],
      "currentAttributes":[
        {
          "id":123,
          "name":"cor",
          "value":{
            "id":123,
            "label":"azul-escuro",
            "image":null,
            "originalImage":null,
            "color":"#00008B",
            "order":1
          }
        }
      ],
      "active": true
    }
  ],
  "filters": [
    {
      "id": 123,
      "productCategoryId": 1234,
      "name": "Marca",
      "active": true,
      "showInListing": true,
      "showInSpecificationTable": false,
      "type": "enum",
      "createdAt": "2025-01-14 10:31:00",
      "values": [
        {
          "id": 123,
          "name": "TechPhone",
          "image": null,
          "originalImage": null,
          "color": null,
          "order": 1,
          "value": null
        },
        {
          "id": 124,
          "name": "SmartScreen",
          "image": null,
          "originalImage": null,
          "color": null,
          "order": 1,
          "value": null
        }
      ]
    }
  ],
  "seals": [
    {
      "id": 5,
      "name": "Frete Grátis",
      "active": true,
      "textColor": "#FFFFFF",
      "sealColor": "#00A650",
      "image": "https://cdn.loja.com.br/seals/frete-gratis.png",
      "originalImage": "https://cdn.loja.com.br/seals/frete-gratis-original.png",
      "setting":{
        "id": 1234,
        "horizontalPosition": "left",
        "verticalPosition": "top",
        "proportionInProductDetail": 300,
        "proportionInProductShowcase": 300,
        "scheduling": {
          "id": 1234,
          "startDate": "2024-01-15 10:30:00",
          "endDate": "2024-01-30 10:30:00"
        }
      },
      "promotionLinkId":15,
      "createdAt":"2024-01-15 10:30:00",
      "updatedAt":"2024-01-15 10:30:00"
    }
  ],
  "mainCategory": {
    "id": 123,
    "name": "Smartphones",
    "url": "/smartphones"
  },
  "categories": [
    {
      "id": 100,
      "name": "Eletrônicos",
      "url": "/eletronicos"
    },
    {
      "id": 110,
      "name": "Telefonia",
      "url": "/eletronicos/telefonia"
    },
    {
      "id": 123,
      "name": "Smartphones",
      "url": "/eletronicos/telefonia/smartphones"
    }
  ],
  "categoryBreadcrumb": [
    {
      "id": 100,
      "name": "Eletrônicos",
      "url": "/eletronicos"
    },
    {
      "id": 110,
      "name": "Telefonia",
      "url": "/eletronicos/telefonia"
    },
    {
      "id": 123,
      "name": "Smartphones",
      "url": "/eletronicos/telefonia/smartphones"
    }
  ],
  "dimensions": {
    "shippingCargoTypeId": 1,
    "additionalTime": 0,
    "width": 7.5,
    "height": 15.2,
    "length": 0.8,
    "weight": 185
  },
  "parentProductId": null,
  "combination": [1234],
  "currentAttributes": [
    {
      "id": 1,
      "name": "Cor",
      "value": {
        "id": 123,
        "label": "Azul",
        "image": null,
        "originalImage": null,
        "color": "007BFF",
        "order": 1
      }
    }
  ],
  "variations": {
    "valueList": [
      1234
    ],
    "combinations": [
      {
        "productId": 1234,
        "brandId": 1,
        "brandName": "TechPhone",
        "mainCategoryId": 123,
        "mainCategoryName": "Tecnologia",
        "type": "variation",
        "sku": "ABC123",
        "name": "Variation Phone",
        "active": true,
        "url": "nice-phone-url",
        "comparisonPrice": 1800,
        "stock": 21,
        "medias": [
          {
            "id": 123,
            "type": "image",
            "title": "Variation Phone Image",
            "alternativeText": null,
            "file": "https://cdn.loja.com.br/upload/media.webp",
            "originalFile": "https://cdn.loja.com.br/upload/media.png",
            "size": null,
            "originalSize": null,
            "width": null,
            "height": null,
            "url": null
          }
        ],
        "combination": [
          1, 2
        ],
        "currentAttributes": [
          {
            "id": 1,
            "name": "Cor",
            "value": {
              "id": 1,
              "label": "Azul",
              "image": null,
              "originalImage": null,
              "color": "007BFF",
              "order": 1
            }
          }
        ]
		  }
    ],
    "attributes": [
      {
        "id": 1,
        "name": "Cor",
        "displayName": "Cor",
        "includeSample": false,
        "values": [
          {
            "id": 1,
            "label": "Azul",
            "image": null,
            "originalImage": null,
            "color": "007BFF",
            "order": 1
          }
        ],
        "createdAt": "2025-07-23 22:50:28",
        "updatedAt": "2025-08-06 16:03:59"
      }
		]
  },
  "medias": [
    {
      "id": 1234,
      "type": "image",
      "title": "Imagem Principal",
      "alternativeText": "Smartphone XYZ Pro vista frontal",
      "file": "https://cdn.loja.com.br/products/smartphone-xyz-pro-01.jpg",
      "originalFile": "https://cdn.loja.com.br/products/smartphone-xyz-pro-01-original.jpg",
      "size": 245680,
      "originalSize": 1567890,
      "width": 800,
      "height": 800,
      "url": "https://cdn.loja.com.br/products/smartphone-xyz-pro-01.jpg"
    }
  ],
  "bannerGroups": [
    "banner 1",
    "banner 2",
    "banner 3"
  ],
  "status": "available",
  "createdAt": "2024-01-15 10:30:00",
  "updatedAt": "2024-10-01 15:45:00",
  "url": "/smartphone-xyz-pro-128gb",
  "urls": [
    {
      "tradePolicyId": 1,
      "url": "/smartphone-xyz-pro-128gb",
      "redirect": false,
      "redirectCode": null,
      "target": null,
      "createdAt": "2024-01-15 10:30:00",
      "updatedAt": "2024-01-15 10:30:00"
    }
  ],
  "linkedTradePolicies": [1, 2, 3],
  "description": {
    "id": 1234,
    "productId": 1234,
    "tradePolicyId": 1,
    "name": "Smartphone XYZ Pro 128GB",
    "shortDescription": "O mais avançado smartphone com 128GB de armazenamento",
    "description": "<p>Smartphone com processador octa-core, câmera tripla de 64MP e bateria de longa duração...</p>",
    "searchDescription": "smartphone xyz pro 128gb android camera 64mp bateria",
    "videoUrl": "https://youtube.com/watch?v=example",
    "customDescription1": null,
    "customDescription2": null,
    "customDescription3": null,
    "measureTable": null,
    "seoTitle": "Smartphone XYZ Pro 128GB - Compre Agora",
    "seoDescription": "Compre o Smartphone XYZ Pro com 128GB de armazenamento. Câmera 64MP, processador rápido e entrega rápida.",
    "seoKeywords": "smartphone, xyz pro, 128gb, android",
    "seoCanonical": "https://loja.com.br/smartphone-xyz-pro-128gb",
    "seoSocialTitle": "Smartphone XYZ Pro 128GB",
    "seoSocialDescription": "O melhor smartphone do mercado",
    "seoTwitterImageUrl": "https://cdn.loja.com.br/products/smartphone-xyz-pro-twitter.jpg",
    "seoGraphImageUrl": "https://cdn.loja.com.br/products/smartphone-xyz-pro-og.jpg",
    "seoGoogleCategoryId": 2895,
    "seoIndexOnGoogle": true,
    "seoGoogleCondition": "new",
    "seoGoogleAgeGroup": "adult",
    "seoGoogleGender": "unisex",
    "seoStructuredData": null
  }
}

⚠️ 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.

Detalhes do Produto por política comercial

GET /products/{productId}/trade-policy/{tradePolicyId}

Retorna informações completas de um produto específico por política comercial

Descrição

Endpoint responsável por retornar os detalhes completos de um produto por política comercial 🛍️.

Atua em contexto administrativo, permitindo que o lojista visualize como o produto está configurado dentro de uma política comercial específica.

Por meio desse endpoint, é possível acessar todas as informações do produto considerando as regras da política informada, como:

Configurações do produto
Preço e disponibilidade
Imagens e mídias
Atributos e especificações
Informações de categorias e marcas

Dessa forma, o lojista consegue analisar como o produto se comporta em diferentes políticas comerciais, garantindo que as configurações estejam corretas para cada contexto de venda ⚙️.

Parâmetros

Parâmetros da URL

Parâmetro	Tipo	Obrigatório	Descrição
productId	integer	Sim	Identificador único do produto
tradePolicyId	integer	Sim	Identificador da política comercial associada

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

Exemplo de Requisição

1curl --request GET \
2  --url {{MAIN_URL}}/products/{productId}/trade-policy/{tradePolicyId} \
curl --request GET \
  --url {{MAIN_URL}}/products/{productId}/trade-policy/{tradePolicyId} \

✅ 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": 328
13  },
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": null
50  },
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": 0
68      },
69      {
70        "installment": 2,
71        "installmentValue": 599.95,
72        "totalValue": 1199.90,
73        "fee": null,
74        "feeTotalValue": 0
75      },
76      {
77        "installment": 12,
78        "installmentValue": 99.99,
79        "totalValue": 1199.88,
80        "fee": null,
81        "feeTotalValue": 0
82      }
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": 5
110  },
111  "tax": {
112    "mpn": "MPN123456",
113    "ean": "7891234567890",
114    "ncm": "85171231",
115    "exclusive": false
116  },
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": null
143        }
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":1
157          }
158        }
159      ],
160      "active": true
161    }
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": null
189        }
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":1
203          }
204        }
205      ],
206      "active": true
207    }
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": null
228        },
229        {
230          "id": 124,
231          "name": "SmartScreen",
232          "image": null,
233          "originalImage": null,
234          "color": null,
235          "order": 1,
236          "value": null
237        }
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": 185
313  },
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": 1
327      }
328    }
329  ],
330  "variations": {
331    "valueList": [
332      1234
333    ],
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": null
361          }
362        ],
363        "combination": [
364          1, 2
365        ],
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": 1
377            }
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": 1
396          }
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": null
466  }
467}
{
  "id": 1234,
  "type": "product",
  "sku": "SMPH001",
  "name": "Smartphone XYZ Pro 128GB",
  "priority": 100,
  "basePrice": 1199.90,
  "active": true,
  "review": {
    "productId": 1234,
    "averageRating": 4.67,
    "quantityRating": 328
  },
  "isGiftCard": false,
  "stock": {
    "productId": 1234,
    "productStorageId": 1,
    "availableStock": 15,
    "reservedStock": 2,
    "updatedAt": "2024-10-01 14:30:00"
  },
  "stocks": [
    {
      "productId": 1234,
      "productStorageId": 1,
      "availableStock": 15,
      "reservedStock": 2,
      "updatedAt": "2024-10-01 14:30:00"
    },
    {
      "productId": 1234,
      "productStorageId": 2,
      "availableStock": 8,
      "reservedStock": 1,
      "updatedAt": "2024-10-01 14:30:00"
    }
  ],
  "originalPrice": {
    "comparisonPrice": 0,
    "salePrice": 0,
    "markup": 0,
    "ruleId": 0,
    "ruleTrigger": "original",
    "ruleName": "Original",
    "availableForSale": true,
    "basePrice": false,
    "priceWithDiscount": 0,
    "installments": [],
    "scheduling": null
  },
  "price": {
    "comparisonPrice": 1499.90,
    "salePrice": 1199.90,
    "markup": 25.02,
    "ruleId": 15,
    "ruleTrigger": "original",
    "ruleName": "Original",
    "availableForSale": true,
    "basePrice": false,
    "priceWithDiscount": 1199.90,
    "installments": [
      {
        "installment": 1,
        "installmentValue": 1199.90,
        "totalValue": 1199.90,
        "fee": null,
        "feeTotalValue": 0
      },
      {
        "installment": 2,
        "installmentValue": 599.95,
        "totalValue": 1199.90,
        "fee": null,
        "feeTotalValue": 0
      },
      {
        "installment": 12,
        "installmentValue": 99.99,
        "totalValue": 1199.88,
        "fee": null,
        "feeTotalValue": 0
      }
    ],
    "scheduling": {
      "id": 46,
      "startDate": "2026-02-07 09:00:00",
      "endDate": "2026-10-30 23:59:59"
    }
  },
  "priceRules": null,
  "brand": {
    "id": 45,
    "code": "TECH",
    "name": "TechBrand",
    "logo": "https://cdn.loja.com.br/brands/techbrand-logo.jpg",
    "originalLogo": "https://cdn.loja.com.br/brands/techbrand-logo-original.jpg",
    "productOrdering": "name_asc",
    "active": true,
    "bannerGroups": [],
    "createdAt": "2023-10-04 19:11:08",
    "updatedAt": "2025-08-20 12:41:03",
    "url": "/marca/techbrand"
  },
  "flags": {
    "subscription": false,
    "service": false,
    "showInSite": true,
    "saleWithoutStock": false,
    "minimumStock": 5
  },
  "tax": {
    "mpn": "MPN123456",
    "ean": "7891234567890",
    "ncm": "85171231",
    "exclusive": false
  },
  "indicatedProducts": [
    {
      "id": 1234,
      "brandId": 1234,
      "brandName": "TopPhone",
      "mainCategoryId": 1,
      "mainCategoryName": "smartphone",
      "type": "product",
      "name": "Smartphone XYZ Pro 128GB",
      "sku": "SMPH001",
      "url": "/smartphone-xyz-pro-128gb",
      "comparisonPrice":2199.99,
      "stock":20,
      "medias":[
        {
          "id": 123,
          "type": "image",
          "title": "",
          "alternativeText": null,
          "file": "https://cdn.loja.com.br/upload/media/produto-media.webp",
          "originalFile": "https://cdn.loja.com.br/upload/media/produto-media.png",
          "size": null,
          "originalSize": null,
          "width": null,
          "height": null,
          "url": null
        }
      ],
      "combination":[1, 2, 3],
      "currentAttributes":[
        {
          "id":123,
          "name":"cor",
          "value":{
            "id":123,
            "label":"azul-escuro",
            "image":null,
            "originalImage":null,
            "color":"#00008B",
            "order":1
          }
        }
      ],
      "active": true
    }
  ],
  "relatedProducts": [
    {
      "id": 1234,
      "brandId": 1234,
      "brandName": "TopPhone",
      "mainCategoryId": 1,
      "mainCategoryName": "smartphone",
      "type": "product",
      "name": "Smartphone XYZ Pro 128GB",
      "sku": "SMPH001",
      "url": "/smartphone-xyz-pro-128gb",
      "comparisonPrice":2199.99,
      "stock":20,
      "medias":[
        {
          "id": 123,
          "type": "image",
          "title": "",
          "alternativeText": null,
          "file": "https://cdn.loja.com.br/upload/media/produto-media.webp",
          "originalFile": "https://cdn.loja.com.br/upload/media/produto-media.png",
          "size": null,
          "originalSize": null,
          "width": null,
          "height": null,
          "url": null
        }
      ],
      "combination":[1, 2, 3],
      "currentAttributes":[
        {
          "id":123,
          "name":"cor",
          "value":{
            "id":123,
            "label":"azul-escuro",
            "image":null,
            "originalImage":null,
            "color":"#00008B",
            "order":1
          }
        }
      ],
      "active": true
    }
  ],
  "filters": [
    {
      "id": 123,
      "productCategoryId": 1234,
      "name": "Marca",
      "active": true,
      "showInListing": true,
      "showInSpecificationTable": false,
      "type": "enum",
      "createdAt": "2025-01-14 10:31:00",
      "values": [
        {
          "id": 123,
          "name": "TechPhone",
          "image": null,
          "originalImage": null,
          "color": null,
          "order": 1,
          "value": null
        },
        {
          "id": 124,
          "name": "SmartScreen",
          "image": null,
          "originalImage": null,
          "color": null,
          "order": 1,
          "value": null
        }
      ]
    }
  ],
  "seals": [
    {
      "id": 5,
      "name": "Frete Grátis",
      "active": true,
      "textColor": "#FFFFFF",
      "sealColor": "#00A650",
      "image": "https://cdn.loja.com.br/seals/frete-gratis.png",
      "originalImage": "https://cdn.loja.com.br/seals/frete-gratis-original.png",
      "setting":{
        "id": 1234,
        "horizontalPosition": "left",
        "verticalPosition": "top",
        "proportionInProductDetail": 300,
        "proportionInProductShowcase": 300,
        "scheduling": {
          "id": 1234,
          "startDate": "2024-01-15 10:30:00",
          "endDate": "2024-01-30 10:30:00"
        }
      },
      "promotionLinkId":15,
      "createdAt":"2024-01-15 10:30:00",
      "updatedAt":"2024-01-15 10:30:00"
    }
  ],
  "mainCategory": {
    "id": 123,
    "name": "Smartphones",
    "url": "/smartphones"
  },
  "categories": [
    {
      "id": 100,
      "name": "Eletrônicos",
      "url": "/eletronicos"
    },
    {
      "id": 110,
      "name": "Telefonia",
      "url": "/eletronicos/telefonia"
    },
    {
      "id": 123,
      "name": "Smartphones",
      "url": "/eletronicos/telefonia/smartphones"
    }
  ],
  "categoryBreadcrumb": [
    {
      "id": 100,
      "name": "Eletrônicos",
      "url": "/eletronicos"
    },
    {
      "id": 110,
      "name": "Telefonia",
      "url": "/eletronicos/telefonia"
    },
    {
      "id": 123,
      "name": "Smartphones",
      "url": "/eletronicos/telefonia/smartphones"
    }
  ],
  "dimensions": {
    "shippingCargoTypeId": 1,
    "additionalTime": 0,
    "width": 7.5,
    "height": 15.2,
    "length": 0.8,
    "weight": 185
  },
  "parentProductId": null,
  "combination": [1234],
  "currentAttributes": [
    {
      "id": 1,
      "name": "Cor",
      "value": {
        "id": 123,
        "label": "Azul",
        "image": null,
        "originalImage": null,
        "color": "007BFF",
        "order": 1
      }
    }
  ],
  "variations": {
    "valueList": [
      1234
    ],
    "combinations": [
      {
        "productId": 1234,
        "brandId": 1,
        "brandName": "TechPhone",
        "mainCategoryId": 123,
        "mainCategoryName": "Tecnologia",
        "type": "variation",
        "sku": "ABC123",
        "name": "Variation Phone",
        "active": true,
        "url": "nice-phone-url",
        "comparisonPrice": 1800,
        "stock": 21,
        "medias": [
          {
            "id": 123,
            "type": "image",
            "title": "Variation Phone Image",
            "alternativeText": null,
            "file": "https://cdn.loja.com.br/upload/media.webp",
            "originalFile": "https://cdn.loja.com.br/upload/media.png",
            "size": null,
            "originalSize": null,
            "width": null,
            "height": null,
            "url": null
          }
        ],
        "combination": [
          1, 2
        ],
        "currentAttributes": [
          {
            "id": 1,
            "name": "Cor",
            "value": {
              "id": 1,
              "label": "Azul",
              "image": null,
              "originalImage": null,
              "color": "007BFF",
              "order": 1
            }
          }
        ]
		  }
    ],
    "attributes": [
      {
        "id": 1,
        "name": "Cor",
        "displayName": "Cor",
        "includeSample": false,
        "values": [
          {
            "id": 1,
            "label": "Azul",
            "image": null,
            "originalImage": null,
            "color": "007BFF",
            "order": 1
          }
        ],
        "createdAt": "2025-07-23 22:50:28",
        "updatedAt": "2025-08-06 16:03:59"
      }
		]
  },
  "medias": [
    {
      "id": 1234,
      "type": "image",
      "title": "Imagem Principal",
      "alternativeText": "Smartphone XYZ Pro vista frontal",
      "file": "https://cdn.loja.com.br/products/smartphone-xyz-pro-01.jpg",
      "originalFile": "https://cdn.loja.com.br/products/smartphone-xyz-pro-01-original.jpg",
      "size": 245680,
      "originalSize": 1567890,
      "width": 800,
      "height": 800,
      "url": "https://cdn.loja.com.br/products/smartphone-xyz-pro-01.jpg"
    }
  ],
  "bannerGroups": [
    "banner 1",
    "banner 2",
    "banner 3"
  ],
  "status": "available",
  "createdAt": "2024-01-15 10:30:00",
  "updatedAt": "2024-10-01 15:45:00",
  "url": "/smartphone-xyz-pro-128gb",
  "urls": [
    {
      "tradePolicyId": 1,
      "url": "/smartphone-xyz-pro-128gb",
      "redirect": false,
      "redirectCode": null,
      "target": null,
      "createdAt": "2024-01-15 10:30:00",
      "updatedAt": "2024-01-15 10:30:00"
    }
  ],
  "linkedTradePolicies": [1, 2, 3],
  "description": {
    "id": 1234,
    "productId": 1234,
    "tradePolicyId": 1,
    "name": "Smartphone XYZ Pro 128GB",
    "shortDescription": "O mais avançado smartphone com 128GB de armazenamento",
    "description": "<p>Smartphone com processador octa-core, câmera tripla de 64MP e bateria de longa duração...</p>",
    "searchDescription": "smartphone xyz pro 128gb android camera 64mp bateria",
    "videoUrl": "https://youtube.com/watch?v=example",
    "customDescription1": null,
    "customDescription2": null,
    "customDescription3": null,
    "measureTable": null,
    "seoTitle": "Smartphone XYZ Pro 128GB - Compre Agora",
    "seoDescription": "Compre o Smartphone XYZ Pro com 128GB de armazenamento. Câmera 64MP, processador rápido e entrega rápida.",
    "seoKeywords": "smartphone, xyz pro, 128gb, android",
    "seoCanonical": "https://loja.com.br/smartphone-xyz-pro-128gb",
    "seoSocialTitle": "Smartphone XYZ Pro 128GB",
    "seoSocialDescription": "O melhor smartphone do mercado",
    "seoTwitterImageUrl": "https://cdn.loja.com.br/products/smartphone-xyz-pro-twitter.jpg",
    "seoGraphImageUrl": "https://cdn.loja.com.br/products/smartphone-xyz-pro-og.jpg",
    "seoGoogleCategoryId": 2895,
    "seoIndexOnGoogle": true,
    "seoGoogleCondition": "new",
    "seoGoogleAgeGroup": "adult",
    "seoGoogleGender": "unisex",
    "seoStructuredData": null
  }
}

⚠️ 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.

Começando

Store Theme

Customização de Interface

Consumo de Dados

Tracking e SEO

Checkout

Consumo de Dados

Tracking e SEO

Ambiente de Pagamento

Área Restrita (Minha Conta)

Consumo de Dados

Tracking e SEO

SDK Público (public-sdk)

Modules

Api

Tracking

API Pública

Área Restrita (Minha Conta)

Carrinho de Compras

API Privada

Apps

Configurações Gerais

Clientes

Template

Avaliações

Notificações

ERPs

Filas

Grupo de Pedidos

Pedidos

Carrinhos

Pagamentos

Anti-Fraude

Produtos

Inteligência Artificial

Marcas

Categorias

Filtros

Atributos

Url

Relatórios

Render

Fretes

Usuários

Promocionais

Marketplace

Third Party

Datalogic

Busca

MCP

Documentação de Produto

Visão Geral

Entidades Envolvidas

Notas e Considerações

Listagem de Produtos

Descrição

Parâmetros de Query

Headers Obrigatórios

Parâmetros de Metadados (meta)

Campos Disponíveis (fields)

Campos de Condição Disponíveis

Campos de Ordenação Disponíveis

Exemplo de Requisição

✅ Resposta de Sucesso

⚠️ Possíveis Erros

Erros de Validação (422)

Listagem de Produtos por política comercial

Descrição

Parâmetros

Headers Obrigatórios

Parâmetros de Metadados (meta)

Campos Disponíveis (fields)

Campos de Condição Disponíveis

Campos de Ordenação Disponíveis

Exemplo de Requisição

✅ Resposta de Sucesso

⚠️ Possíveis Erros

Erros de Validação (422)

Detalhes do Produto

Descrição