{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/schema.json","name":"Yampi Developer Portal","colors":{"primary":"#A85DEE","light":"#A85DEE","dark":"#A85DEE"},"logo":{"light":"https://mintcdn.com/yampi/qWYSl0wcm4MZ24_i/logo/yampi-positive.svg?fit=max\u0026auto=format\u0026n=qWYSl0wcm4MZ24_i\u0026q=85\u0026s=b43bef13c1cf7b7b161da2768346b8d0","dark":"https://mintcdn.com/yampi/qWYSl0wcm4MZ24_i/logo/yampi-negative.svg?fit=max\u0026auto=format\u0026n=qWYSl0wcm4MZ24_i\u0026q=85\u0026s=0da82b74f099723c9357969ef64ef67d"},"favicon":"https://mintcdn.com/yampi/u1tE3DqzZQgOcuhV/logo/favicon.png?fit=max\u0026auto=format\u0026n=u1tE3DqzZQgOcuhV\u0026q=85\u0026s=3974028237f6fca523b0f7c66e5a38bc","api":{},"appearance":{"default":"dark"},"background":{"decoration":"grid"},"navbar":{"primary":{"type":"button","label":"Portal de parceiros","href":"https://partners.yampi.com.br/login"}},"footer":{"socials":{"instagram":"https://instagram.com/yampibr","github":"https://github.com/somosyampi","linkedin":"https://www.linkedin.com/company/yampibr"}},"styling":{"codeblocks":"system","latex":true},"markdown":{"instructions":"A API da Yampi suporta dois modos de autenticação, mutuamente exclusivos, escolhidos conforme o tipo de integração:\n\n1. Usuário padrão: headers `User-Token` + `User-Secret-Key`, acesso completo à conta do próprio usuário. Uso: integrações pessoais ou internas. Ver auth/auth-user-token.\n2. App para Loja de Aplicativos: OAuth 2.0 com escopos granulares (Access Token de 10 min + Refresh Token de 30 dias). Obrigatório para apps publicados na Loja de Aplicativos da Yampi. Requer registro no Painel de Parceiros (partners.yampi.com.br) e definição de permissões. Ver auth/oauth e apps/criacao-e-configuracao/permissoes-de-um-aplicativo.\n\nAo recomendar uma integração, use o modo 1 para uso pessoal/interno e o modo 2 para apps distribuídos na Loja de Aplicativos."},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"yampi","hasAudioNarration":false,"actualSubdomain":"yampi","customDomains":["docs.yampi.com.br"],"gitSource":{"type":"github","owner":"somosyampi","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adfb8983f8a897774aeba1a","collectionId":"3f9869c5-6248-4eb8-8b34-469511d8adb0","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adfb8983f8a897774aeba1a"},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adfb8983f8a897774aeba1a","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"Referência da API","count":926},{"language":"default","tag":"Catálogo","count":155},{"language":"default","tag":"Editor de código","count":114},{"language":"default","tag":"Tema Rocket","count":102},{"language":"default","tag":"Componentes","count":73},{"language":"default","tag":"Promoções","count":49},{"language":"default","tag":"Pedidos","count":39},{"language":"default","tag":"Logística","count":37},{"language":"default","tag":"Checkout","count":35},{"language":"default","tag":"Público","count":28}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#navbar img[src*=\"/logo/yampi-negative.svg\"],#navbar img[src*=\"/logo/yampi-positive.svg\"]{height:20px}"}],"page":{"pagePath":"api-reference/descontos/listar-descontos-da-loja","slug":"/api-reference/descontos/listar-descontos-da-loja","pageMetadata":{"openapi":"get /{alias}/discounts","title":"Listar descontos da loja","description":"Lista os descontos cadastrados na loja","href":"/api-reference/descontos/listar-descontos-da-loja"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Lista os descontos cadastrados na loja\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":"system","config":{},"pageMetadata":{"openapi":"get /{alias}/discounts","title":"Listar descontos da loja","description":"Lista os descontos cadastrados na loja","href":"/api-reference/descontos/listar-descontos-da-loja"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/yampi/0e69280caad08c33/scripts/mappingXFolderProp.js","/_mintlify/custom/yampi/46d583a1fe390c5d/scripts/generateLlmsTxt.js"],"openApiReferenceData":{"operation":{"tags":["Descontos"],"summary":"Listar descontos da loja","description":"Lista os descontos cadastrados na loja","operationId":"GetDiscounts","parameters":["06412bb7-3713-4a97-a86a-c4bfa3f9a263","edc432e0-e8d5-4f11-8a19-9b3a922460ce","3695ac44-2572-46c4-8152-fc679098026f","c399b01e-7f4f-4189-b933-24d459b9a130"],"responses":{"200":"20e1494f-79d0-41c7-95ee-4fa87c1f5e1a","400":"736c46ee-b16d-4af8-8672-3fa8b028049d"},"method":"get","type":"path","servers":["1344bf83-54a9-44e6-affe-b1f1f24edc3b"],"security":["a250527c-7361-42af-b49a-beeb30cc372c"],"path":"/{alias}/discounts","baseUrlOptions":["https://api.dooki.com.br/v2"],"title":"Listar descontos da loja","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"06412bb7-3713-4a97-a86a-c4bfa3f9a263":{"name":"alias","in":"path","description":"Alias da loja","required":true,"schema":{"type":"string","isRequired":true,"description":"Alias da loja","uniqueKey":"","typeLabel":"string"}},"edc432e0-e8d5-4f11-8a19-9b3a922460ce":{"name":"q","in":"query","description":"Busca por nome do desconto","required":false,"schema":{"type":"string","isRequired":false,"description":"Busca por nome do desconto","uniqueKey":"","typeLabel":"string"}},"3695ac44-2572-46c4-8152-fc679098026f":{"name":"discount_type","in":"query","description":"Filtrar por tipo de desconto (aceita múltiplos valores)","required":false,"schema":{"type":"array","items":{"type":"string","enum":["buy_x_get_y","by_payment_method","buy_x_pay_y"],"uniqueKey":"items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":false,"description":"Filtrar por tipo de desconto (aceita múltiplos valores)","uniqueKey":"","typeLabel":"enum\u003cstring>[]"}},"c399b01e-7f4f-4189-b933-24d459b9a130":{"name":"status","in":"query","description":"Filtrar por status: 1 = ativos (end_at >= agora ou sem data), 0 = expirados","required":false,"schema":{"type":"integer","enum":[0,1],"isRequired":false,"description":"Filtrar por status: 1 = ativos (end_at >= agora ou sem data), 0 = expirados","uniqueKey":"","typeLabel":"enum\u003cinteger>"}}},"responses":{"20e1494f-79d0-41c7-95ee-4fa87c1f5e1a":{"description":"Lista de descontos","content":{"application/json":{"schema":{"properties":{"data":{"description":"Detalhes dos descontos","type":"array","items":{"type":"object","title":"SimplePaginatorWithMeta","description":"Representa uma paginação com meta","properties":{"id":{"description":"ID do desconto.","type":"integer","example":1520,"uniqueKey":"data.items.[INDEX].id","typeLabel":"integer"},"store_id":{"description":"ID da loja.","type":"integer","example":1319250,"uniqueKey":"data.items.[INDEX].store_id","typeLabel":"integer"},"discount_type_id":{"description":"ID do registro de configuração do tipo de desconto, detalhado em `specifications`.","type":"integer","example":1520,"uniqueKey":"data.items.[INDEX].discount_type_id","typeLabel":"integer"},"name":{"description":"Nome do desconto.","type":"string","example":"Lucas","uniqueKey":"data.items.[INDEX].name","typeLabel":"string"},"entry_condition_type":{"description":"Tipo de condição para aplicar o desconto: `amount` para valor da compra e `quantity` para quantidade de itens.","type":"string","example":"amount","uniqueKey":"data.items.[INDEX].entry_condition_type","typeLabel":"string"},"entry_condition_value":{"description":"Valor mínimo (quantidade de produto ou valor do carrinho) necessário para ativar o desconto. Devolvido como inteiro quando `entry_condition_type` for `quantity`.","type":"number","example":10,"uniqueKey":"data.items.[INDEX].entry_condition_value","typeLabel":"number"},"discount_method":{"description":"Método de desconto: `percent` para percentual e `amount` para valor em reais.","type":"string","example":"percent","uniqueKey":"data.items.[INDEX].discount_method","typeLabel":"string"},"discount_value":{"description":"Valor do desconto. Se percentual, o máximo é 100.","type":"number","example":100,"uniqueKey":"data.items.[INDEX].discount_value","typeLabel":"number"},"discount_type":{"description":"Tipo do desconto: `buy_x_get_y`, `by_payment_method` ou `buy_x_pay_y`.","type":"string","example":"buy_x_get_y","uniqueKey":"data.items.[INDEX].discount_type","typeLabel":"string"},"accumulate":{"description":"Define se o desconto pode acumular com outras promoções.","type":"boolean","example":false,"uniqueKey":"data.items.[INDEX].accumulate","typeLabel":"boolean"},"start_at":{"description":"Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada.","properties":{"date":{"description":"Data e hora no formato YYYY-MM-DD H:MM:SS.","type":"string","example":"2000-08-17 10:24:24","uniqueKey":"data.items.[INDEX].start_at.date","typeLabel":"string"},"timezone_type":{"description":"Número de representação do timezone.","type":"integer","example":3,"uniqueKey":"data.items.[INDEX].start_at.timezone_type","typeLabel":"integer"},"timezone":{"description":"Fuso horário associado.","type":"string","example":"America/Sao_Paulo","uniqueKey":"data.items.[INDEX].start_at.timezone","typeLabel":"string"}},"type":"object","uniqueKey":"data.items.[INDEX].start_at","typeLabel":"object"},"end_at":{"description":"Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada.","properties":{"date":{"description":"Data e hora no formato YYYY-MM-DD H:MM:SS.","type":"string","example":"2000-08-17 10:24:24","uniqueKey":"data.items.[INDEX].end_at.date","typeLabel":"string"},"timezone_type":{"description":"Número de representação do timezone.","type":"integer","example":3,"uniqueKey":"data.items.[INDEX].end_at.timezone_type","typeLabel":"integer"},"timezone":{"description":"Fuso horário associado.","type":"string","example":"America/Sao_Paulo","uniqueKey":"data.items.[INDEX].end_at.timezone","typeLabel":"string"}},"type":"object","uniqueKey":"data.items.[INDEX].end_at","typeLabel":"object"},"created_at":{"description":"Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada.","properties":{"date":{"description":"Data e hora no formato YYYY-MM-DD H:MM:SS.","type":"string","example":"2000-08-17 10:24:24","uniqueKey":"data.items.[INDEX].created_at.date","typeLabel":"string"},"timezone_type":{"description":"Número de representação do timezone.","type":"integer","example":3,"uniqueKey":"data.items.[INDEX].created_at.timezone_type","typeLabel":"integer"},"timezone":{"description":"Fuso horário associado.","type":"string","example":"America/Sao_Paulo","uniqueKey":"data.items.[INDEX].created_at.timezone","typeLabel":"string"}},"type":"object","uniqueKey":"data.items.[INDEX].created_at","typeLabel":"object"},"updated_at":{"description":"Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada.","properties":{"date":{"description":"Data e hora no formato YYYY-MM-DD H:MM:SS.","type":"string","example":"2000-08-17 10:24:24","uniqueKey":"data.items.[INDEX].updated_at.date","typeLabel":"string"},"timezone_type":{"description":"Número de representação do timezone.","type":"integer","example":3,"uniqueKey":"data.items.[INDEX].updated_at.timezone_type","typeLabel":"integer"},"timezone":{"description":"Fuso horário associado.","type":"string","example":"America/Sao_Paulo","uniqueKey":"data.items.[INDEX].updated_at.timezone","typeLabel":"string"}},"type":"object","uniqueKey":"data.items.[INDEX].updated_at","typeLabel":"object"},"meta":{"description":"Metadados da resposta.","properties":{"pagination":{"description":"Dados de paginação do resultado.","properties":{"total":{"description":"Quantidade total de registros encontrados, considerando todas as páginas.","type":"integer","example":"10","uniqueKey":"data.items.[INDEX].meta.pagination.total","typeLabel":"integer"},"count":{"description":"Quantidade de registros retornados na página atual.","type":"integer","example":"30","uniqueKey":"data.items.[INDEX].meta.pagination.count","typeLabel":"integer"},"per_page":{"description":"Quantidade máxima de registros por página.","type":"integer","example":"10","uniqueKey":"data.items.[INDEX].meta.pagination.per_page","typeLabel":"integer"},"current_page":{"description":"Número da página atual.","type":"integer","example":"1","uniqueKey":"data.items.[INDEX].meta.pagination.current_page","typeLabel":"integer"},"total_pages":{"description":"Quantidade total de páginas do resultado.","type":"integer","example":"3","uniqueKey":"data.items.[INDEX].meta.pagination.total_pages","typeLabel":"integer"},"links":{"description":"Links de navegação entre as páginas do resultado.","properties":{"previous":{"description":"URL da página anterior, ausente quando a página atual é a primeira.","type":"string","example":"","uniqueKey":"data.items.[INDEX].meta.pagination.links.previous","typeLabel":"string"},"next":{"description":"URL da próxima página, ausente quando a página atual é a última.","type":"string","example":"","uniqueKey":"data.items.[INDEX].meta.pagination.links.next","typeLabel":"string"}},"type":"object","uniqueKey":"data.items.[INDEX].meta.pagination.links","typeLabel":"object"}},"type":"object","uniqueKey":"data.items.[INDEX].meta.pagination","typeLabel":"object"}},"type":"object","uniqueKey":"data.items.[INDEX].meta","typeLabel":"object"}},"uniqueKey":"data.items.[INDEX]","typeLabel":"SimplePaginatorWithMeta · object"},"uniqueKey":"data","typeLabel":"SimplePaginatorWithMeta · object[]"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":[{"id":1520,"store_id":1319250,"discount_type_id":1520,"name":"Lucas","entry_condition_type":"amount","entry_condition_value":10,"discount_method":"percent","discount_value":100,"discount_type":"buy_x_get_y","accumulate":false,"start_at":{"date":"2000-08-17 10:24:24","timezone_type":3,"timezone":"America/Sao_Paulo"},"end_at":{"date":"2000-08-17 10:24:24","timezone_type":3,"timezone":"America/Sao_Paulo"},"created_at":{"date":"2000-08-17 10:24:24","timezone_type":3,"timezone":"America/Sao_Paulo"},"updated_at":{"date":"2000-08-17 10:24:24","timezone_type":3,"timezone":"America/Sao_Paulo"},"meta":{"pagination":{"total":"10","count":"30","per_page":"10","current_page":"1","total_pages":"3","links":{"previous":"","next":""}}}}]}}},"exampleType":"generated"}},"exampleType":"generated"},"736c46ee-b16d-4af8-8672-3fa8b028049d":{"description":"Requisição Inválida","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"a250527c-7361-42af-b49a-beeb30cc372c":{"ApiToken":{"type":"apiKey","name":"User-Token","in":"header","scopes":[],"schemeName":"ApiToken"},"ApiSecretKey":{"type":"apiKey","name":"User-Secret-Key","in":"header","scopes":[],"schemeName":"ApiSecretKey"}}},"servers":{"1344bf83-54a9-44e6-affe-b1f1f24edc3b":{"url":"https://api.dooki.com.br/v2","description":"Endpoint de produção"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"User-Token","in":"header","scopes":[],"schemeName":"ApiToken"},"schema":{"title":"User-Token","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiToken","name":"User-Token"},{"scheme":{"type":"apiKey","name":"User-Secret-Key","in":"header","scopes":[],"schemeName":"ApiSecretKey"},"schema":{"title":"User-Secret-Key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiSecretKey","name":"User-Secret-Key"}],"title":"ApiToken \u0026 ApiSecretKey"}]},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"yampi","siteName":"Yampi Developer Portal","title":"Listar descontos da loja - Yampi Developer Portal","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-28T13:24:58.043Z","originalFileLocation":"api-reference/descontos/listar-descontos-da-loja.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Lista os descontos cadastrados na loja\">\u003cmeta data-mint-head name=\"application-name\" content=\"Yampi Developer Portal\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/yampi/figQsf_RhT2pvY-O/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/yampi/figQsf_RhT2pvY-O/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/yampi/figQsf_RhT2pvY-O/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/yampi/figQsf_RhT2pvY-O/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/yampi/figQsf_RhT2pvY-O/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/yampi/figQsf_RhT2pvY-O/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/yampi/figQsf_RhT2pvY-O/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/yampi/figQsf_RhT2pvY-O/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/yampi/figQsf_RhT2pvY-O/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Listar descontos da loja - Yampi Developer Portal\">\u003cmeta data-mint-head property=\"og:description\" content=\"Lista os descontos cadastrados na loja\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Yampi Developer Portal\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.yampi.com.br/api-reference/descontos/listar-descontos-da-loja\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://yampi.mintlify.app/_mintlify/api/og/v2?division=Descontos\u0026amp;title=Listar+descontos+da+loja\u0026amp;description=Lista+os+descontos+cadastrados+na+loja\u0026amp;theme=d827fd6b92dc536639c57b24\u0026amp;signature=06530ea2eb7eca1b389f76484022a83ca52fdd78927d75e27f1014dddb5d7fe1\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Listar descontos da loja - Yampi Developer Portal\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Lista os descontos cadastrados na loja\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://yampi.mintlify.app/_mintlify/api/og/v2?division=Descontos\u0026amp;title=Listar+descontos+da+loja\u0026amp;description=Lista+os+descontos+cadastrados+na+loja\u0026amp;theme=d827fd6b92dc536639c57b24\u0026amp;signature=06530ea2eb7eca1b389f76484022a83ca52fdd78927d75e27f1014dddb5d7fe1\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/yampi/figQsf_RhT2pvY-O/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Yampi Developer Portal\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#A85DEE\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.yampi.com.br/api-reference/descontos/listar-descontos-da-loja\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/descontos/listar-descontos-da-loja.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.yampi.com.br/#organization\",\"name\":\"Yampi Developer Portal\",\"url\":\"https://docs.yampi.com.br\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/yampi/qWYSl0wcm4MZ24_i/logo/yampi-positive.svg?fit=max\u0026auto=format\u0026n=qWYSl0wcm4MZ24_i\u0026q=85\u0026s=b43bef13c1cf7b7b161da2768346b8d0\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.yampi.com.br#website\",\"name\":\"Yampi Developer Portal\",\"url\":\"https://docs.yampi.com.br\",\"publisher\":{\"@id\":\"https://docs.yampi.com.br/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.yampi.com.br/api-reference/descontos/listar-descontos-da-loja#webpage\",\"url\":\"https://docs.yampi.com.br/api-reference/descontos/listar-descontos-da-loja\",\"name\":\"Listar descontos da loja\",\"description\":\"Lista os descontos cadastrados na loja\",\"dateModified\":\"2026-01-28T13:24:58.043Z\",\"isPartOf\":{\"@id\":\"https://docs.yampi.com.br#website\"},\"breadcrumb\":{\"@id\":\"https://docs.yampi.com.br/api-reference/descontos/listar-descontos-da-loja#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.yampi.com.br/api-reference/descontos/listar-descontos-da-loja#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Referência da API\",\"item\":\"https://docs.yampi.com.br/api-reference/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Listar descontos da loja\",\"item\":\"https://docs.yampi.com.br/api-reference/descontos/listar-descontos-da-loja\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.yampi.com.br/api-reference/descontos/listar-descontos-da-loja#apireference\",\"headline\":\"Listar descontos da loja\",\"name\":\"Listar descontos da loja\",\"description\":\"Lista os descontos cadastrados na loja\",\"url\":\"https://docs.yampi.com.br/api-reference/descontos/listar-descontos-da-loja\",\"mainEntityOfPage\":{\"@id\":\"https://docs.yampi.com.br/api-reference/descontos/listar-descontos-da-loja#webpage\"},\"dateModified\":\"2026-01-28T13:24:58.043Z\",\"publisher\":{\"@id\":\"https://docs.yampi.com.br/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.yampi.com.br#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Yampi Developer Portal\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Yampi Developer Portal","nav":{"global":null,"anchors":[{"anchor":"Página Inicial","pages":[{"title":"Página Inicial","href":"/introduction"}]},{"anchor":"Referência da API","icon":"book","groups":[{"group":"Referência da API","pages":[{"title":"Introdução","href":"/api-reference/introduction"},{"title":"API Collection","href":"/api-reference/api-collection"},{"group":"Rate Limit","pages":[{"title":"Como funciona","href":"/api-reference/rate-limit/introduction"},{"title":"Boas práticas","href":"/api-reference/rate-limit/boas-praticas"},{"title":"Limites","href":"/api-reference/rate-limit/limites"},{"title":"Precisa de ajuda?","href":"/api-reference/rate-limit/suporte"}]},{"group":"Paginação","pages":[{"title":"Paginação por scroll_id","href":"/api-reference/pagination/introduction"}]},{"group":"Autenticação","pages":[{"title":"User Token e User Secret Key","href":"/api-reference/auth/auth-user-token"},{"title":"Autenticação","href":"/api-reference/auth/auth"},{"openapi":"post /auth/me","title":"Visualizar dados do usuário logado","href":"/api-reference/auth/visualizar-usuario"}]},{"group":"Catálogo","pages":[{"group":"Marcas","pages":[{"openapi":"get /{alias}/catalog/brands","title":"Listar marcas","href":"/api-reference/catalogo/marcas/listar-marcas"},{"openapi":"post /{alias}/catalog/brands","title":"Criar marca","href":"/api-reference/catalogo/marcas/criar-marca"},{"openapi":"get /{alias}/catalog/brands/{id}","title":"Visualizar marca","href":"/api-reference/catalogo/marcas/visualizar-marca"},{"openapi":"put /{alias}/catalog/brands/{id}","title":"Atualizar marca","href":"/api-reference/catalogo/marcas/atualizar-marca"},{"openapi":"delete /{alias}/catalog/brands/{id}","title":"Excluir marca","href":"/api-reference/catalogo/marcas/excluir-marca"}]},{"group":"Categorias","pages":[{"openapi":"get /{alias}/catalog/categories","title":"Listar categorias","href":"/api-reference/catalogo/categorias/listar-categorias"},{"openapi":"post /{alias}/catalog/categories","title":"Criar categoria","href":"/api-reference/catalogo/categorias/criar-categoria"},{"openapi":"get /{alias}/catalog/categories/{id}","title":"Visualizar categoria","href":"/api-reference/catalogo/categorias/visualizar-categoria"},{"openapi":"put /{alias}/catalog/categories/{id}","title":"Atualizar categoria","href":"/api-reference/catalogo/categorias/atualizar-categoria"},{"openapi":"delete /{alias}/catalog/categories/{id}","title":"Excluir categoria","href":"/api-reference/catalogo/categorias/excluir-categoria"},{"openapi":"get /{alias}/catalog/categories/{id}/products","title":"Listar produtos associados a uma categoria","href":"/api-reference/catalogo/categorias/listar-produtos-associados-a-uma-categoria"},{"openapi":"put /{alias}/catalog/categories/{id}/products","title":"Associar produtos a uma categoria","href":"/api-reference/catalogo/categorias/associar-produtos-a-uma-categoria"},{"openapi":"delete /{alias}/catalog/categories/{id}/products","title":"Excluir produtos de uma categoria","href":"/api-reference/catalogo/categorias/excluir-produtos-de-uma-categoria"},{"openapi":"get /{alias}/catalog/categories/{id}/banners","title":"Listar banners associados a uma categoria","href":"/api-reference/catalogo/categorias/listar-banners-associados-a-uma-categoria"},{"openapi":"post /{alias}/catalog/categories/{id}/copy-products","title":"Associar produtos de outras categorias","href":"/api-reference/catalogo/categorias/associar-produtos-de-outras-categorias"}]},{"group":"Coleções","pages":[{"openapi":"get /{alias}/catalog/collections","title":"Listar coleções","href":"/api-reference/catalogo/colecoes/listar-colecoes"},{"openapi":"post /{alias}/catalog/collections","title":"Criar coleção","href":"/api-reference/catalogo/colecoes/criar-colecao"},{"openapi":"get /{alias}/catalog/collections/{id}","title":"Visualizar coleção","href":"/api-reference/catalogo/colecoes/visualizar-colecao"},{"openapi":"put /{alias}/catalog/collections/{id}","title":"Atualizar coleção","href":"/api-reference/catalogo/colecoes/atualizar-colecao"},{"openapi":"delete /{alias}/catalog/collections/{id}","title":"Excluir coleção","href":"/api-reference/catalogo/colecoes/excluir-colecao"},{"openapi":"get /{alias}/catalog/collections/{id}/products","title":"Listar produtos associados a uma coleção","href":"/api-reference/catalogo/colecoes/listar-produtos-associados-a-uma-colecao"},{"openapi":"post /{alias}/catalog/collections/{id}/products","title":"Associar produtos a uma coleção","href":"/api-reference/catalogo/colecoes/associar-produtos-a-uma-colecao"},{"openapi":"delete /{alias}/catalog/collections/{id}/products","title":"Excluir produtos de uma coleção","href":"/api-reference/catalogo/colecoes/excluir-produtos-de-uma-colecao"}]},{"group":"Comentários de produtos","pages":[{"openapi":"get /{alias}/catalog/comments","title":"Listar comentários de produtos","href":"/api-reference/catalogo/produtos/comentarios-de-produtos/listar-comentarios-de-produtos"},{"openapi":"post /{alias}/catalog/comments","title":"Criar comentário de produto","href":"/api-reference/catalogo/produtos/comentarios-de-produtos/criar-comentario-de-produto"},{"openapi":"get /{alias}/catalog/comments/{id}","title":"Visualizar comentário de produto","href":"/api-reference/catalogo/produtos/comentarios-de-produtos/visualizar-comentario-de-produto"},{"openapi":"put /{alias}/catalog/comments/{id}","title":"Atualizar comentário de produto","href":"/api-reference/catalogo/produtos/comentarios-de-produtos/atualizar-comentario-de-produto"},{"openapi":"delete /{alias}/catalog/comments/{id}","title":"Excluir comentário de produto","href":"/api-reference/catalogo/produtos/comentarios-de-produtos/excluir-comentario-de-produto"}]},{"group":"Customizações","pages":[{"openapi":"get /{alias}/catalog/customizations","title":"Listar customizações","href":"/api-reference/catalogo/customizacoes/listar-customizacoes"},{"openapi":"post /{alias}/catalog/customizations","title":"Criar customização","href":"/api-reference/catalogo/customizacoes/criar-customizacao"},{"openapi":"get /{alias}/catalog/customizations/{id}","title":"Visualizar customização","href":"/api-reference/catalogo/customizacoes/visualizar-customizacao"},{"openapi":"put /{alias}/catalog/customizations/{id}","title":"Atualizar customização","href":"/api-reference/catalogo/customizacoes/atualizar-customizacao"},{"openapi":"delete /{alias}/catalog/customizations/{id}","title":"Excluir customização","href":"/api-reference/catalogo/customizacoes/excluir-customizacao"}]},{"group":"Feeds","pages":[{"openapi":"get /{alias}/catalog/feeds","title":"Listar feeds","href":"/api-reference/catalogo/feeds/listar-feeds"},{"openapi":"post /{alias}/catalog/feeds","title":"Criar feed","href":"/api-reference/catalogo/feeds/criar-feed"},{"openapi":"get /{alias}/catalog/feeds/{id}","title":"Visualizar feed","href":"/api-reference/catalogo/feeds/visualizar-feed"},{"openapi":"put /{alias}/catalog/feeds/{id}","title":"Atualizar feed","href":"/api-reference/catalogo/feeds/atualizar-feed"},{"openapi":"delete /{alias}/catalog/feeds/{id}","title":"Excluir feed","href":"/api-reference/catalogo/feeds/excluir-feed"}]},{"group":"Valores de filtros","pages":[{"openapi":"get /{alias}/catalog/filters/{filterId}/values","title":"Listar valores de um filtro","href":"/api-reference/catalogo/filtros/valores-de-filtros/listar-valores-de-um-filtro"},{"openapi":"post /{alias}/catalog/filters/{filterId}/values","title":"Criar valor de filtro","href":"/api-reference/catalogo/filtros/valores-de-filtros/criar-valor-de-filtro"},{"openapi":"get /{alias}/catalog/filters/{filterId}/values/{id}","title":"Visualizar valor de um filtro","href":"/api-reference/catalogo/filtros/valores-de-filtros/visualizar-valor-de-um-filtro"},{"openapi":"put /{alias}/catalog/filters/{filterId}/values/{id}","title":"Atualizar valor de filtro","href":"/api-reference/catalogo/filtros/valores-de-filtros/atualizar-valor-de-filtro"},{"openapi":"delete /{alias}/catalog/filters/{filterId}/values/{id}","title":"Excluir valor de filtro","href":"/api-reference/catalogo/filtros/valores-de-filtros/excluir-valor-de-filtro"}]},{"group":"Filtros","pages":[{"openapi":"get /{alias}/catalog/filters","title":"Listar filtros de busca de produtos","href":"/api-reference/catalogo/filtros/listar-filtros-de-busca-de-produtos"},{"openapi":"post /{alias}/catalog/filters","title":"Criar filtro de busca de produtos","href":"/api-reference/catalogo/filtros/criar-filtro-de-busca-de-produtos"},{"openapi":"get /{alias}/catalog/filters/{id}","title":"Visualizar filtro","href":"/api-reference/catalogo/filtros/visualizar-filtro"},{"openapi":"put /{alias}/catalog/filters/{id}","title":"Atualizar filtro","href":"/api-reference/catalogo/filtros/atualizar-filtro"},{"openapi":"delete /{alias}/catalog/filters/{id}","title":"Excluir filtro","href":"/api-reference/catalogo/filtros/excluir-filtro"}]},{"group":"Selos","pages":[{"openapi":"get /{alias}/catalog/flags","title":"Listar selos","href":"/api-reference/catalogo/selos/listar-selos"},{"openapi":"post /{alias}/catalog/flags","title":"Criar selo","href":"/api-reference/catalogo/selos/criar-selo"},{"openapi":"get /{alias}/catalog/flags/{id}","title":"Visualizar selo","href":"/api-reference/catalogo/selos/visualizar-selo"},{"openapi":"put /{alias}/catalog/flags/{id}","title":"Atualizar selo","href":"/api-reference/catalogo/selos/atualizar-selo"},{"openapi":"delete /{alias}/catalog/flags/{id}","title":"Excluir selo","href":"/api-reference/catalogo/selos/excluir-selo"},{"openapi":"get /{alias}/catalog/flags/{id}/products","title":"Listar produtos associados a um selo","href":"/api-reference/catalogo/selos/listar-produtos-associados-a-um-selo"},{"openapi":"post /{alias}/catalog/flags/{id}/products","title":"Associar produtos a um selo","href":"/api-reference/catalogo/selos/associar-produtos-a-um-selo"},{"openapi":"delete /{alias}/catalog/flags/{id}/products","title":"Excluir produtos de um selo","href":"/api-reference/catalogo/selos/excluir-produtos-de-um-selo"}]},{"group":"Valores de variações","pages":[{"openapi":"get /{alias}/catalog/variations/{variationId}/values","title":"Listar valores de uma variação","href":"/api-reference/catalogo/variacoes/valores-de-variacoes/listar-valores-de-uma-variacao"},{"openapi":"post /{alias}/catalog/variations/{variationId}/values","title":"Criar valor de variação","href":"/api-reference/catalogo/variacoes/valores-de-variacoes/criar-valor-de-variacao"},{"openapi":"get /{alias}/catalog/variations/{variationId}/values/{id}","title":"Visualizar valor de uma variação","href":"/api-reference/catalogo/variacoes/valores-de-variacoes/visualizar-valor-de-uma-variacao"},{"openapi":"put /{alias}/catalog/variations/{variationId}/values/{id}","title":"Atualizar valor de variação","href":"/api-reference/catalogo/variacoes/valores-de-variacoes/atualizar-valor-de-variacao"},{"openapi":"delete /{alias}/catalog/variations/{variationId}/values/{id}","title":"Excluir valor de variação","href":"/api-reference/catalogo/variacoes/valores-de-variacoes/excluir-valor-de-variacao"}]},{"group":"Variações","pages":[{"openapi":"get /{alias}/catalog/variations","title":"Listar variações","href":"/api-reference/catalogo/variacoes/listar-variacoes"},{"openapi":"post /{alias}/catalog/variations","title":"Criar variação","href":"/api-reference/catalogo/variacoes/criar-variacao"},{"openapi":"get /{alias}/catalog/variations/{id}","title":"Visualizar variação","href":"/api-reference/catalogo/variacoes/visualizar-variacao"},{"openapi":"put /{alias}/catalog/variations/{id}","title":"Atualizar variação","href":"/api-reference/catalogo/variacoes/atualizar-variacao"},{"openapi":"delete /{alias}/catalog/variations/{id}","title":"Excluir variação","href":"/api-reference/catalogo/variacoes/excluir-variacao"}]},{"group":"Grupos","pages":[{"openapi":"get /{alias}/catalog/groups","title":"Listar grupos de produtos","href":"/api-reference/catalogo/grupos/listar-grupos-de-produtos"},{"openapi":"post /{alias}/catalog/groups","title":"Criar grupo de produtos","href":"/api-reference/catalogo/grupos/criar-grupo-de-produtos"},{"openapi":"get /{alias}/catalog/groups/{id}","title":"Visualizar grupo de produtos","href":"/api-reference/catalogo/grupos/visualizar-grupo-de-produtos"},{"openapi":"put /{alias}/catalog/groups/{id}","title":"Atualizar grupo de produtos","href":"/api-reference/catalogo/grupos/atualizar-grupo-de-produtos"},{"openapi":"delete /{alias}/catalog/groups/{id}","title":"Excluir grupo de produtos","href":"/api-reference/catalogo/grupos/excluir-grupo-de-produtos"},{"openapi":"get /{alias}/catalog/groups/{id}/products","title":"Listar produtos associados a um grupo","href":"/api-reference/catalogo/grupos/listar-produtos-associados-a-um-grupo"},{"openapi":"put /{alias}/catalog/groups/{id}/products","title":"Associar produtos a um grupo","href":"/api-reference/catalogo/grupos/associar-produtos-a-um-grupo"},{"openapi":"delete /{alias}/catalog/groups/{id}/products","title":"Excluir produtos de um grupo","href":"/api-reference/catalogo/grupos/excluir-produtos-de-um-grupo"}]},{"group":"Looks","pages":[{"openapi":"get /{alias}/catalog/looks","title":"Listar looks","href":"/api-reference/catalogo/looks/listar-looks"},{"openapi":"post /{alias}/catalog/looks","title":"Criar look","href":"/api-reference/catalogo/looks/criar-look"},{"openapi":"get /{alias}/catalog/looks/{id}","title":"Visualizar look","href":"/api-reference/catalogo/looks/visualizar-look"},{"openapi":"put /{alias}/catalog/looks/{id}","title":"Atualizar look","href":"/api-reference/catalogo/looks/atualizar-look"},{"openapi":"delete /{alias}/catalog/looks/{id}","title":"Excluir look","href":"/api-reference/catalogo/looks/excluir-look"}]},{"group":"Produtos","pages":[{"openapi":"get /{alias}/catalog/products","title":"Listar produtos","href":"/api-reference/catalogo/produtos/listar-produtos"},{"openapi":"post /{alias}/catalog/products","title":"Criar produto","href":"/api-reference/catalogo/produtos/criar-produto"},{"openapi":"put /{alias}/catalog/products/{id}","title":"Atualizar produto","href":"/api-reference/catalogo/produtos/atualizar-produto"},{"openapi":"delete /{alias}/catalog/products/{id}","title":"Excluir produto","href":"/api-reference/catalogo/produtos/excluir-produto"},{"openapi":"get /{alias}/catalog/products/{id}/skus","title":"Listar SKUs de um produto","href":"/api-reference/catalogo/produtos/listar-skus-de-um-produto"},{"openapi":"put /{alias}/catalog/products/{id}/skus/order","title":"Atualizar ordem dos SKUs de um produto","href":"/api-reference/catalogo/produtos/atualizar-ordem-dos-skus-de-um-produto"},{"openapi":"get /{alias}/catalog/products/{id}/combos","title":"Listar combos de um produto","href":"/api-reference/catalogo/produtos/listar-combos-de-um-produto"},{"openapi":"get /{alias}/catalog/products/{id}/flags","title":"Listar selos de um produto","href":"/api-reference/catalogo/produtos/listar-selos-de-um-produto"},{"openapi":"get /{alias}/catalog/products/{id}/groups","title":"Listar grupos de um produto","href":"/api-reference/catalogo/produtos/listar-grupos-de-um-produto"},{"openapi":"get /{alias}/catalog/products/{id}/comments","title":"Listar comentários de um produto","href":"/api-reference/catalogo/produtos/listar-comentarios-de-um-produto"},{"openapi":"get /{alias}/catalog/products/{id}/reviews","title":"Listar avaliações de um produto","href":"/api-reference/catalogo/produtos/listar-avaliacoes-de-um-produto"},{"openapi":"get /{alias}/catalog/products/{id}/collections","title":"Listar coleções que um produto pertence","href":"/api-reference/catalogo/produtos/listar-colecoes-que-um-produto-pertence"},{"openapi":"get /{alias}/catalog/products/{id}/promotions","title":"Listar promoções que um produto pertence","href":"/api-reference/catalogo/produtos/listar-promocoes-que-um-produto-pertence"},{"openapi":"get /{alias}/catalog/products/{id}/recommendations","title":"Listar recomendações para um produto","href":"/api-reference/catalogo/produtos/listar-recomendacoes-para-um-produto"},{"openapi":"get /{alias}/catalog/products/{id}/stocks","title":"Listar estoques de todos os SKUs de um produto","href":"/api-reference/catalogo/produtos/listar-estoques-de-todos-os-skus-de-um-produto"},{"openapi":"post /{alias}/catalog/products/{id}/duplicate","title":"Duplicar produto","href":"/api-reference/catalogo/produtos/duplicar-produto"},{"openapi":"put /{alias}/catalog/products/{id}/skus/batch-update-skus","title":"Atualizar SKUs em massa","href":"/api-reference/catalogo/produtos/atualizar-skus-em-massa"},{"openapi":"get /{alias}/catalog/products/{product}/skus/batch-update-skus-progress","title":"Progresso da atualização em massa de SKUs de um produto","href":"/api-reference/catalogo/produtos/progresso-da-atualizacao-em-massa-de-skus-de-um-produto"},{"openapi":"get /{alias}/catalog/products/{product}/skus/batch-delete-skus-progress","title":"Progresso da exclusão em massa de SKUs de um produto","href":"/api-reference/catalogo/produtos/progresso-da-exclusao-em-massa-de-skus-de-um-produto"},{"openapi":"get /{alias}/catalog/products/{id}","title":"Visualizar um produto","href":"/api-reference/catalogo/produtos/visualizar-um-produto"}]},{"group":"Produtos relacionados","pages":[{"openapi":"get /{alias}/catalog/products/{id}/similars","title":"Listar produtos relacionados","href":"/api-reference/catalogo/produtos/produtos-relacionados/listar-produtos-relacionados"},{"openapi":"put /{alias}/catalog/products/{id}/similars","title":"Ordenar produtos relacionados","href":"/api-reference/catalogo/produtos/produtos-relacionados/ordenar-produtos-relacionados"},{"openapi":"delete /{alias}/catalog/products/{id}/similars","title":"Excluir produtos relacionados","href":"/api-reference/catalogo/produtos/produtos-relacionados/excluir-produtos-relacionados"},{"openapi":"post /{alias}/catalog/products/similars/batch","title":"Relacionar produtos em lote","href":"/api-reference/catalogo/produtos/produtos-relacionados/relacionar-produtos-em-lote"}]},{"group":"Sincronizar estoques","pages":[{"openapi":"post /{alias}/catalog/products/{id}/stocks/sync","title":"Sincronizar estoques","href":"/api-reference/catalogo/skus/sincronizar-estoques/sincronizar-estoques"}]},{"group":"Avaliações de produtos","pages":[{"openapi":"get /{alias}/catalog/reviews","title":"Listar avaliações","href":"/api-reference/catalogo/produtos/avaliacoes-de-produtos/listar-avaliacoes"},{"openapi":"post /{alias}/catalog/reviews","title":"Criar review","href":"/api-reference/catalogo/produtos/avaliacoes-de-produtos/criar-review"},{"openapi":"get /{alias}/catalog/reviews/{id}","title":"Visualizar review","href":"/api-reference/catalogo/produtos/avaliacoes-de-produtos/visualizar-review"},{"openapi":"patch /{alias}/catalog/reviews/{id}","title":"Aprovar ou rejeitar uma review do produto","href":"/api-reference/catalogo/produtos/avaliacoes-de-produtos/aprovar-ou-rejeitar-uma-review-do-produto"}]},{"group":"Imagens","pages":[{"openapi":"get /{alias}/catalog/skus/{skuId}/images","title":"Listar imagens de um SKU","href":"/api-reference/catalogo/imagens/listar-imagens-de-um-sku"},{"openapi":"post /{alias}/catalog/skus/{skuId}/images","title":"Criar imagens de um SKU","href":"/api-reference/catalogo/imagens/criar-imagens-de-um-sku"},{"openapi":"get /{alias}/catalog/skus/{skuId}/images/{id}","title":"Visualizar imagem de um SKU","href":"/api-reference/catalogo/imagens/visualizar-imagem-de-um-sku"},{"openapi":"delete /{alias}/catalog/skus/{skuId}/images/{id}","title":"Excluir imagem de um SKU","href":"/api-reference/catalogo/imagens/excluir-imagem-de-um-sku"},{"openapi":"put /{alias}/catalog/skus/{skuId}/images/order","title":"Atualizar ordem das imagens de um SKU","href":"/api-reference/catalogo/imagens/atualizar-ordem-das-imagens-de-um-sku"}]},{"group":"SKUs","pages":[{"openapi":"get /{alias}/catalog/skus","title":"Listar SKUs","href":"/api-reference/catalogo/skus/listar-skus"},{"openapi":"post /{alias}/catalog/skus","title":"Criar SKU","href":"/api-reference/catalogo/skus/criar-sku"},{"openapi":"put /{alias}/catalog/skus/{id}","title":"Atualizar SKU","href":"/api-reference/catalogo/skus/atualizar-sku"},{"openapi":"delete /{alias}/catalog/skus/{id}","title":"Excluir SKU","href":"/api-reference/catalogo/skus/excluir-sku"}]},{"group":"Notificações de estoque","pages":[{"openapi":"get /{alias}/catalog/stock-notifications","title":"Listar notificações de estoque","href":"/api-reference/catalogo/notificacoes-de-estoque/listar-notificacoes-de-estoque"},{"openapi":"post /{alias}/catalog/stock-notifications","title":"Criar notificação de estoque","href":"/api-reference/catalogo/notificacoes-de-estoque/criar-notificacao-de-estoque"},{"openapi":"get /{alias}/catalog/stock-notifications/{id}","title":"Visualiza notificação de estoque","href":"/api-reference/catalogo/notificacoes-de-estoque/visualiza-notificacao-de-estoque"},{"openapi":"put /{alias}/catalog/stock-notifications/{id}","title":"Atualizar notificação de estoque","href":"/api-reference/catalogo/notificacoes-de-estoque/atualizar-notificacao-de-estoque"},{"openapi":"delete /{alias}/catalog/stock-notifications/{id}","title":"Excluir notificação de estoque","href":"/api-reference/catalogo/notificacoes-de-estoque/excluir-notificacao-de-estoque"}]},{"group":"Estoques de SKU","pages":[{"openapi":"get /{alias}/catalog/skus/{skuId}/stocks","title":"Listar estoques","href":"/api-reference/catalogo/skus/estoques-de-sku/listar-estoques"},{"openapi":"post /{alias}/catalog/skus/{skuId}/stocks","title":"Criar estoque de um SKU","href":"/api-reference/catalogo/skus/estoques-de-sku/criar-estoque-de-um-sku"},{"openapi":"put /{alias}/catalog/skus/{skuId}/stocks/{id}","title":"Atualizar estoque de um SKU","href":"/api-reference/catalogo/skus/estoques-de-sku/atualizar-estoque-de-um-sku"},{"openapi":"delete /{alias}/catalog/skus/{skuId}/stocks/{id}","title":"Excluir estoque de um SKU","href":"/api-reference/catalogo/skus/estoques-de-sku/excluir-estoque-de-um-sku"},{"openapi":"get /{alias}/catalog/skus/stocks/{stock}","title":"Listar SKUs por estoque","href":"/api-reference/catalogo/skus/estoques-de-sku/listar-skus-por-estoque"}]},{"group":"Kits","pages":[{"openapi":"get /{alias}/catalog/bundles","title":"Listar Kits","href":"/api-reference/catalogo/kits/listar-kits"},{"openapi":"post /{alias}/catalog/bundles","title":"Cadastrar um Kit","href":"/api-reference/catalogo/kits/cadastrar-um-kit"},{"openapi":"get /{alias}/catalog/bundles/{id}","title":"Visualizar um Kit","href":"/api-reference/catalogo/kits/visualizar-um-kit"},{"openapi":"put /{alias}/catalog/bundles/{id}","title":"Atualizar um Kit","href":"/api-reference/catalogo/kits/atualizar-um-kit"},{"openapi":"delete /{alias}/catalog/bundles/{id}","title":"Exclui um Kit","href":"/api-reference/catalogo/kits/exclui-um-kit"}]},{"group":"Atualização em massa","pages":[{"openapi":"put /{alias}/catalog/products/batch-edit","title":"Atualizar produtos em lote","href":"/api-reference/catalogo/atualizacao-em-massa/atualizar-produtos-em-lote"}]}]},{"group":"Checkout","pages":[{"group":"Bancos","pages":[{"openapi":"get /{alias}/checkout/banks","title":"Listar bancos","href":"/api-reference/checkout/bancos/listar-bancos"},{"openapi":"get /{alias}/checkout/banks/{id}","title":"Visualizar banco","href":"/api-reference/checkout/bancos/visualizar-banco"}]},{"group":"Carrinhos abandonados","pages":[{"openapi":"get /{alias}/checkout/carts","title":"Listar carrinhos abandonados","href":"/api-reference/checkout/carrinhos-abandonados/listar-carrinhos-abandonados"},{"openapi":"get /{alias}/checkout/carts/{id}/transactions","title":"Listar dados de transações de carrinhos abandonados","href":"/api-reference/checkout/carrinhos-abandonados/listar-dados-de-transacoes-de-carrinhos-abandonados"}]},{"group":"Gateways de pagamento","pages":[{"title":"Visão Geral","href":"/api-reference/checkout/gateways-de-pagamento/introduction"},{"openapi":"get /{alias}/checkout/gateways","title":"Listar gateways de pagamento","href":"/api-reference/checkout/gateways-de-pagamento/listar-gateways-de-pagamento"},{"openapi":"get /{alias}/checkout/gateways/{gatewayAlias}","title":"Visualizar gateway de pagamento","href":"/api-reference/checkout/gateways-de-pagamento/visualizar-gateway-de-pagamento"}]},{"group":"Configurações de pagamentos","pages":[{"openapi":"get /{alias}/checkout/payments/{paymentId}/config","title":"Listar configurações de pagamento","href":"/api-reference/checkout/configuracoes-de-pagamentos/listar-configuracoes-de-pagamento"},{"openapi":"post /{alias}/checkout/payments/{paymentId}/config","title":"Criar configuração de pagamento","href":"/api-reference/checkout/configuracoes-de-pagamentos/criar-configuracao-de-pagamento"},{"openapi":"get /{alias}/checkout/payments/{paymentId}/config/{id}","title":"Visualizar configuração de pagamento","href":"/api-reference/checkout/configuracoes-de-pagamentos/visualizar-configuracao-de-pagamento"},{"openapi":"put /{alias}/checkout/payments/{paymentId}/config/{id}","title":"Atualizar configuração de pagamento","href":"/api-reference/checkout/configuracoes-de-pagamentos/atualizar-configuracao-de-pagamento"},{"openapi":"delete /{alias}/checkout/payments/{paymentId}/config/{id}","title":"Excluir configuração de pagamento","href":"/api-reference/checkout/configuracoes-de-pagamentos/excluir-configuracao-de-pagamento"}]},{"group":"Links de Pagamento","pages":[{"openapi":"get /{alias}/checkout/payment-link","title":"Listar Links de Pagamento","href":"/api-reference/checkout/links-de-pagamento/listar-links-de-pagamento"},{"openapi":"post /{alias}/checkout/payment-link","title":"Criar Link de Pagamento","href":"/api-reference/checkout/links-de-pagamento/criar-link-de-pagamento"},{"openapi":"get /{alias}/checkout/payment-link/{id}","title":"Visualizar Link de Pagamento","href":"/api-reference/checkout/links-de-pagamento/visualizar-link-de-pagamento"},{"openapi":"put /{alias}/checkout/payment-link/{id}","title":"Atualizar Link de Pagamento","href":"/api-reference/checkout/links-de-pagamento/atualizar-link-de-pagamento"},{"openapi":"delete /{alias}/checkout/payment-link/{id}","title":"Excluir Link de Pagamento","href":"/api-reference/checkout/links-de-pagamento/excluir-link-de-pagamento"}]},{"group":"Parcelamento","pages":[{"openapi":"get /{alias}/checkout/payments/{paymentId}/installments","title":"Listar parcelamentos de um pagamento","href":"/api-reference/checkout/parcelamento/listar-parcelamentos-de-um-pagamento"},{"openapi":"post /{alias}/checkout/payments/{paymentId}/installments","title":"Criar regras de parcelamentos para um pagamento","href":"/api-reference/checkout/parcelamento/criar-regras-de-parcelamentos-para-um-pagamento"},{"openapi":"get /{alias}/checkout/payments/{paymentId}/installments/simulate","title":"Simular parcelamento de um pagamento","href":"/api-reference/checkout/parcelamento/simular-parcelamento-de-um-pagamento"}]},{"group":"Formas de pagamentos","pages":[{"openapi":"get /{alias}/checkout/payments","title":"Listar formas de pagamento","href":"/api-reference/checkout/formas-de-pagamentos/listar-formas-de-pagamento"},{"openapi":"get /{alias}/checkout/payments/{paymentId}","title":"Visualizar forma de pagamento","href":"/api-reference/checkout/formas-de-pagamentos/visualizar-forma-de-pagamento"}]},{"group":"Status de pedidos","pages":[{"title":"Visão Geral","href":"/api-reference/checkout/status-de-pedidos/introduction"},{"openapi":"get /{alias}/checkout/statuses","title":"Listar status de pedidos","href":"/api-reference/checkout/status-de-pedidos/listar-status-de-pedidos"},{"openapi":"put /{alias}/checkout/statuses/{id}/email-details","title":"Atualizar detalhes do email de um status","href":"/api-reference/checkout/status-de-pedidos/atualizar-detalhes-do-email-de-um-status"}]},{"group":"Transações","pages":[{"title":"Visão Geral","href":"/api-reference/checkout/transacoes/introduction"},{"openapi":"get /{alias}/checkout/transactions","title":"Listar transações de pedidos","href":"/api-reference/checkout/transacoes/listar-transacoes-de-pedidos"},{"openapi":"get /{alias}/checkout/transactions/{id}","title":"Visualizar transação de pedido","href":"/api-reference/checkout/transacoes/visualizar-transacao-de-pedido"},{"openapi":"get /{alias}/checkout/transactions/{id}/logs","title":"Listar logs de uma transação","href":"/api-reference/checkout/transacoes/listar-logs-de-uma-transacao"},{"openapi":"put /{alias}/checkout/transactions/{id}/payment/confirm","title":"Confirmar uma transação de boleto ou depósito","href":"/api-reference/checkout/transacoes/confirmar-uma-transacao-de-boleto-ou-deposito"},{"openapi":"put /{alias}/checkout/transactions/{id}/payment/cancel","title":"Cancelar uma transação de boleto ou depósito","href":"/api-reference/checkout/transacoes/cancelar-uma-transacao-de-boleto-ou-deposito"},{"openapi":"put /{alias}/checkout/transactions/{id}/payment/gateway/capture","title":"Capturar uma transação de cartão de crédito","href":"/api-reference/checkout/transacoes/capturar-uma-transacao-de-cartao-de-credito"},{"openapi":"put /{alias}/checkout/transactions/{id}/payment/gateway/cancel","title":"Cancelar uma transação de cartão de crédito","href":"/api-reference/checkout/transacoes/cancelar-uma-transacao-de-cartao-de-credito"}]}]},{"group":"Configurações","pages":[{"group":"IPs bloqueados","pages":[{"openapi":"get /{alias}/config/blocked-ips","title":"Listar IPs bloqueados","href":"/api-reference/configuracoes/ips-bloqueados/listar-ips-bloqueados"},{"openapi":"post /{alias}/config/blocked-ips","title":"Criar bloqueio de IP","href":"/api-reference/configuracoes/ips-bloqueados/criar-bloqueio-de-ip"},{"openapi":"get /{alias}/config/blocked-ips/{id}","title":"Visualizar bloqueio de IP","href":"/api-reference/configuracoes/ips-bloqueados/visualizar-bloqueio-de-ip"},{"openapi":"put /{alias}/config/blocked-ips/{id}","title":"Atualizar bloqueio de IP","href":"/api-reference/configuracoes/ips-bloqueados/atualizar-bloqueio-de-ip"},{"openapi":"delete /{alias}/config/blocked-ips/{id}","title":"Excluir bloqueio de IP","href":"/api-reference/configuracoes/ips-bloqueados/excluir-bloqueio-de-ip"}]},{"group":"Carrinhos abandonados","pages":[{"openapi":"get /{alias}/config/carts","title":"Listar configurações de carrinhos abandonados","href":"/api-reference/configuracoes/carrinhos-abandonados/listar-configuracoes-de-carrinhos-abandonados"},{"openapi":"post /{alias}/config/carts","title":"Criar configuração de carrinho abandonado","href":"/api-reference/configuracoes/carrinhos-abandonados/criar-configuracao-de-carrinho-abandonado"},{"openapi":"get /{alias}/config/carts/{id}","title":"Visualizar configuração de carrinho abandonado","href":"/api-reference/configuracoes/carrinhos-abandonados/visualizar-configuracao-de-carrinho-abandonado"},{"openapi":"put /{alias}/config/carts/{id}","title":"Atualizar configuração de carrinho abandonado","href":"/api-reference/configuracoes/carrinhos-abandonados/atualizar-configuracao-de-carrinho-abandonado"}]},{"group":"Checkout","pages":[{"openapi":"get /{alias}/config/checkout","title":"Listar configuração do checkout","href":"/api-reference/configuracoes/checkout/listar-configuracao-do-checkout"},{"openapi":"put /{alias}/config/checkout/{id}","title":"Atualizar configuração do checkout","href":"/api-reference/configuracoes/checkout/atualizar-configuracao-do-checkout"}]},{"group":"Credenciais da loja","pages":[{"openapi":"get /{alias}/config/merchant-credentials","title":"Listar credenciais da loja","href":"/api-reference/configuracoes/credenciais-da-loja/listar-credenciais-da-loja"}]},{"group":"Dados da loja","pages":[{"openapi":"get /{alias}/config/merchant-data","title":"Listar dados da loja","href":"/api-reference/configuracoes/dados-da-loja/listar-dados-da-loja"},{"openapi":"put /{alias}/config/merchant-data/{id}","title":"Atualizar dados da loja","href":"/api-reference/configuracoes/dados-da-loja/atualizar-dados-da-loja"}]},{"group":"Overview","pages":[{"openapi":"get /{alias}/config/overview/v1","title":"Visualizar overview das configurações","href":"/api-reference/configuracoes/overview/visualizar-overview-das-configuracoes"}]},{"group":"Fotos","pages":[{"openapi":"get /{alias}/config/photos","title":"Listar configurações de fotos","href":"/api-reference/configuracoes/fotos/listar-configuracoes-de-fotos"},{"openapi":"post /{alias}/config/photos","title":"Criar configuração de foto","href":"/api-reference/configuracoes/fotos/criar-configuracao-de-foto"},{"openapi":"get /{alias}/config/photos/{id}","title":"Visualizar configuração de foto","href":"/api-reference/configuracoes/fotos/visualizar-configuracao-de-foto"},{"openapi":"put /{alias}/config/photos/{id}","title":"Atualizar configuração de foto","href":"/api-reference/configuracoes/fotos/atualizar-configuracao-de-foto"}]},{"group":"Integrações","pages":[{"openapi":"put /{alias}/config/services/{serviceAlias}/settings/{id}","title":"Atualizar configuração de um serviço","href":"/api-reference/configuracoes/integracoes/atualizar-configuracao-de-um-servico"},{"openapi":"delete /{alias}/config/services/{serviceAlias}/settings/{id}","title":"Excluir configuração de um serviço","href":"/api-reference/configuracoes/integracoes/excluir-configuracao-de-um-servico"},{"openapi":"get /{alias}/config/services","title":"Listar todos os serviços disponíveis","href":"/api-reference/configuracoes/integracoes/listar-todos-os-servicos-disponiveis"},{"openapi":"get /{alias}/config/services/{serviceAlias}","title":"Visualizar serviço","href":"/api-reference/configuracoes/integracoes/visualizar-servico"}]},{"group":"E-mails","pages":[{"openapi":"get /{alias}/config/emails","title":"Listar configurações de e-mails","href":"/api-reference/configuracoes/emails/listar-configuracoes-de-e-mails"},{"openapi":"post /{alias}/config/emails","title":"Criar configuração de email","href":"/api-reference/configuracoes/emails/criar-configuracao-de-email"},{"openapi":"get /{alias}/config/emails/{id}","title":"Visualizar configuração de email","href":"/api-reference/configuracoes/emails/visualizar-configuracao-de-email"},{"openapi":"put /{alias}/config/emails/{id}","title":"Atualizar configuração de email","href":"/api-reference/configuracoes/emails/atualizar-configuracao-de-email"}]}]},{"group":"Conteúdo","pages":[{"group":"Páginas","pages":[{"openapi":"get /{alias}/content/pages","title":"Listar páginas","href":"/api-reference/conteudo/paginas/listar-paginas"},{"openapi":"post /{alias}/content/pages","title":"Criar página","href":"/api-reference/conteudo/paginas/criar-pagina"},{"openapi":"get /{alias}/content/pages/{id}","title":"Visualizar página","href":"/api-reference/conteudo/paginas/visualizar-pagina"},{"openapi":"put /{alias}/content/pages/{id}","title":"Atualizar página","href":"/api-reference/conteudo/paginas/atualizar-pagina"},{"openapi":"delete /{alias}/content/pages/{id}","title":"Excluir página","href":"/api-reference/conteudo/paginas/excluir-pagina"}]},{"group":"Redirecionamentos","pages":[{"openapi":"get /{alias}/content/redirects","title":"Listar redirecionamentos","href":"/api-reference/conteudo/redirecionamentos/listar-redirecionamentos"},{"openapi":"post /{alias}/content/redirects","title":"Criar redirecionamento","href":"/api-reference/conteudo/redirecionamentos/criar-redirecionamento"},{"openapi":"get /{alias}/content/redirects/{id}","title":"Visualizar detalhes de um redirecionamento","href":"/api-reference/conteudo/redirecionamentos/visualizar-detalhes-de-um-redirecionamento"},{"openapi":"put /{alias}/content/redirects/{id}","title":"Atualizar redirecionamento","href":"/api-reference/conteudo/redirecionamentos/atualizar-redirecionamento"},{"openapi":"delete /{alias}/content/redirects/{id}","title":"Excluir redirecionamento","href":"/api-reference/conteudo/redirecionamentos/excluir-redirecionamento"},{"openapi":"post /{alias}/content/redirects/batch","title":"Criar redirecionamentos em batch","href":"/api-reference/conteudo/redirecionamentos/criar-redirecionamentos-em-batch"}]}]},{"group":"Clientes","pages":[{"group":"Cliente","pages":[{"openapi":"get /{alias}/customers","title":"Listar clientes","href":"/api-reference/clientes/cliente/listar-clientes"},{"openapi":"post /{alias}/customers","title":"Criar cliente","href":"/api-reference/clientes/cliente/criar-cliente"},{"openapi":"get /{alias}/customers/{id}","title":"Visualizar cliente","href":"/api-reference/clientes/cliente/visualizar-cliente"},{"openapi":"put /{alias}/customers/{id}","title":"Atualizar cliente","href":"/api-reference/clientes/cliente/atualizar-cliente"},{"openapi":"delete /{alias}/customers/{id}","title":"Excluir cliente","href":"/api-reference/clientes/cliente/excluir-cliente"},{"openapi":"get /{alias}/customers/{id}/carts","title":"Listar carrinhos abandonados de um cliente","href":"/api-reference/clientes/cliente/listar-carrinhos-abandonados-de-um-cliente"},{"openapi":"get /{alias}/customers/filters","title":"Listar filtros de busca de clientes","href":"/api-reference/clientes/cliente/listar-filtros-de-busca-de-clientes"},{"openapi":"put /{alias}/customers/{id}/tags","title":"Sincronizar as tags de um cliente","href":"/api-reference/clientes/cliente/sincronizar-as-tags-de-um-cliente"},{"openapi":"post /{alias}/customers/{id}/tags","title":"Adicionar tags a um cliente","href":"/api-reference/clientes/cliente/adicionar-tags-a-um-cliente"}]},{"group":"Clusters","pages":[{"openapi":"get /{alias}/customers/clusters","title":"Listar clusters","href":"/api-reference/clientes/clusters/listar-clusters"},{"openapi":"post /{alias}/customers/clusters","title":"Criar cluster de clientes","href":"/api-reference/clientes/clusters/criar-cluster-de-clientes"},{"openapi":"get /{alias}/customers/clusters/{id}","title":"Visualizar clusters","href":"/api-reference/clientes/clusters/visualizar-clusters"},{"openapi":"put /{alias}/customers/clusters/{id}","title":"Atualizar cluster de clientes","href":"/api-reference/clientes/clusters/atualizar-cluster-de-clientes"},{"openapi":"get /{alias}/customers/clusters/{id}/customers","title":"Listar clientes associados a um cluster","href":"/api-reference/clientes/clusters/listar-clientes-associados-a-um-cluster"}]},{"group":"Regras de frete dos clusters","pages":[{"openapi":"get /{alias}/customers/clusters/{clusterId}/shipping-rules","title":"Listar regras de frete","href":"/api-reference/clientes/clusters/regras-de-frete-dos-clusters/listar-regras-de-frete"},{"openapi":"post /{alias}/customers/clusters/{clusterId}/shipping-rules","title":"Criar regra de frete","href":"/api-reference/clientes/clusters/regras-de-frete-dos-clusters/criar-regra-de-frete"},{"openapi":"get /{alias}/customers/clusters/{clusterId}/shipping-rules/{id}","title":"Visualizar regra de frete","href":"/api-reference/clientes/clusters/regras-de-frete-dos-clusters/visualizar-regra-de-frete"},{"openapi":"put /{alias}/customers/clusters/{clusterId}/shipping-rules/{id}","title":"Atualizar regra de frete","href":"/api-reference/clientes/clusters/regras-de-frete-dos-clusters/atualizar-regra-de-frete"}]},{"group":"Endereços","pages":[{"openapi":"get /{alias}/customers/{customerId}/addresses","title":"Listar endereços de um cliente","href":"/api-reference/clientes/enderecos/listar-enderecos-de-um-cliente"},{"openapi":"post /{alias}/customers/{customerId}/addresses","title":"Criar endereço do cliente","href":"/api-reference/clientes/enderecos/criar-endereco-do-cliente"},{"openapi":"get /{alias}/customers/{customerId}/addresses/{id}","title":"Visualizar endereço do cliente","href":"/api-reference/clientes/enderecos/visualizar-endereco-do-cliente"},{"openapi":"put /{alias}/customers/{customerId}/addresses/{id}","title":"Atualizar endereço do cliente","href":"/api-reference/clientes/enderecos/atualizar-endereco-do-cliente"},{"openapi":"delete /{alias}/customers/{customerId}/addresses/{id}","title":"Excluir endereço do cliente","description":"Exclui um endereço específico de um cliente","href":"/api-reference/clientes/enderecos/excluir-endereco-do-cliente"}]}]},{"group":"Descontos","pages":[{"openapi":"get /{alias}/discounts","title":"Listar descontos da loja","href":"/api-reference/descontos/listar-descontos-da-loja"},{"openapi":"post /{alias}/discounts","title":"Criar um desconto da loja","description":"Cria um desconto na loja","href":"/api-reference/descontos/criar-um-desconto-da-loja"},{"openapi":"get /{alias}/discounts/{id}","title":"Visualizar um desconto da loja","href":"/api-reference/descontos/visualizar-um-desconto-da-loja"},{"openapi":"delete /{alias}/discounts/{id}","title":"Excluir um desconto da loja","href":"/api-reference/descontos/excluir-um-desconto-da-loja"},{"openapi":"delete /{alias}/discounts/batch-delete","title":"Excluir todos os descontos da loja em massa","href":"/api-reference/descontos/excluir-todos-os-descontos-da-loja-em-massa"},{"openapi":"put /{alias}/discounts/{id}","title":"Atualizar um desconto da loja","href":"/api-reference/descontos/atualizar-um-desconto-da-loja"},{"openapi":"get /{alias}/discounts/filters","title":"Listar filtros de busca de descontos","href":"/api-reference/descontos/listar-filtros-de-busca-de-descontos"}]},{"group":"Leads","pages":[{"openapi":"get /{alias}/leads","title":"Listar leads","href":"/api-reference/leads/listar-leads"},{"openapi":"post /{alias}/leads","title":"Criar um novo lead","href":"/api-reference/leads/criar-um-novo-lead"},{"openapi":"get /{alias}/leads/{id}","title":"Visualizar lead","href":"/api-reference/leads/visualizar-lead"},{"openapi":"put /{alias}/leads/{id}","title":"Atualizar lead","href":"/api-reference/leads/atualizar-lead"},{"openapi":"delete /{alias}/leads/{id}","title":"Excluir lead","href":"/api-reference/leads/excluir-lead"},{"openapi":"get /{alias}/leads/filters","title":"Listar filtros de busca dos leads","href":"/api-reference/leads/listar-filtros-de-busca-dos-leads"}]},{"group":"Logística","pages":[{"group":"API de Frete","pages":[{"title":"Visão geral","href":"/api-reference/logistica/api-de-frete/introduction"},{"openapi":"get /{alias}/logistics/apis","title":"Listar API de Frete","href":"/api-reference/logistica/api-de-frete/listar-api-de-frete"},{"openapi":"post /{alias}/logistics/apis","title":"Criar API de Frete","href":"/api-reference/logistica/api-de-frete/criar-api-de-frete"},{"openapi":"get /{alias}/logistics/apis/{id}","title":"Visualizar API de Frete","href":"/api-reference/logistica/api-de-frete/visualizar-api-de-frete"},{"openapi":"put /{alias}/logistics/apis/{id}","title":"Atualizar API de Frete","href":"/api-reference/logistica/api-de-frete/atualizar-api-de-frete"},{"openapi":"delete /{alias}/logistics/apis/{id}","title":"Excluir API de Frete","href":"/api-reference/logistica/api-de-frete/excluir-api-de-frete"}]},{"group":"Embalagens","pages":[{"openapi":"get /{alias}/logistics/boxes","title":"Listar embalagens","href":"/api-reference/logistica/embalagens/listar-embalagens"},{"openapi":"post /{alias}/logistics/boxes","title":"Criar embalagem","href":"/api-reference/logistica/embalagens/criar-embalagem"},{"openapi":"get /{alias}/logistics/boxes/{id}","title":"Visualizar embalagem","href":"/api-reference/logistica/embalagens/visualizar-embalagem"},{"openapi":"put /{alias}/logistics/boxes/{id}","title":"Atualizar embalagem","href":"/api-reference/logistica/embalagens/atualizar-embalagem"},{"openapi":"delete /{alias}/logistics/boxes/{id}","title":"Excluir embalagem","href":"/api-reference/logistica/embalagens/excluir-embalagem"}]},{"group":"Preços de frete","pages":[{"openapi":"get /{alias}/logistics/carriers/{carrierId}/prices","title":"Listar preços de uma transportadora","href":"/api-reference/logistica/precos-de-frete/listar-precos-de-uma-transportadora"},{"openapi":"post /{alias}/logistics/carriers/{carrierId}/prices","title":"Criar preço para uma transportadora","href":"/api-reference/logistica/precos-de-frete/criar-preco-para-uma-transportadora"},{"openapi":"get /{alias}/logistics/carriers/{carrierId}/prices/{id}","title":"Visualizar preço","href":"/api-reference/logistica/precos-de-frete/visualizar-preco"},{"openapi":"put /{alias}/logistics/carriers/{carrierId}/prices/{id}","title":"Atualizar preço","href":"/api-reference/logistica/precos-de-frete/atualizar-preco"},{"openapi":"delete /{alias}/logistics/carriers/{carrierId}/prices/{id}","title":"Excluir preço","href":"/api-reference/logistica/precos-de-frete/excluir-preco"}]},{"group":"Transportadoras","pages":[{"openapi":"get /{alias}/logistics/carriers","title":"Listar transportadoras","href":"/api-reference/logistica/transportadoras/listar-transportadoras"},{"openapi":"post /{alias}/logistics/carriers","title":"Criar transportadora","href":"/api-reference/logistica/transportadoras/criar-transportadora"},{"openapi":"get /{alias}/logistics/carriers/{id}","title":"Visualizar transportadora","href":"/api-reference/logistica/transportadoras/visualizar-transportadora"},{"openapi":"put /{alias}/logistics/carriers/{id}","title":"Atualizar transportadora","href":"/api-reference/logistica/transportadoras/atualizar-transportadora"},{"openapi":"delete /{alias}/logistics/carriers/{id}","title":"Excluir transportadora","href":"/api-reference/logistica/transportadoras/excluir-transportadora"}]},{"group":"Países","pages":[{"openapi":"get /{alias}/logistics/countries","title":"Listar países","href":"/api-reference/logistica/paises/listar-paises"}]},{"group":"Simular frete","pages":[{"openapi":"post /{alias}/logistics/shipping-costs","title":"Simular frete de um pedido","href":"/api-reference/logistica/simular-frete/simular-frete-de-um-pedido"}]},{"group":"Reservas de estoque","pages":[{"openapi":"get /{alias}/logistics/stock-reservations","title":"Listar reserva de estoque","href":"/api-reference/logistica/reservas-de-estoque/listar-reserva-de-estoque"},{"openapi":"get /{alias}/logistics/stock-reservations/{id}","title":"Visualizar reserva de estoque","href":"/api-reference/logistica/reservas-de-estoque/visualizar-reserva-de-estoque"}]},{"group":"Estoques","pages":[{"openapi":"get /{alias}/logistics/stocks","title":"Listar estoques","href":"/api-reference/logistica/estoques/listar-estoques"},{"openapi":"post /{alias}/logistics/stocks","title":"Criar estoque","href":"/api-reference/logistica/estoques/criar-estoque"},{"openapi":"get /{alias}/logistics/stocks/{id}","title":"Visualizar estoque","href":"/api-reference/logistica/estoques/visualizar-estoque"},{"openapi":"put /{alias}/logistics/stocks/{id}","title":"Atualizar estoque","href":"/api-reference/logistica/estoques/atualizar-estoque"},{"openapi":"delete /{alias}/logistics/stocks/{id}","title":"Excluir estoque","href":"/api-reference/logistica/estoques/excluir-estoque"}]},{"group":"Armazéns","pages":[{"openapi":"get /{alias}/logistics/warehouses","title":"Listar armazéns","href":"/api-reference/logistica/armazens/listar-armazens"},{"openapi":"post /{alias}/logistics/warehouses","title":"Criar armazéns","href":"/api-reference/logistica/armazens/criar-armazens"},{"openapi":"get /{alias}/logistics/warehouses/{id}","title":"Visualizar armazém","href":"/api-reference/logistica/armazens/visualizar-armazem"},{"openapi":"put /{alias}/logistics/warehouses/{id}","title":"Atualizar armazém","href":"/api-reference/logistica/armazens/atualizar-armazem"},{"openapi":"delete /{alias}/logistics/warehouses/{id}","title":"Excluir armazém","href":"/api-reference/logistica/armazens/excluir-armazem"}]},{"group":"CEP","pages":[{"openapi":"get /{alias}/logistics/zipcode/{zipcode}","title":"Consultar CEP","href":"/api-reference/logistica/cep/consultar-cep"}]},{"group":"Calcular frete","pages":[{"openapi":"post /{alias}/logistics/shipping-costs","title":"Simular frete de um pedido","href":"/api-reference/logistica/calcular-frete/simular-frete-de-um-pedido"}]}]},{"group":"Marketing","pages":[{"group":"Banners","pages":[{"openapi":"get /{alias}/marketing/banners","title":"Listar banners","href":"/api-reference/marketing/listar-banners"},{"openapi":"post /{alias}/marketing/banners","title":"Criar banner","href":"/api-reference/marketing/criar-banner"},{"openapi":"get /{alias}/marketing/banners/{id}","title":"Visualizar banner","href":"/api-reference/marketing/visualizar-banner"},{"openapi":"put /{alias}/marketing/banners/{id}","title":"Ordenar ou atualizar banner","href":"/api-reference/marketing/ordenar-ou-atualizar-banner"},{"openapi":"delete /{alias}/marketing/banners/{id}","title":"Excluir banner","href":"/api-reference/marketing/excluir-banner"},{"openapi":"get /{alias}/marketing/banners/{id}/categories","title":"Listar categorias que o banner pertence","href":"/api-reference/marketing/listar-categorias-que-o-banner-pertence"},{"openapi":"get /{alias}/marketing/banners/{id}/promotions","title":"Listar promoções que o banner pertence","href":"/api-reference/marketing/listar-promoções-que-o-banner-pertence"},{"openapi":"get /{alias}/marketing/banners/{id}/collections","title":"Listar coleções que o banner pertence","href":"/api-reference/marketing/listar-coleções-que-o-banner-pertence"}]},{"openapi":"get /{alias}/marketing/banners/{id}/promotions","title":"Listar promoções que o banner pertence","href":"/api-reference/marketing/listar-promocoes-que-o-banner-pertence"},{"openapi":"get /{alias}/marketing/banners/{id}/collections","title":"Listar coleções que o banner pertence","href":"/api-reference/marketing/listar-colecoes-que-o-banner-pertence"},{"group":"Brindes","pages":[{"openapi":"get /{alias}/pricing/freebies","title":"Listar todos os Brindes de uma loja","href":"/api-reference/marketing/brindes/listar-todos-os-brindes-de-uma-loja"},{"openapi":"post /{alias}/pricing/freebies","title":"Criar novo Brinde","href":"/api-reference/marketing/brindes/criar-novo-brinde"},{"openapi":"get /{alias}/pricing/freebies/{id}","title":"Visualizar os Brindes de uma loja","href":"/api-reference/marketing/brindes/visualizar-os-brindes-de-uma-loja"},{"openapi":"put /{alias}/pricing/freebies/{id}","title":"Atualizar um Brinde","href":"/api-reference/marketing/brindes/atualizar-um-brinde"},{"openapi":"delete /{alias}/pricing/freebies/{id}","title":"Excluir um Brinde","href":"/api-reference/marketing/brindes/excluir-um-brinde"},{"openapi":"delete /{alias}/pricing/freebies/batch-delete","title":"Excluir todos os Brindes em lote","href":"/api-reference/marketing/brindes/excluir-todos-os-brindes-em-lote"}]}]},{"group":"Pedidos","pages":[{"group":"Endereços","pages":[{"openapi":"get /{alias}/orders/{orderId}/addresses","title":"Listar endereços de um pedido","href":"/api-reference/pedidos/enderecos/listar-enderecos-de-um-pedido"},{"openapi":"get /{alias}/orders/{orderId}/addresses/{addressId}","title":"Visualizar endereço de um pedido","href":"/api-reference/pedidos/enderecos/visualizar-endereco-de-um-pedido"},{"openapi":"put /{alias}/orders/{orderId}/addresses/{addressId}","title":"Atualizar o endereço de entrega do pedido","href":"/api-reference/pedidos/enderecos/atualizar-o-endereco-de-entrega-do-pedido"}]},{"group":"Comentários","pages":[{"openapi":"get /{alias}/orders/{orderId}/comments","title":"Listar comentários","href":"/api-reference/pedidos/comentarios/listar-comentarios"},{"openapi":"post /{alias}/orders/{orderId}/comments","title":"Criar comentário de pedido","href":"/api-reference/pedidos/comentarios/criar-comentario-de-pedido"},{"openapi":"get /{alias}/orders/{orderId}/comments/{commentId}","title":"Visualizar detalhes de um comentário de pedido","href":"/api-reference/pedidos/comentarios/visualizar-detalhes-de-um-comentario-de-pedido"},{"openapi":"put /{alias}/orders/{orderId}/comments/{commentId}","title":"Atualizar comentário de um pedido","href":"/api-reference/pedidos/comentarios/atualizar-comentario-de-um-pedido"},{"openapi":"delete /{alias}/orders/{orderId}/comments/{commentId}","title":"Excluir um comentário de pedido","href":"/api-reference/pedidos/comentarios/excluir-um-comentario-de-pedido"}]},{"group":"Notas fiscais","pages":[{"openapi":"get /{alias}/orders/{orderId}/invoices","title":"Listar notas fiscais","href":"/api-reference/pedidos/notas-fiscais/listar-notas-fiscais"},{"openapi":"post /{alias}/orders/{orderId}/invoices","title":"Criar uma nota fiscal","href":"/api-reference/pedidos/notas-fiscais/criar-uma-nota-fiscal"},{"openapi":"get /{alias}/orders/{orderId}/invoices/{invoiceId}","title":"Visualizar detalhes de uma nota fiscal","href":"/api-reference/pedidos/notas-fiscais/visualizar-detalhes-de-uma-nota-fiscal"},{"openapi":"put /{alias}/orders/{orderId}/invoices/{invoiceId}","title":"Atualizar uma nota fiscal","href":"/api-reference/pedidos/notas-fiscais/atualizar-uma-nota-fiscal"},{"openapi":"delete /{alias}/orders/{orderId}/invoices/{invoiceId}","title":"Excluir uma nota fiscal","href":"/api-reference/pedidos/notas-fiscais/excluir-uma-nota-fiscal"}]},{"group":"Etiquetas","pages":[{"openapi":"get /{alias}/orders/{orderId}/labels","title":"Listar etiquetas de um pedido","href":"/api-reference/pedidos/etiquetas/listar-etiquetas-de-um-pedido"},{"openapi":"post /{alias}/orders/{orderId}/labels","title":"Criar etiqueta","href":"/api-reference/pedidos/etiquetas/criar-etiqueta"},{"openapi":"get /{alias}/orders/{orderId}/labels/{labelId}","title":"Visualizar detalhes de uma etiqueta","href":"/api-reference/pedidos/etiquetas/visualizar-detalhes-de-uma-etiqueta"},{"openapi":"put /{alias}/orders/{orderId}/labels/{labelId}","title":"Atualizar etiqueta","href":"/api-reference/pedidos/etiquetas/atualizar-etiqueta"},{"openapi":"delete /{alias}/orders/{orderId}/labels/{labelId}","title":"Excluir etiqueta","href":"/api-reference/pedidos/etiquetas/excluir-etiqueta"}]},{"group":"Rastreamento","pages":[{"openapi":"get /{alias}/orders/{orderId}/tracking","title":"Exibir rastreamento","href":"/api-reference/pedidos/rastreamento/exibir-rastreamento"},{"openapi":"post /{alias}/orders/{orderId}/tracking","title":"Criar status de rastreamento","href":"/api-reference/pedidos/rastreamento/criar-status-de-rastreamento"},{"openapi":"get /{alias}/orders/{id}/tracking","title":"Rastrear pedido","href":"/api-reference/pedidos/rastreamento/rastrear-pedido"}]},{"group":"Emails","pages":[{"openapi":"get /{alias}/orders/{orderId}/emails","title":"Listar e-mails","href":"/api-reference/pedidos/emails/listar-e-mails"},{"openapi":"get /{alias}/orders/{orderId}/emails/{messageId}","title":"Visualizar e-mail","href":"/api-reference/pedidos/emails/visualizar-e-mail"}]},{"group":"Pedido","pages":[{"title":"Visão Geral","href":"/api-reference/pedidos/pedido/introduction"},{"openapi":"get /{alias}/orders","title":"Listar pedidos","href":"/api-reference/pedidos/pedido/listar-pedidos"},{"openapi":"post /{alias}/orders","title":"Criar pedido","href":"/api-reference/pedidos/pedido/criar-pedido"},{"openapi":"get /{alias}/orders/{id}","title":"Visualizar detalhes de um pedido","href":"/api-reference/pedidos/pedido/visualizar-detalhes-de-um-pedido"},{"openapi":"put /{alias}/orders/{id}","title":"Atualizar pedido","href":"/api-reference/pedidos/pedido/atualizar-pedido"},{"openapi":"get /{alias}/orders/{id}/transactions","title":"Listar transações de um pedido","href":"/api-reference/pedidos/pedido/listar-transacoes-de-um-pedido"},{"openapi":"get /{alias}/orders/{id}/items","title":"Listar produtos de um pedido","href":"/api-reference/pedidos/pedido/listar-produtos-de-um-pedido"},{"openapi":"get /{alias}/orders/{id}/statuses","title":"Listar histórico de status de um pedido","href":"/api-reference/pedidos/pedido/listar-historico-de-status-de-um-pedido"},{"openapi":"get /{alias}/orders/{id}/boxes","title":"Listar embalagens de um pedido","href":"/api-reference/pedidos/pedido/listar-embalagens-de-um-pedido"},{"openapi":"get /{alias}/orders/export","title":"Exportar pedidos","href":"/api-reference/pedidos/pedido/exportar-pedidos"},{"openapi":"get /{alias}/orders/filters","title":"Listar filtros de busca de pedidos","href":"/api-reference/pedidos/pedido/listar-filtros-de-busca-de-pedidos"},{"openapi":"get /{alias}/html/orders/{id}/content-statement/{token}","title":"Gerar declaração de conteúdo de um pedido","href":"/api-reference/pedidos/pedido/gerar-declaracao-de-conteudo-de-um-pedido"},{"openapi":"get /{alias}/orders/export/{service}","title":"Exportar pedidos para um determinado serviço","href":"/api-reference/pedidos/pedido/exportar-pedidos-para-um-determinado-servico"},{"openapi":"put /{alias}/orders/{id}/tags","title":"Sincronizar as tags de um pedido","href":"/api-reference/pedidos/pedido/sincronizar-as-tags-de-um-pedido"},{"openapi":"post /{alias}/orders/{id}/tags","title":"Adicionar tags a um pedido","href":"/api-reference/pedidos/pedido/adicionar-tags-a-um-pedido"}]}]},{"group":"Sistema","pages":[{"openapi":"get /ping","title":"Endpoint de Ping","href":"/api-reference/sistema/endpoint-de-ping"}]},{"group":"Promoções","pages":[{"group":"Combos","pages":[{"openapi":"get /{alias}/pricing/combos","title":"Listar combos de produtos","href":"/api-reference/promocoes/combos/listar-combos-de-produtos"},{"openapi":"post /{alias}/pricing/combos","title":"Criar combo de produtos","href":"/api-reference/promocoes/combos/criar-combo-de-produtos"},{"openapi":"get /{alias}/pricing/combos/{id}","title":"Visualizar combo de produtos","href":"/api-reference/promocoes/combos/visualizar-combo-de-produtos"},{"openapi":"put /{alias}/pricing/combos/{id}","title":"Atualizar combo de produtos","href":"/api-reference/promocoes/combos/atualizar-combo-de-produtos"},{"openapi":"delete /{alias}/pricing/combos/{id}","title":"Excluir combo de produtos","href":"/api-reference/promocoes/combos/excluir-combo-de-produtos"}]},{"group":"Cashback","pages":[{"openapi":"POST /{alias}/pricing/cashbacks/rules","title":"Criar regra de cashback","href":"/api-reference/cashback/rules/criar-regras-cashback"},{"openapi":"GET /{alias}/pricing/cashbacks/rules","title":"Visualizar Regra de Cashback","href":"/api-reference/cashback/rules/listar-regras-cashback"},{"openapi":"GET /{alias}/pricing/cashbacks","title":"Listar Cashbacks","href":"/api-reference/cashback/listar-cashbacks"},{"title":"Criar Cashbacks","openapi":"POST /{alias}/pricing/cashbacks","href":"/api-reference/cashback/criar-cashbacks"},{"openapi":"GET /{alias}/pricing/cashbacks/{id}","title":"Visualizar Cashback","href":"/api-reference/cashback/visualizar-cashbacks"},{"openapi":"PUT /{alias}/pricing/cashbacks/{id}","title":"Atualizar cashback","href":"/api-reference/cashback/atualizar-cashbacks"},{"openapi":"DELETE /{alias}/pricing/cashbacks/{id}","title":"Deletar um cashback","href":"/api-reference/cashback/excluir-cashbacks"}]},{"group":"Frete grátis","pages":[{"openapi":"get /{alias}/pricing/free-shipment","title":"Listar regras de frete grátis","href":"/api-reference/promocoes/frete-gratis/listar-regras-de-frete-gratis"},{"openapi":"post /{alias}/pricing/free-shipment","title":"Criar ou atualizar regras de frete grátis","href":"/api-reference/promocoes/frete-gratis/criar-ou-atualizar-regras-de-frete-gratis"}]},{"group":"Desconto progressivo","pages":[{"openapi":"get /{alias}/pricing/progressive-discounts","title":"Listar descontos progressivos","href":"/api-reference/promocoes/desconto-progressivo/listar-descontos-progressivos"},{"openapi":"post /{alias}/pricing/progressive-discounts","title":"Criar desconto progressivo","href":"/api-reference/promocoes/desconto-progressivo/criar-desconto-progressivo"}]},{"group":"Upsells","pages":[{"openapi":"get /{alias}/pricing/upsells","title":"Listar upsells","href":"/api-reference/promocoes/upsells/listar-upsells"},{"openapi":"post /{alias}/pricing/upsells","title":"Criar upsell","href":"/api-reference/promocoes/upsells/criar-upsell"},{"openapi":"get /{alias}/pricing/upsells/{id}","title":"Visualizar um upsell","href":"/api-reference/promocoes/upsells/visualizar-um-upsell"},{"openapi":"put /{alias}/pricing/upsells/{id}","title":"Atualizar um upsell","href":"/api-reference/promocoes/upsells/atualizar-um-upsell"},{"openapi":"delete /{alias}/pricing/upsells/{id}","title":"Deletar Upsell","href":"/api-reference/promocoes/upsells/deletar-upsell"}]},{"group":"Cupons","pages":[{"openapi":"get /{alias}/pricing/promocodes","title":"Listar cupons","href":"/api-reference/promocoes/cupons/listar-cupons"},{"openapi":"post /{alias}/pricing/promocodes","title":"Criar cupom","href":"/api-reference/promocoes/cupons/criar-cupom"},{"openapi":"get /{alias}/pricing/promocodes/{id}","title":"Visualizar cupom","href":"/api-reference/promocoes/cupons/visualizar-cupom"},{"openapi":"put /{alias}/pricing/promocodes/{id}","title":"Atualizar cupom","href":"/api-reference/promocoes/cupons/atualizar-cupom"},{"openapi":"delete /{alias}/pricing/promocodes/{id}","title":"Excluir cupom","href":"/api-reference/promocoes/cupons/excluir-cupom"},{"openapi":"get /{alias}/pricing/promocodes/{id}/customers","title":"Listar clientes que usaram o cupom","href":"/api-reference/promocoes/cupons/listar-clientes-que-usaram-o-cupom"}]},{"group":"Promoção","pages":[{"openapi":"get /{alias}/pricing/promotions","title":"Listar promoções","href":"/api-reference/promocoes/promocao/listar-promocoes"},{"openapi":"post /{alias}/pricing/promotions","title":"Criar promoção","href":"/api-reference/promocoes/promocao/criar-promocao"},{"openapi":"get /{alias}/pricing/promotions/{id}","title":"Visualizar promoção","href":"/api-reference/promocoes/promocao/visualizar-promocao"},{"openapi":"put /{alias}/pricing/promotions/{id}","title":"Atualizar promoção","href":"/api-reference/promocoes/promocao/atualizar-promocao"},{"openapi":"delete /{alias}/pricing/promotions/{id}","title":"Excluir promoção","href":"/api-reference/promocoes/promocao/excluir-promocao"},{"openapi":"get /{alias}/pricing/promotions/{id}/products","title":"Listar produtos da promoção","href":"/api-reference/promocoes/promocao/listar-produtos-da-promocao"}]},{"group":"Produtos","pages":[{"openapi":"get /{alias}/pricing/promotions","title":"Listar promoções","href":"/api-reference/promocoes/produtos/listar-promocoes"},{"openapi":"post /{alias}/pricing/promotions","title":"Criar promoção","href":"/api-reference/promocoes/produtos/criar-promocao"},{"openapi":"get /{alias}/pricing/promotions/{id}","title":"Visualizar promoção","href":"/api-reference/promocoes/produtos/visualizar-promocao"},{"openapi":"put /{alias}/pricing/promotions/{id}","title":"Atualizar promoção","href":"/api-reference/promocoes/produtos/atualizar-promocao"},{"openapi":"delete /{alias}/pricing/promotions/{id}","title":"Excluir promoção","href":"/api-reference/promocoes/produtos/excluir-promocao"},{"openapi":"get /{alias}/pricing/promotions/{id}/products","title":"Listar produtos da promoção","href":"/api-reference/promocoes/produtos/listar-produtos-da-promocao"}]},{"group":"Order Bump","pages":[{"openapi":"get /{alias}/pricing/order-bumps","title":"Listar Order Bumps","href":"/api-reference/promocoes/orderbump/listar-order-bumps"},{"openapi":"get /{alias}/pricing/order-bumps/{id}","title":"Visualizar Order Bump","href":"/api-reference/promocoes/orderbump/visualizar-order-bump"},{"openapi":"put /{alias}/pricing/order-bumps/{id}","title":"Atualizar Order Bump","href":"/api-reference/promocoes/orderbump/atualizar-order-bump"},{"openapi":"delete /{alias}/pricing/order-bumps/{id}","title":"Deletar Order Bump","href":"/api-reference/promocoes/orderbump/deletar-order-bump"},{"openapi":"post /{alias}/pricing/order-bumps","title":"Criar Order Bump","href":"/api-reference/promocoes/orderbump/criar-order-bump"},{"openapi":"delete /{alias}/pricing/order-bumps/batch-delete","title":"Deletar todos os Order Bumps","href":"/api-reference/promocoes/orderbump/deletar-todos-os-order-bumps"},{"openapi":"put /{alias}/pricing/order-bumps/order","title":"Atualizar ordenação de Order Bumps","href":"/api-reference/promocoes/orderbump/atualizar-ordenacao-de-order-bumps"}]},{"group":"Carteira","pages":[{"openapi":"get /{alias}/pricing/wallet/statement/{customerID}","title":"Visualizar extrato de cashback","href":"/api-reference/promocoes/carteira/visualizar-extrato-de-cashback"},{"openapi":"get /{alias}/pricing/wallet/balance","title":"Visualizar saldo de cashback do cliente","href":"/api-reference/promocoes/carteira/visualizar-saldo-de-cashback-do-cliente"},{"openapi":"post /{alias}/pricing/wallet/transaction","title":"Criar transação na carteira de cashback","href":"/api-reference/promocoes/carteira/criar-transacao-na-carteira-de-cashback"}]}]},{"group":"Usuários","pages":[{"group":"Grupos","pages":[{"openapi":"get /{alias}/users/groups","title":"Listar grupos de usuários","href":"/api-reference/usuarios/grupos/listar-grupos-de-usuarios"},{"openapi":"post /{alias}/users/groups","title":"Criar grupo de usuários","href":"/api-reference/usuarios/grupos/criar-grupo-de-usuarios"},{"openapi":"get /{alias}/users/groups/{id}","title":"Visualizar grupo de usuários","href":"/api-reference/usuarios/grupos/visualizar-grupo-de-usuarios"},{"openapi":"put /{alias}/users/groups/{id}","title":"Atualizar grupo de usuários","href":"/api-reference/usuarios/grupos/atualizar-grupo-de-usuarios"},{"openapi":"delete /{alias}/users/groups/{id}","title":"Excluir grupo de usuários","href":"/api-reference/usuarios/grupos/excluir-grupo-de-usuarios"}]},{"group":"Convites","pages":[{"openapi":"get /{alias}/users/invites","title":"Listar convites de usuários","href":"/api-reference/usuarios/convites/listar-convites-de-usuarios"},{"openapi":"post /{alias}/users/invites","title":"Criar convite de usuário","href":"/api-reference/usuarios/convites/criar-convite-de-usuario"},{"openapi":"get /{alias}/users/invites/{id}","title":"Visualizar convite de usuário","href":"/api-reference/usuarios/convites/visualizar-convite-de-usuario"},{"openapi":"delete /{alias}/users/invites/{id}","title":"Excluir convite","href":"/api-reference/usuarios/convites/excluir-convite"},{"openapi":"get /{alias}/users/invites/{id}/resend","title":"Reenviar um convite de usuário","href":"/api-reference/usuarios/convites/reenviar-um-convite-de-usuario"}]},{"group":"Permissões","pages":[{"openapi":"get /{alias}/users/permissions","title":"Listar permissões","href":"/api-reference/usuarios/permissoes/listar-permissoes"},{"openapi":"get /{alias}/users/permissions/label","title":"Consultar labels das permissões","href":"/api-reference/usuarios/permissoes/consultar-labels-das-permissoes"}]},{"openapi":"post /auth/me","title":"Visualizar dados do usuário logado","href":"/api-reference/usuarios/visualizar-dados-do-usuario-logado"},{"openapi":"get /{alias}/users/{id}","title":"Visualizar detalhes de um usuário","href":"/api-reference/usuarios/visualizar-detalhes-de-um-usuario"}]},{"group":"Webhooks","pages":[{"title":"Visão Geral","href":"/api-reference/webhooks/introduction"},{"openapi":"get /{alias}/webhooks","title":"Listar webhooks","href":"/api-reference/webhooks/listar-webhooks"},{"openapi":"post /{alias}/webhooks","title":"Criar um webhook","href":"/api-reference/webhooks/criar-um-webhook"},{"openapi":"get /{alias}/webhooks/{id}","title":"Visualizar webhook","href":"/api-reference/webhooks/visualizar-webhook"},{"openapi":"put /{alias}/webhooks/{id}","title":"Atualizar um webhook","href":"/api-reference/webhooks/atualizar-um-webhook"},{"openapi":"delete /{alias}/webhooks/{id}","title":"Excluir um webhook","href":"/api-reference/webhooks/excluir-um-webhook"},{"openapi":"get /{alias}/webhooks/events","title":"Listar eventos de webhooks disponíveis","href":"/api-reference/webhooks/listar-eventos-de-webhooks-disponiveis"}]},{"group":"Loja Virtual","pages":[{"group":"Scripts","pages":[{"openapi":"get /{alias}/store/scripts","title":"Listar Scripts","href":"/api-reference/loja-virtual/scripts/listar-scripts"},{"openapi":"post /{alias}/store/scripts","title":"Cadastrar um novo Script","href":"/api-reference/loja-virtual/scripts/cadastrar-um-novo-script"},{"openapi":"get /{alias}/store/scripts/{id}","title":"Visualizar um Script","href":"/api-reference/loja-virtual/scripts/visualizar-um-script"},{"openapi":"put /{alias}/store/scripts/{id}","title":"Atualizar um Script","href":"/api-reference/loja-virtual/scripts/atualizar-um-script"},{"openapi":"delete /{alias}/store/scripts/{id}","title":"Excluir um Script","href":"/api-reference/loja-virtual/scripts/excluir-um-script"}]},{"group":"Arquivos do tema","pages":[{"openapi":"get /{alias}/store/theme/files","title":"Listar arquivos do tema","href":"/api-reference/loja-virtual/arquivos-do-tema/listar-arquivos-do-tema"},{"openapi":"put /{alias}/store/theme/files","title":"Atualizar arquivo do tema","href":"/api-reference/loja-virtual/arquivos-do-tema/atualizar-arquivo-do-tema"},{"openapi":"post /{alias}/store/theme/files","title":"Criar arquivo no tema","href":"/api-reference/loja-virtual/arquivos-do-tema/criar-arquivo-no-tema"},{"openapi":"delete /{alias}/store/theme/files","title":"Excluir arquivo do tema","href":"/api-reference/loja-virtual/arquivos-do-tema/excluir-arquivo-do-tema"},{"openapi":"get /{alias}/store/theme/files/content","title":"Ler arquivo do tema","href":"/api-reference/loja-virtual/arquivos-do-tema/ler-arquivo-do-tema"},{"openapi":"post /{alias}/store/theme/files/move","title":"Mover ou renomear arquivo do tema","href":"/api-reference/loja-virtual/arquivos-do-tema/mover-ou-renomear-arquivo-do-tema"},{"openapi":"post /{alias}/store/theme/files/copy","title":"Duplicar arquivo do tema","href":"/api-reference/loja-virtual/arquivos-do-tema/duplicar-arquivo-do-tema"},{"openapi":"get /{alias}/store/theme/files/versions","title":"Listar versões de um arquivo","href":"/api-reference/loja-virtual/arquivos-do-tema/listar-versoes-de-um-arquivo"},{"openapi":"get /{alias}/store/theme/files/search","title":"Buscar no conteúdo dos arquivos do tema","href":"/api-reference/loja-virtual/arquivos-do-tema/buscar-no-conteudo-dos-arquivos-do-tema"},{"openapi":"post /{alias}/store/theme/initialize","title":"Inicializar tema no editor","href":"/api-reference/loja-virtual/arquivos-do-tema/inicializar-tema-no-editor"},{"openapi":"post /{alias}/store/theme/publish","title":"Publicar tema","href":"/api-reference/loja-virtual/arquivos-do-tema/publicar-tema"},{"openapi":"get /{alias}/store/theme","title":"Consultar o tema no editor","href":"/api-reference/loja-virtual/arquivos-do-tema/consultar-o-tema-no-editor"}]}]},{"group":"Público","pages":[{"group":"Catálogo","pages":[{"openapi":"get /{alias}/public/catalog/banners","title":"Visualizar informações de banners","href":"/api-reference/publico/catalogo/visualizar-informacoes-de-banners"},{"openapi":"get /{alias}/public/catalog/categories{?id[]={categoryId}}","title":"Listar Categorias de uma loja","href":"/api-reference/publico/catalogo/listar-categorias-de-uma-loja"},{"openapi":"get /{alias}/public/catalog/collections{?id[]={collectionId}}","title":"Listar Coleções de uma loja","href":"/api-reference/publico/catalogo/listar-colecoes-de-uma-loja"},{"openapi":"get /{alias}/public/catalog/products/comments","title":"Visualizar informações das dúvidas do produto","href":"/api-reference/publico/catalogo/visualizar-informacoes-das-duvidas-do-produto"},{"openapi":"get /{alias}/public/catalog/pixels","title":"Visualizar informações dos pixels loja","href":"/api-reference/publico/catalogo/visualizar-informacoes-dos-pixels-loja"},{"openapi":"get /{alias}/public/catalog/products/{slug}","title":"Visualizar informações públicas do produto","href":"/api-reference/publico/catalogo/visualizar-informacoes-publicas-do-produto"},{"openapi":"get /{alias}/public/catalog/products/{id}/groups","title":"Visualizar informações dos grupos do produto","href":"/api-reference/publico/catalogo/visualizar-informacoes-dos-grupos-do-produto"},{"openapi":"get /{alias}/public/catalog/products/{id}/flags","title":"Visualizar informações dos selos do produto","href":"/api-reference/publico/catalogo/visualizar-informacoes-dos-selos-do-produto"},{"openapi":"get /{alias}/public/catalog/products/{id}/combos","title":"Visualizar informações de Compre Junto do produto","href":"/api-reference/publico/catalogo/visualizar-informacoes-de-compre-junto-do-produto"},{"openapi":"get /{alias}/public/catalog/products/{id}/similars","title":"Visualizar produtos relacionados","href":"/api-reference/publico/catalogo/visualizar-produtos-relacionados"},{"openapi":"get /{alias}/public/catalog/products/{id}/pixels","title":"Visualizar informações dos pixels do produto","href":"/api-reference/publico/catalogo/visualizar-informacoes-dos-pixels-do-produto"},{"openapi":"get /{alias}/public/catalog/products/{id}/installments","title":"Visualizar informações dos parcelas do produto","href":"/api-reference/publico/catalogo/visualizar-informacoes-dos-parcelas-do-produto"},{"openapi":"get /{alias}/public/catalog/products/{id}/filters","title":"Visualizar informações dos filtros do produto","href":"/api-reference/publico/catalogo/visualizar-informacoes-dos-filtros-do-produto"},{"openapi":"get /{alias}/public/catalog/products/reviews","title":"Listar as avaliações dos produtos de uma loja","href":"/api-reference/publico/catalogo/listar-as-avaliacoes-dos-produtos-de-uma-loja"},{"openapi":"get /{alias}/public/catalog/products/reviews/ratings","title":"Listar as notas de avaliações dos produtos de uma loja","href":"/api-reference/publico/catalogo/listar-as-notas-de-avaliacoes-dos-produtos-de-uma-loja"},{"openapi":"get /{alias}/public/catalog/reviews{?id[]={reviewId}}","title":null,"href":"/api-reference/publico/catalogo/listar-avaliacoes-de-uma-loja"},{"openapi":"get /{alias}/public/catalog/products/{productId}/collections","title":"Listar Coleções de uma loja por produto","href":"/api-reference/publico/catalogo/listar-colecoes-de-uma-loja-por-produto"},{"openapi":"get /{alias}/public/catalog/brands","title":"Listar marcas da loja","href":"/api-reference/publico/catalogo/listar-marcas-da-loja"},{"openapi":"get /{alias}/public/catalog/products/{productId}/bundles","title":"Listar kits associados ao produto","href":"/api-reference/publico/catalogo/listar-kits-associados-ao-produto"},{"openapi":"get /{alias}/public/catalog/collections/active","title":"Listar coleções ativas de uma loja","href":"/api-reference/publico/catalogo/listar-colecoes-ativas-de-uma-loja"},{"openapi":"get /{alias}/public/catalog/freebies","title":"Listar brindes ativos da loja","href":"/api-reference/publico/catalogo/listar-brindes-ativos-da-loja"},{"openapi":"get /{alias}/public/catalog/products/{productId}/discounts","title":"Listar descontos ativos de um produto","href":"/api-reference/publico/catalogo/listar-descontos-ativos-de-um-produto"}]},{"group":"Loja","pages":[{"openapi":"get /whois/{domain}","title":"Listar todas as Informações públicas de uma loja","href":"/api-reference/publico/loja/listar-todas-as-informacoes-publicas-de-uma-loja"}]},{"group":"Busca","pages":[{"openapi":"get /{alias}/public/search/products/","title":"Listar Produtos da loja","href":"/api-reference/publico/busca/listar-produtos-da-loja"},{"openapi":"get /{alias}/public/search/products/brands","title":"Mostrar marcas dos produtos da loja","href":"/api-reference/publico/busca/mostrar-marcas-dos-produtos-da-loja"},{"openapi":"get /{alias}/public/search/products/prices","title":"Mostrar range de preços de produtos da loja","href":"/api-reference/publico/busca/mostrar-range-de-precos-de-produtos-da-loja"},{"openapi":"get /{alias}/public/search/products/promotions","title":null,"href":"/api-reference/publico/busca/listar-promocoes-da-loja"},{"openapi":"get /{alias}/public/search/products/count","title":"Exibir paginação de produtos da loja","href":"/api-reference/publico/busca/exibir-paginacao-de-produtos-da-loja"}]}]},{"group":"Busca","pages":[{"group":"Global","pages":[{"openapi":"get /{alias}/search/global","title":"Listar Resultados mais recentes retornados pela busca","href":"/api-reference/busca/global/listar-resultados-mais-recentes-retornados-pela-busca"}]},{"group":"Pedidos","pages":[{"openapi":"get /{alias}/search/orders","title":"Listar Pedidos retornados pela busca","href":"/api-reference/busca/pedidos/listar-pedidos-retornados-pela-busca"}]},{"group":"Produtos","pages":[{"openapi":"get /{alias}/search/products","title":"Listar Produtos retornados pela busca","href":"/api-reference/busca/produtos/listar-produtos-retornados-pela-busca"}]},{"group":"Clientes","pages":[{"openapi":"get /{alias}/search/customers","title":"Listar Clientes retornados pela busca","href":"/api-reference/busca/clientes/listar-clientes-retornados-pela-busca"}]},{"group":"Leads","pages":[{"openapi":"get /{alias}/search/leads","title":"Listar Leads retornados pela busca","href":"/api-reference/busca/leads/listar-leads-retornados-pela-busca"}]},{"group":"Carrinhos","pages":[{"openapi":"get /{alias}/search/carts","title":"Listar Carrinhos Abandonados retornados pela busca","href":"/api-reference/busca/carrinhos/listar-carrinhos-abandonados-retornados-pela-busca"}]}]}]}]},{"anchor":"Editor de código","icon":"square-terminal","pages":[{"title":"Editor de código","href":"/editor-codigo/intro"}]},{"anchor":"Apps","icon":"app-store","pages":[{"title":"Apps","href":"/apps/intro"}]},{"anchor":"FAQ","icon":"question","pages":[{"title":"FAQ","href":"/faq/introduction"}]},{"anchor":"Changelog","icon":"newspaper","pages":[{"title":"Changelog","href":"/info/changelog"}]},{"anchor":"Status page","icon":"satellite-dish","href":"https://status.yampi.com.br"}]},"title":"Listar descontos da loja - Yampi Developer Portal","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}