Buscar Entidade por URL
/publics/url
Busca produtos, categorias, marcas ou páginas através de uma URL amigável
Descrição
Endpoint responsável por retornar uma entidade (categoria, marca, página ou produto) a partir de uma URL amigável.
O objetivo é centralizar a busca das principais entidades da loja em um único ponto de acesso, facilitando a manutenção e padronizando o fluxo de resolução de URLs 🔎
Dessa forma, sempre que uma URL amigável for acessada, o sistema identifica automaticamente qual entidade ela representa e retorna as informações correspondentes.
Parâmetros de Query
Headers Obrigatórios
| Header | Valor | Descrição |
|---|---|---|
Content-Type | application/json | Tipo de conteúdo |
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 |
Parâmetros de Corpo
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| url | string | Sim | uri amigavel da página (slug) |
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 |
| 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 | Produtos filhos |
| restriction | Restrição de compra do produto (tradePolicyId, requiredAge) |
| availableCoupons | Retorna até 10 cupons aplicáveis ao produto |
Estrutura do field availableCoupons
Cada item do array representa um cupom aplicável ao produto. O nó discounts detalha as faixas de desconto:
1{2 "id": 15,3 "hash": "PROMO10",4 "discounts": [5 {6 "entityId": 15,7 "entity": "coupon",8 "itemAmount": 3,9 "value": 1010 }11 ],12 "createdAt": "2026-01-01 00:00:00",13 "updatedAt": "2026-01-01 00:00:00"14}| Campo | Tipo | Descrição |
|---|---|---|
id | integer | ID do cupom |
hash | string | Código do cupom (inserido pelo cliente no checkout) |
discounts[].entityId | integer | ID da entidade referenciada em entity |
discounts[].entity | string | Entidade que recebe o desconto |
discounts[].itemAmount | number | Quantidade mínima de itens para que o desconto em value seja aplicado |
discounts[].value | number | Valor do desconto aplicado quando itemAmount é atingido |
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 | Filtra listagem para produtos que podem ser exibidos no site (true/false) |
| saleWithoutStock | boolean | Filtra por produtos com venda sem estoque (true/false) |
| minimumStock | boolean | Filtra por produtos com estoque mínimo (true/false) |
| category | string | Categoria do produto |
| mainCategory | string | Categoria principal do produto |
| salePrice | decimal | Filtra produtos a partir do preço de venda (preço por: ) |
| comparisonPrice | decimal | Filtra produtos a partir do preço de comparação (preço de: ) |
| priceDifference | boolean | Filtra produtos comparando preço de venda e preço de comparação (true/false)/(iguais/diferentes) |
| filter | string | Busca produtos a partir dos filtros (Filtros esses exclusivos da loja e cadastrado pelo lojista) |
| stock | integer | Filtra produtos por estoque total |
| stockInStorage | integer | Busca produtos em estoque por armazém |
| productStorageId | integer | Filtra produtos id do armazém associado |
| name | string | Nome do produto |
| shortDescription | string | Filtra pelo descrição curta do produto |
| description | string | Filtra pelo descrição do produto |
| searchDescription | string | Filtra pelo descrição de busca do produto |
| seal | string | Filtra produtos a partir de selos associados |
| productAttributeId | integer | Filtra produtos a partir do id de um atributo do produto |
| productAttributeValueId | integer | Filtra produtos a partir do id de um valor de atributo do produto |
| customerWishListId | integer | Filtra produtos a partir do id de uma lista de desejos pública |
| exclusive | boolean | Filtra produtos exclusivos (true/false) |
| ean | string | Filtra produtos pelo EAN (Código de barras) |
| averageRating | decimal | Filtra produtos pela nota média de avaliação (2 casas decimais, ex.: 4.67). Prefira >=/<= ao = |
| quantityRating | integer | Filtra produtos pela quantidade de avaliação |
| childrenAmount | integer | Filtra produtos pela quantidade de produtos filhos |
| giftCard | integer | Filtra produtos pela quantidade de cartão presente |
| variationsQuantity | integer | Filtra produtos pela quantidade de variações |
| availableVariationsQuantity | integer | Filtra produtos pela quantidade de variações ativas |
Campos de Ordenação Disponíveis
| Campo | Descrição |
|---|---|
| id | ID da entidade |
| priority | Prioridade de exibição |
| type | Ordena por tipo do produto |
| sku | Ordena por sku |
| relevance | Ordena por relevância do produto |
| stock | Ordena produto por estoque |
| stockByStorage | Ordena produto em estoque por armazém |
| name | Nome do produto |
| price | Ordena produtos por preço |
| hasStock | Ordena produtos que possuem estoque |
Exemplo de Requisição
1curl --request GET \2 --url https://sua-loja-uappi.com.br/api/v3/publics/url \3 --data '{4 "url": "techbrand/smartphone",5 "fields": [6 "brand",7 "flags",8 "mainUrl",9 "secondaryUrls",10 "description",11 "indicatedProducts",12 "relatedProducts",13 "tax",14 "filters",15 "stockByStorage",16 "stock",17 "seals",18 "mainCategory",19 "categories",20 "categoryBreadcrumb",21 "dimension",22 "variation",23 "media",24 "price",25 "priceRules",26 "bannerGroups",27 "review",28 "status"29 ],30 "order": [31 ],32 "condition": {33 "type": "AND",34 "conditions": [35 ]36 },37 "meta": {38 "dimensions": {39 "size": "Meter",40 "weight": "Gram"41 },42 "priceParameters": {43 }44 }45 }'✅ Resposta de Entidade Tipo Produto
1{2 "type": "product",3 "entity": {4 "id": 44,5 "type": "product",6 "sku": "ABC123",7 "name": "TechBrand Smartphone",8 "priority": 1,9 "basePrice": 1199,10 "active": true,11 "review": null,12 "isGiftCard": false,13 "stock": null,14 "stocks": null,15 "originalPrice": null,16 "price": null,17 "priceRules": null,18 "brand": null,19 "flags": null,20 "tax": null,21 "indicatedProducts": null,22 "relatedProducts": null,23 "filters": null,24 "seals": null,25 "mainCategory": null,26 "categories": null,27 "categoryBreadcrumb": null,28 "dimensions": null,29 "parentProductId": null,30 "combination": [],31 "currentAttributes": null,32 "variations": null,33 "medias": null,34 "bannerGroups": [],35 "status": null,36 "createdAt": "2022-10-03 17:28:09",37 "updatedAt": "2025-09-23 01:31:32",38 "url": "",39 "urls": [],40 "linkedTradePolicies": null,41 "description": null42 }43 "menu": {44 "brands": [45 {46 "id": 10,47 "name": "TechBrand",48 "logo": "https://cdn.loja.com.br/brands/techbrand-logo.webp",49 "url":"/marca/techbrand",50 "productQuantity": 551 }52 ],53 "categories": [54 {55 "id": 123,56 "name": "Smartphones",57 "url": "tecnologia/smartphones",58 "productQuantity": 559 }60 ],61 "filters": [62 {63 "id": 123,64 "name": "Armazenamento:",65 "showInSpecificationTable": true,66 "values": {67 "0": {68 "id": 1234,69 "name": "120GB",70 "image": null,71 "originalImage": null,72 "color": null,73 "order": 0,74 "value": null,75 "productQuantity": 576 }77 },78 "productQuantity": 579 }80 ],81 "seals": [82 {83 "id":1234,84 "name":"Frete Grátis",85 "textColor":"#FFFFFF",86 "sealColor":"#00A650",87 "image":"https://cdn.loja.com.br/seals/frete-gratis.png",88 "productQuantity": 589 }90 ],91 "attributes": [92 {93 "id": 123,94 "name": "Cor",95 "displayName": "",96 "includeSample": false,97 "values": [98 {99 "id": 1234,100 "label": "Azul",101 "image": null,102 "originalImage": null,103 "color": "#007BFF",104 "order": 7,105 "productQuantity": 5106 }107 ],108 "productQuantity": 5,109 "createdAt": "2024-01-15 10:30:00",110 "updatedAt": "2024-01-15 10:30:00"111 }112 ],113 "prices": [114 {115 "min": 1,116 "max": 100117 },118 ]119 },120 "content": [121 "registers": [122 {123 "id": 44,124 "type": "product",125 "sku": "ABC123",126 "name": "TechBrand Smartphone",127 "priority": 1,128 "basePrice": 1199,129 "active": true,130 "review": null,131 "isGiftCard": false,132 "stock": null,133 "stocks": null,134 "originalPrice": null,135 "price": null,136 "priceRules": null,137 "brand": null,138 "flags": null,139 "tax": null,140 "indicatedProducts": null,141 "relatedProducts": null,142 "filters": null,143 "seals": null,144 "mainCategory": null,145 "categories": null,146 "categoryBreadcrumb": null,147 "dimensions": null,148 "parentProductId": null,149 "combination": [],150 "currentAttributes": null,151 "variations": null,152 "medias": null,153 "bannerGroups": [],154 "status": null,155 "createdAt": "2022-10-03 17:28:09",156 "updatedAt": "2025-09-23 01:31:32",157 "url": "",158 "urls": [],159 "linkedTradePolicies": null,160 "description": null161 }162 ]163 ],164 "pagination": {165 "limit": 10,166 "offset": 0,167 "pages": 1,168 "registers": 2169 }170}✅ Resposta de Entidade Tipo Categoria
1{2 "type": "category",3 "entity": { 4 "id": 1234,5 "parentProductCategoryId": null,6 "code": "category-code",7 "name": "Smartphones",8 "productOrdering": "",9 "active": true,10 "directAccess": true,11 "bannerGroups": [],12 "createdAt": "2025-07-25 12:28:03",13 "updatedAt": "2025-07-25 12:28:03",14 "tree": {15 "current": null,16 "children": [17 {18 "id": 1234,19 "name": "Telas",20 "url": "smartphones/telas"21 }22 ],23 "sisters": [],24 "parent": [25 {26 "id": 1234,27 "name": "Tecnologia",28 "url": "tecnologia"29 }30 ]31 },32 "filters": [],33 "url": "smartphones",34 "urls": [],35 "linkedTradePolicies": null,36 "description": {37 "id": 1234,38 "tradePolicyId": 1,39 "name": "smartphones",40 "shortDescription": "smartphones de todos os tipos",41 "videoUrl": "",42 "searchDescription": "Encontre os melhores smartphones!",43 "description": null,44 "customDescription1": null,45 "customDescription2": null,46 "customDescription3": null,47 "measureTable": null,48 "seoTitle": null,49 "seoDescription": null,50 "seoKeywords": "",51 "seoCanonical": "",52 "seoSocialTitle": "",53 "seoSocialDescription": null,54 "seoTwitterImageUrl": "",55 "seoGraphImageUrl": "",56 "seoGoogleCategoryId": 0,57 "seoIndexOnGoogle": false,58 "seoGoogleCondition": "",59 "seoGoogleAgeGroup": "",60 "seoGoogleGender": "",61 "seoStructuredData": null,62 "productId": null,63 "productCategoryId": 4,64 "productBrandId": null,65 "productPageId": null66 }67 },68 "menu": {69 "brands": [70 {71 "id": 10,72 "name": "TechBrand",73 "logo": "https://cdn.loja.com.br/brands/techbrand-logo.webp",74 "url":"/marca/techbrand",75 "productQuantity": 576 }77 ],78 "categories": [79 {80 "id": 123,81 "name": "Smartphones",82 "url": "tecnologia/smartphones",83 "productQuantity": 584 }85 ],86 "filters": [87 {88 "id": 123,89 "name": "Armazenamento:",90 "showInSpecificationTable": true,91 "values": [92 {93 "id": 1234,94 "name": "120GB",95 "image": null,96 "originalImage": null,97 "color": null,98 "order": 0,99 "value": null,100 "productQuantity": 5101 }102 ],103 "productQuantity": 5104 }105 ],106 "seals": [107 {108 "id":1234,109 "name":"Frete Grátis",110 "textColor":"#FFFFFF",111 "sealColor":"#00A650",112 "image":"https://cdn.loja.com.br/seals/frete-gratis.png",113 "productQuantity": 5114 }115 ],116 "attributes": [117 {118 "id": 123,119 "name": "Cor",120 "displayName": "",121 "includeSample": false,122 "values": [123 {124 "id": 1234,125 "label": "Azul",126 "image": null,127 "originalImage": null,128 "color": "#007BFF",129 "order": 7,130 "productQuantity": 5131 }132 ],133 "productQuantity": 5,134 "createdAt": "2024-01-15 10:30:00",135 "updatedAt": "2024-01-15 10:30:00"136 }137 ],138 "prices": [139 {140 "min": 1,141 "max": 100142 },143 ]144 },145 "content": [146 "registers": [147 {148 "id": 44,149 "type": "product",150 "sku": "ABC123",151 "name": "TechBrand Smartphone",152 "priority": 1,153 "basePrice": 1199,154 "active": true,155 "review": null,156 "isGiftCard": false,157 "stock": null,158 "stocks": null,159 "originalPrice": null,160 "price": null,161 "priceRules": null,162 "brand": null,163 "flags": null,164 "tax": null,165 "indicatedProducts": null,166 "relatedProducts": null,167 "filters": null,168 "seals": null,169 "mainCategory": null,170 "categories": null,171 "categoryBreadcrumb": null,172 "dimensions": null,173 "parentProductId": null,174 "combination": [],175 "currentAttributes": null,176 "variations": null,177 "medias": null,178 "bannerGroups": [],179 "status": null,180 "createdAt": "2022-10-03 17:28:09",181 "updatedAt": "2025-09-23 01:31:32",182 "url": "",183 "urls": [],184 "linkedTradePolicies": null,185 "description": null186 }187 ],188 "pagination": {189 "limit": 10,190 "offset": 0,191 "pages": 1,192 "registers": 2193 }194 ]195}✅ Resposta de Entidade Tipo Marca
1{2 "type": "brand",3 "entity": { 4 "id": 1234,5 "code": "marca-techbrand",6 "name": "TechBrand",7 "logo": "https://cdn.loja.com.br/brands/techbrand-xyz-pro-01.webp",8 "originalLogo": "https://cdn.loja.com.br/brands/techbrand-xyz-pro-01.jpg",9 "productOrdering": "",10 "active": true,11 "bannerGroups": [],12 "createdAt": "2025-07-25 12:28:36",13 "updatedAt": "2025-07-25 14:26:33",14 "url": "techbrand",15 "urls": [],16 "linkedTradePolicies": null,17 "description": {18 "id": 1234,19 "tradePolicyId": 1,20 "name": "TechBrand",21 "shortDescription": "Descrição da marca TechBrand",22 "videoUrl": "",23 "searchDescription": null,24 "description": null,25 "customDescription1": null,26 "customDescription2": null,27 "customDescription3": null,28 "measureTable": null,29 "seoTitle": "",30 "seoDescription": null,31 "seoKeywords": "",32 "seoCanonical": "",33 "seoSocialTitle": "",34 "seoSocialDescription": null,35 "seoTwitterImageUrl": "",36 "seoGraphImageUrl": "",37 "seoGoogleCategoryId": 0,38 "seoIndexOnGoogle": false,39 "seoGoogleCondition": "",40 "seoGoogleAgeGroup": "",41 "seoGoogleGender": "",42 "seoStructuredData": null,43 "productId": null,44 "productCategoryId": null,45 "productBrandId": 1234,46 "productPageId": null47 }48 },49 "menu": {50 "brands": [51 {52 "id": 10,53 "name": "TechBrand",54 "logo": "https://cdn.loja.com.br/brands/techbrand-logo.webp",55 "url":"/marca/techbrand",56 "productQuantity": 557 }58 ],59 "categories": [60 {61 "id": 123,62 "name": "Smartphones",63 "url": "tecnologia/smartphones",64 "productQuantity": 565 }66 ],67 "filters": [68 {69 "id": 123,70 "name": "Armazenamento:",71 "showInSpecificationTable": true,72 "values": [73 {74 "id": 1234,75 "name": "120GB",76 "image": null,77 "originalImage": null,78 "color": null,79 "order": 0,80 "value": null,81 "productQuantity": 582 }83 ],84 "productQuantity": 585 }86 ],87 "seals": [88 {89 "id":1234,90 "name":"Frete Grátis",91 "textColor":"#FFFFFF",92 "sealColor":"#00A650",93 "image":"https://cdn.loja.com.br/seals/frete-gratis.png",94 "productQuantity": 595 }96 ],97 "attributes": [98 {99 "id": 123,100 "name": "Cor",101 "displayName": "",102 "includeSample": false,103 "values": [104 {105 "id": 1234,106 "label": "Azul",107 "image": null,108 "originalImage": null,109 "color": "#007BFF",110 "order": 7,111 "productQuantity": 5112 }113 ],114 "productQuantity": 5,115 "createdAt": "2024-01-15 10:30:00",116 "updatedAt": "2024-01-15 10:30:00"117 }118 ],119 "prices": [120 {121 "min": 1,122 "max": 100123 },124 ]125 },126 "content": [127 "registers": [128 {129 "id": 44,130 "type": "product",131 "sku": "ABC123",132 "name": "TechBrand Smartphone",133 "priority": 1,134 "basePrice": 1199,135 "active": true,136 "review": null,137 "isGiftCard": false,138 "stock": null,139 "stocks": null,140 "originalPrice": null,141 "price": null,142 "priceRules": null,143 "brand": null,144 "flags": null,145 "tax": null,146 "indicatedProducts": null,147 "relatedProducts": null,148 "filters": null,149 "seals": null,150 "mainCategory": null,151 "categories": null,152 "categoryBreadcrumb": null,153 "dimensions": null,154 "parentProductId": null,155 "combination": [],156 "currentAttributes": null,157 "variations": null,158 "medias": null,159 "bannerGroups": [],160 "status": null,161 "createdAt": "2022-10-03 17:28:09",162 "updatedAt": "2025-09-23 01:31:32",163 "url": "",164 "urls": [],165 "linkedTradePolicies": null,166 "description": null167 }168 ],169 "pagination": {170 "limit": 10,171 "offset": 0,172 "pages": 1,173 "registers": 2174 }175 ]176}✅ Resposta de Entidade Tipo Página
1{2 "type": "page",3 "entity": { 4 "id": 1234,5 "code": "sobre-nos",6 "name": "sobre nos",7 "active": true,8 "bannerGroups": [],9 "createdAt": "2025-08-06 16:33:03",10 "updatedAt": "2025-08-06 16:33:03",11 "url": "pagina/sobre-nos",12 "urls": [],13 "linkedTradePolicies": null,14 "description": {15 "id": 1234,16 "tradePolicyId": 1,17 "name": "Sobre Nos | Loja",18 "shortDescription": "Somos Techbrand...",19 "videoUrl": "",20 "searchDescription": "<p> Techbrand é uma marca... </p>",21 "description": "",22 "customDescription1": null,23 "customDescription2": null,24 "customDescription3": null,25 "measureTable": null,26 "seoTitle": "",27 "seoDescription": null,28 "seoKeywords": "",29 "seoCanonical": "",30 "seoSocialTitle": "",31 "seoSocialDescription": null,32 "seoTwitterImageUrl": "",33 "seoGraphImageUrl": "",34 "seoGoogleCategoryId": 0,35 "seoIndexOnGoogle": false,36 "seoGoogleCondition": "",37 "seoGoogleAgeGroup": "",38 "seoGoogleGender": "",39 "seoStructuredData": null,40 "productId": null,41 "productCategoryId": null,42 "productBrandId": null,43 "productPageId": 123444 }45 },46 "menu": null,47 "content": []48}Buscar o tipo da entidade por URL
/publics/url/verify
Endpoint responsável por retornar o tipo da entidade (categoria, marca, página ou produto) a partir de uma URL amigável.
Descrição
Endpoint responsável por retornar o tipo da entidade (categoria, marca, página ou produto) a partir de uma URL amigável.
O objetivo é retornar a tipagem da entidade vinculada a url. 🔎
Parâmetros de Query
Headers Obrigatórios
| Header | Valor | Descrição |
|---|---|---|
Content-Type | application/json | Tipo de conteúdo |
Parâmetros de Corpo
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| url | string | Sim | uri amigavel da página (slug) |
1curl --request GET \2 --url {{MAIN_URL}}/publics/url/verify \3 --data '{4 "url": "/sapatos"5 }'✅ Resposta de Entidade Tipo Produto
1{2 "type": "brand|category|page|product|redirect"3}Detalhe da Lista de Desejo
/publics/wish-list/{uriCode}
Retorna detalhes de uma lista de desejo compartilhada por código URI
Descrição
Endpoint responsável por listar os itens de uma lista de desejo compartilhada.
O cliente define a lista como compartilhada, e o backend gera automaticamente um código único de identificação 🔐
A partir desse código, este endpoint permite localizar e retornar a lista via URL, garantindo acesso simples e direto ao conteúdo compartilhado.
Parâmetros de Query
Parâmetros da URL
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| uriCode | string | Sim | Código URI único da lista de desejo compartilhada |
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 |
| 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 | Produtos filhos |
| restriction | Restrição de compra do produto (tradePolicyId, requiredAge) |
| availableCoupons | Retorna até 10 cupons aplicáveis ao produto |
Estrutura do field availableCoupons
Cada item do array representa um cupom aplicável ao produto. O nó discounts detalha as faixas de desconto:
1{2 "id": 15,3 "hash": "PROMO10",4 "discounts": [5 {6 "entityId": 15,7 "entity": "coupon",8 "itemAmount": 3,9 "value": 1010 }11 ],12 "createdAt": "2026-01-01 00:00:00",13 "updatedAt": "2026-01-01 00:00:00"14}| Campo | Tipo | Descrição |
|---|---|---|
id | integer | ID do cupom |
hash | string | Código do cupom (inserido pelo cliente no checkout) |
discounts[].entityId | integer | ID da entidade referenciada em entity |
discounts[].entity | string | Entidade que recebe o desconto |
discounts[].itemAmount | number | Quantidade mínima de itens para que o desconto em value seja aplicado |
discounts[].value | number | Valor do desconto aplicado quando itemAmount é atingido |
Exemplo de Requisição
1curl --request GET \2 --url {{MAIN_URL}}/publics/wish-list/{uriCode} \✅ Resposta de Sucesso
1{2 "type": "wish-list",3 "entity": {4 "customerId": 1234,5 "name": "Lista de trabalho",6 "shareList": true,7 "default": false,8 "id": 1234,9 "uriCode": "z69VMQ23qG",10 "createdAt": "2025-04-04 14:54:06"11 },12 "menu": {13 "brands": [14 {15 "id": 10,16 "name": "TechBrand",17 "logo": "https://cdn.loja.com.br/brands/techbrand-logo.webp",18 "url":"/marca/techbrand",19 "productQuantity": 620 }21 ],22 "categories": [23 {24 "id": 123,25 "name": "Smartphones",26 "url": "tecnologia/smartphones",27 "productQuantity": 828 }29 ],30 "filters": [31 {32 "id": 123,33 "name": "Armazenamento:",34 "showInSpecificationTable": true,35 "values": {36 "0": {37 "id": 1234,38 "name": "120GB",39 "image": null,40 "originalImage": null,41 "color": null,42 "order": 0,43 "value": null,44 "productQuantity": 1045 }46 },47 "productQuantity": 1048 }49 ],50 "seals": [51 {52 "id":1234,53 "name":"Frete Grátis",54 "textColor":"#FFFFFF",55 "sealColor":"#00A650",56 "image":"https://cdn.loja.com.br/seals/frete-gratis.png",57 "productQuantity": 1158 }59 ],60 "attributes": [61 {62 "id": 123,63 "name": "Cor",64 "displayName": "",65 "includeSample": false,66 "values": [67 {68 "id": 1234,69 "label": "Azul",70 "image": null,71 "originalImage": null,72 "color": "#007BFF",73 "order": 7,74 "productQuantity": 575 }76 ],77 "productQuantity": 5,78 "createdAt": "2024-01-15 10:30:00",79 "updatedAt": "2024-01-15 10:30:00"80 }81 ],82 "prices": [83 {84 "min": 1,85 "max": 10086 },87 ]88 },89 "content": [90 "registers": [91 {92 "id": 1234,93 "type": "product",94 "sku": "SMPH001",95 "name": "Smartphone XYZ Pro 128GB",96 "priority": 100,97 "basePrice": 1199.90,98 "active": true,99 "review": {100 "productId": 1234,101 "averageRating": 4.67,102 "quantityRating": 328103 },104 "isGiftCard": false,105 "stock": {106 "productId": 1234,107 "productStorageId": 1,108 "availableStock": 15,109 "reservedStock": 2,110 "updatedAt": "2024-10-01 14:30:00"111 },112 "stocks": [113 {114 "productId": 1234,115 "productStorageId": 1,116 "availableStock": 15,117 "reservedStock": 2,118 "updatedAt": "2024-10-01 14:30:00"119 },120 {121 "productId": 1234,122 "productStorageId": 2,123 "availableStock": 8,124 "reservedStock": 1,125 "updatedAt": "2024-10-01 14:30:00"126 }127 ],128 "originalPrice": {129 "comparisonPrice": 0,130 "salePrice": 0,131 "markup": 0,132 "ruleId": 0,133 "ruleTrigger": "original",134 "ruleName": "Original",135 "availableForSale": true,136 "basePrice": false,137 "priceWithDiscount": 0,138 "installments": [],139 "scheduling": null140 },141 "price": {142 "comparisonPrice": 1499.90,143 "salePrice": 1199.90,144 "markup": 25.02,145 "ruleId": 15,146 "ruleTrigger": "original",147 "ruleName": "Original",148 "availableForSale": true,149 "basePrice": false,150 "priceWithDiscount": 1199.90,151 "installments": [152 {153 "installment": 1,154 "installmentValue": 1199.90,155 "totalValue": 1199.90,156 "fee": null,157 "feeTotalValue": 0158 },159 {160 "installment": 2,161 "installmentValue": 599.95,162 "totalValue": 1199.90,163 "fee": null,164 "feeTotalValue": 0165 },166 {167 "installment": 12,168 "installmentValue": 99.99,169 "totalValue": 1199.88,170 "fee": null,171 "feeTotalValue": 0172 }173 ],174 "scheduling": {175 "id": 46,176 "startDate": "2026-02-07 09:00:00",177 "endDate": "2026-10-30 23:59:59"178 }179 },180 "priceRules": null,181 "brand": {182 "id": 45,183 "code": "TECH",184 "name": "TechBrand",185 "logo": "https://cdn.loja.com.br/brands/techbrand-logo.jpg",186 "originalLogo": "https://cdn.loja.com.br/brands/techbrand-logo-original.jpg",187 "productOrdering": "name_asc",188 "active": true,189 "bannerGroups": [],190 "createdAt": "2023-10-04 19:11:08",191 "updatedAt": "2025-08-20 12:41:03",192 "url": "/marca/techbrand"193 },194 "flags": {195 "subscription": false,196 "service": false,197 "showInSite": true,198 "saleWithoutStock": false,199 "minimumStock": 5200 },201 "tax": {202 "mpn": "MPN123456",203 "ean": "7891234567890",204 "ncm": "85171231",205 "exclusive": false206 },207 "indicatedProducts": [208 {209 "id": 1234,210 "brandId": 1234,211 "brandName": "TopPhone",212 "mainCategoryId": 1,213 "mainCategoryName": "smartphone",214 "type": "product",215 "name": "Smartphone XYZ Pro 128GB",216 "sku": "SMPH001",217 "url": "/smartphone-xyz-pro-128gb",218 "comparisonPrice":2199.99,219 "stock":20,220 "medias":[221 {222 "id": 123,223 "type": "image",224 "title": "",225 "alternativeText": null,226 "file": "https://cdn.loja.com.br/upload/media/produto-media.webp",227 "originalFile": "https://cdn.loja.com.br/upload/media/produto-media.png",228 "size": null,229 "originalSize": null,230 "width": null,231 "height": null,232 "url": null233 }234 ],235 "combination":[1, 2, 3],236 "currentAttributes":[237 {238 "id":123,239 "name":"cor",240 "value":{241 "id":123,242 "label":"azul-escuro",243 "image":null,244 "originalImage":null,245 "color":"#00008B",246 "order":1247 }248 }249 ],250 "active": true251 }252 ],253 "relatedProducts": [254 {255 "id": 1234,256 "brandId": 1234,257 "brandName": "TopPhone",258 "mainCategoryId": 1,259 "mainCategoryName": "smartphone",260 "type": "product",261 "name": "Smartphone XYZ Pro 128GB",262 "sku": "SMPH001",263 "url": "/smartphone-xyz-pro-128gb",264 "comparisonPrice":2199.99,265 "stock":20,266 "medias":[267 {268 "id": 123,269 "type": "image",270 "title": "",271 "alternativeText": null,272 "file": "https://cdn.loja.com.br/upload/media/produto-media.webp",273 "originalFile": "https://cdn.loja.com.br/upload/media/produto-media.png",274 "size": null,275 "originalSize": null,276 "width": null,277 "height": null,278 "url": null279 }280 ],281 "combination":[1, 2, 3],282 "currentAttributes":[283 {284 "id":123,285 "name":"cor",286 "value":{287 "id":123,288 "label":"azul-escuro",289 "image":null,290 "originalImage":null,291 "color":"#00008B",292 "order":1293 }294 }295 ],296 "active": true297 }298 ],299 "filters": [300 {301 "id": 123,302 "productCategoryId": 1234,303 "name": "Marca",304 "active": true,305 "showInListing": true,306 "showInSpecificationTable": false,307 "type": "enum",308 "createdAt": "2025-01-14 10:31:00",309 "values": [310 {311 "id": 123,312 "name": "TechPhone",313 "image": null,314 "originalImage": null,315 "color": null,316 "order": 1,317 "value": null318 },319 {320 "id": 124,321 "name": "SmartScreen",322 "image": null,323 "originalImage": null,324 "color": null,325 "order": 1,326 "value": null327 }328 ]329 }330 ],331 "seals": [332 {333 "id": 5,334 "name": "Frete Grátis",335 "active": true,336 "textColor": "#FFFFFF",337 "sealColor": "#00A650",338 "image": "https://cdn.loja.com.br/seals/frete-gratis.png",339 "originalImage": "https://cdn.loja.com.br/seals/frete-gratis-original.png",340 "setting":{341 "id": 1234,342 "horizontalPosition": "left",343 "verticalPosition": "top",344 "proportionInProductDetail": 300,345 "proportionInProductShowcase": 300,346 "scheduling": {347 "id": 1234,348 "startDate": "2024-01-15 10:30:00",349 "endDate": "2024-01-30 10:30:00"350 }351 },352 "promotionLinkId":15,353 "createdAt":"2024-01-15 10:30:00",354 "updatedAt":"2024-01-15 10:30:00"355 }356 ],357 "mainCategory": {358 "id": 123,359 "name": "Smartphones",360 "url": "/smartphones"361 },362 "categories": [363 {364 "id": 100,365 "name": "Eletrônicos",366 "url": "/eletronicos"367 },368 {369 "id": 110,370 "name": "Telefonia",371 "url": "/eletronicos/telefonia"372 },373 {374 "id": 123,375 "name": "Smartphones",376 "url": "/eletronicos/telefonia/smartphones"377 }378 ],379 "categoryBreadcrumb": [380 {381 "id": 100,382 "name": "Eletrônicos",383 "url": "/eletronicos"384 },385 {386 "id": 110,387 "name": "Telefonia",388 "url": "/eletronicos/telefonia"389 },390 {391 "id": 123,392 "name": "Smartphones",393 "url": "/eletronicos/telefonia/smartphones"394 }395 ],396 "dimensions": {397 "shippingCargoTypeId": 1,398 "additionalTime": 0,399 "width": 7.5,400 "height": 15.2,401 "length": 0.8,402 "weight": 185403 },404 "parentProductId": null,405 "combination": [1234],406 "currentAttributes": [407 {408 "id": 1,409 "name": "Cor",410 "value": {411 "id": 123,412 "label": "Azul",413 "image": null,414 "originalImage": null,415 "color": "007BFF",416 "order": 1417 }418 }419 ],420 "variations": {421 "valueList": [422 1234423 ],424 "combinations": [425 {426 "productId": 1234,427 "brandId": 1,428 "brandName": "TechPhone",429 "mainCategoryId": 123,430 "mainCategoryName": "Tecnologia",431 "type": "variation",432 "sku": "ABC123",433 "name": "Variation Phone",434 "active": true,435 "url": "nice-phone-url",436 "comparisonPrice": 1800,437 "stock": 21,438 "medias": [439 {440 "id": 123,441 "type": "image",442 "title": "Variation Phone Image",443 "alternativeText": null,444 "file": "https://cdn.loja.com.br/upload/media.webp",445 "originalFile": "https://cdn.loja.com.br/upload/media.png",446 "size": null,447 "originalSize": null,448 "width": null,449 "height": null,450 "url": null451 }452 ],453 "combination": [454 1, 2455 ],456 "currentAttributes": [457 {458 "id": 1,459 "name": "Cor",460 "value": {461 "id": 1,462 "label": "Azul",463 "image": null,464 "originalImage": null,465 "color": "007BFF",466 "order": 1467 }468 }469 ]470 }471 ],472 "attributes": [473 {474 "id": 1,475 "name": "Cor",476 "displayName": "Cor",477 "includeSample": false,478 "values": [479 {480 "id": 1,481 "label": "Azul",482 "image": null,483 "originalImage": null,484 "color": "007BFF",485 "order": 1486 }487 ],488 "createdAt": "2025-07-23 22:50:28",489 "updatedAt": "2025-08-06 16:03:59"490 }491 ]492 },493 "medias": [494 {495 "id": 1234,496 "type": "image",497 "title": "Imagem Principal",498 "alternativeText": "Smartphone XYZ Pro vista frontal",499 "file": "https://cdn.loja.com.br/products/smartphone-xyz-pro-01.jpg",500 "originalFile": "https://cdn.loja.com.br/products/smartphone-xyz-pro-01-original.jpg",501 "size": 245680,502 "originalSize": 1567890,503 "width": 800,504 "height": 800,505 "url": "https://cdn.loja.com.br/products/smartphone-xyz-pro-01.jpg"506 }507 ],508 "bannerGroups": [509 "banner 1",510 "banner 2",511 "banner 3"512 ],513 "status": "available",514 "createdAt": "2024-01-15 10:30:00",515 "updatedAt": "2024-10-01 15:45:00",516 "url": "/smartphone-xyz-pro-128gb",517 "urls": [518 {519 "tradePolicyId": 1,520 "url": "/smartphone-xyz-pro-128gb",521 "redirect": false,522 "redirectCode": null,523 "target": null,524 "createdAt": "2024-01-15T10:30:00Z",525 "updatedAt": "2024-01-15T10:30:00Z"526 }527 ],528 "linkedTradePolicies": [1, 2, 3],529 "description": {530 "id": 1234,531 "productId": 1234,532 "tradePolicyId": 1,533 "name": "Smartphone XYZ Pro 128GB",534 "shortDescription": "O mais avançado smartphone com 128GB de armazenamento",535 "description": "<p>Smartphone com processador octa-core, câmera tripla de 64MP e bateria de longa duração...</p>",536 "searchDescription": "smartphone xyz pro 128gb android camera 64mp bateria",537 "videoUrl": "https://youtube.com/watch?v=example",538 "customDescription1": null,539 "customDescription2": null,540 "customDescription3": null,541 "measureTable": null,542 "seoTitle": "Smartphone XYZ Pro 128GB - Compre Agora",543 "seoDescription": "Compre o Smartphone XYZ Pro com 128GB de armazenamento. Câmera 64MP, processador rápido e entrega rápida.",544 "seoKeywords": "smartphone, xyz pro, 128gb, android",545 "seoCanonical": "https://loja.com.br/smartphone-xyz-pro-128gb",546 "seoSocialTitle": "Smartphone XYZ Pro 128GB",547 "seoSocialDescription": "O melhor smartphone do mercado",548 "seoTwitterImageUrl": "https://cdn.loja.com.br/products/smartphone-xyz-pro-twitter.jpg",549 "seoGraphImageUrl": "https://cdn.loja.com.br/products/smartphone-xyz-pro-og.jpg",550 "seoGoogleCategoryId": 2895,551 "seoIndexOnGoogle": true,552 "seoGoogleCondition": "new",553 "seoGoogleAgeGroup": "adult",554 "seoGoogleGender": "unisex",555 "seoStructuredData": null556 }557 }558 ]559 ],560 "pagination": {561 "limit": 10,562 "offset": 0,563 "pages": 1,564 "registers": 2565 }566}⚠️ Possíveis erros:
Atenção: a seguir estão destacados os principais erros que podem ocorrer neste endpoint.
Os cenários descritos representam os erros mais relevantes do contexto atual, servindo como referência para entendimento e tratamento das falhas.
| Código Interno | Código Http | Descrição |
|---|---|---|
| UAPPI_STORE_WISH_LIST_NOT_FOUND | 404 | A lista de desejos solicitada não foi encontrada. |