Nova API de Arquivos do tema
Agora você pode gerenciar pela API os arquivos do tema da loja, os mesmos do Editor de Código do painel. Com isso, dá para automatizar deploys e manutenções do tema sem passar pelo editor.A referência da API ganhou o menu Loja Virtual > Arquivos do tema, com endpoints para:- Listar, ler, criar, atualizar e excluir arquivos.
- Mover, renomear e duplicar arquivos.
- Consultar o histórico de versões de um arquivo.
- Buscar um termo no conteúdo dos arquivos.
- Consultar, inicializar e publicar o tema.
settings/, com as configurações do tema, não pode ser lida nem alterada pela API.Para usar os endpoints, a loja precisa ter acesso ao Editor de Código e o usuário precisa da permissão Gerenciar Editor de código (manage_open_code). O limite é de 60 requisições por minuto por usuário.Confira aqui!Novo guia de boas práticas no Editor de Código
Publicamos a página Boas práticas, com diretrizes de segurança e performance para customizações no tema da loja.O guia reúne recomendações para proteger credenciais privadas no frontend, utilizar apenas endpoints públicos e consultar a Store para aproveitar os dados já disponíveis antes de fazer novas chamadas à API.Confira a documentação.Prazo de até 14 dias úteis para a análise de apps
A análise de aplicativos passa a ter prazo definido: o time da Yampi conclui cada análise em até 14 dias úteis, contados a partir do envio do app para análise no Painel de Parceiro Tech.Se forem necessários ajustes, cada novo envio inicia um novo prazo de até 14 dias úteis. O mesmo prazo vale para a análise de novas versões de apps já publicados.Confira aqui!Novo guia de segurança para parceiros
Publicamos um guia com o que esperamos que você proteja ao acessar dados de lojistas pela API Yampi.O conteúdo cobre escopo mínimo de permissões, OAuth 2.0 com PKCE, armazenamento e rotação de tokens, regras para a URL de redirecionamento, validação da assinatura dos webhooks, suas obrigações sob a LGPD e o passo a passo de resposta a incidente. No fim da página há um checklist de segurança para revisar antes de submeter o app à homologação.Confira aqui!Correções no carrinho, nos filtros e na tag de desconto
Link do release no Github- O total e a economia exibidos no carrinho passam a considerar apenas o desconto de promoção, sem misturar cupom, desconto progressivo e kits.
- A linha de desconto de boleto e Pix no carrinho só aparece quando o desconto está configurado e é maior que zero.
- A tag de desconto passa a calcular o percentual a partir dos preços vindos da API, acompanhando o SKU selecionado na página de produto.
- O filtro de preço volta a ser removido quando o range é devolvido ao intervalo cheio, e remover o chip de preço limpa os parâmetros da URL.
- Os placeholders do preview do editor voltam a carregar quando a requisição falha sem resposta do servidor.
- O botão de adicionar ao carrinho volta a funcionar na página de produto, com o
addProductsToCartmovido para osmethods. - O dropdown de subcategorias passa a ocupar toda a altura do seu container.
- O CNPJ/CPF da loja no rodapé deixa de ser um link sem ação.
- A thumbnail do vídeo do produto volta a respeitar a altura definida, com a correção do atributo
height. - O espaço extra antes do texto de forma de pagamento nos cards de produto foi removido.
Novo desconto progressivo “Compre X, Pague Y” documentado na API
- Agora é possível criar descontos do tipo compre X e pague Y (
buy_x_pay_y) nas opções do campodiscount_type, tanto na criação quanto na busca de descontos. - Documentamos os campos
specifications.price_modeespecifications.tiers[], incluindo a regra de quemin_valuerepresenta a quantidade de itens ou o valor da compra, dependendo doentry_condition_typeconfigurado. - A documentação de descontos também foi atualizada com os possíveis erros relacionados a esses novos campos.
Correções na listagem de produtos, filtros, banners e Compre Junto
Link do release no Github- As listagens de produto passam a usar CSS grid no lugar de flex, dispensando os divs de clear, o helper
tagOrDive o JS de mosaico. - As colunas do grid passam a ser declaradas em um único arquivo, com cada contexto apenas ajustando a custom property
--products-grid-columns. - A coluna de filtros passa a ser identificada pela classe
-no-filters, vinda da própria config, em vez de depender da ordem do DOM. - Os filtros de base, atributos e preço passam a reagir à atualização da URL, mantendo o estado ativo correto na navegação back/forward e em links diretos.
- O scroll ao topo na paginação passa a usar
smoothScroll, corrigindo o comportamento no iOS. - O
Banners.vuepassa a normalizar os propsdimensionsefirstBannerquando o backend envia um array vazio, silenciando o warning do Vue. - Os banners do componente Text Button 2 Banners passam a usar altura automática, preservando o aspect ratio das imagens enviadas.
- Os componentes do Compre Junto foram refatorados para suportar customizações, com ajustes no layout dos combos.
- O asterisco do texto de parcelas foi removido.
- O alinhamento dos produtos no grid do collection box foi corrigido.
- O botão de compra flutuante volta a aparecer, com a inicialização movida de
createdparamounted. - As linhas do resumo do carrinho lateral passam a usar a cor de contraste do tema, garantindo legibilidade sobre o fundo do drawer.
- O componente
PreviewWarning, que não era utilizado, foi removido.
Passa a utilizar a API de preços para exibir o preço dos produtos
Link do release no Github- O preço dos produtos passa a ser buscado na API de preços em runtime, em vez de ser renderizado no Twig a partir do payload do produto.
- Os preços dos cards de produto são carregados quando o card entra na viewport.
- O novo mixin
pricescentraliza a requisição, o estado de carregamento e os valores já formatados usados pelos componentes. - O tipo de pagamento destacado passa a vir do tema via Vuex, em vez de ser interpolado pelo Twig.
- A página de produto exibe loaders enquanto os preços carregam e refaz a busca quando o SKU selecionado muda.
- O parcelamento e o botão de compra flutuante passam a usar os preços vindos da API.
- Os trackings enviados para a API da Yampi a partir dos templates foram removidos.
- Os filtros da busca deixam de ficar desatualizados, com a remoção do cache das agregações em
localStorage. - A barra de ordenação e filtros continua visível quando um filtro aplicado não retorna produtos.
- O modal de parcelas passa a selecionar o cartão na abertura, e não na criação do componente.
- O contador de visitantes online passa a aguardar a sessão antes de iniciar o websocket.
API de frete: tempo de resposta passa a ser de 3 segundos
O limite de tempo para a sua aplicação responder a uma requisição de cotação da API de frete passou de 4 segundos para 3 segundos. Acima disso, a Yampi aborta a requisição e o frete não é exibido no checkout.Se a sua integração de frete costuma responder perto do limite anterior, vale revisar o tempo de resposta.Confira aqui!Permissões de aplicativos agora documentadas
Adicionamos a página Permissões de um aplicativo à seção de Apps, centralizando tudo que envolve escopos na configuração do seu app.- Documentação dos dois níveis de acesso disponíveis: Visualizar (métodos
GET) e Gerenciar (GET,POST,PUT,PATCHeDELETE), com explicação de quando usar cada um. - Detalhamento das ações permitidas por nível em cada um dos 11 módulos disponíveis no Painel de Parceiros: Catálogo, Pedidos, Clientes, Checkout, Promoções, Logística, Configurações, Banners, Conteúdos, Leads e Links de pagamento.
- Passo a passo de como selecionar as permissões no painel antes de salvar o app.
- Orientações sobre o impacto de alterar permissões em apps já publicados, incluindo o ciclo de nova análise e o comportamento para lojistas com o app instalado.
- O link de escopos na documentação de OAuth foi atualizado para apontar diretamente para essa página.
Reestruturação da documentação do Editor de Código
Reorganizamos e expandimos a documentação para tornar a navegação mais natural e o conteúdo mais consistente:- Nova página Buscar e substituir com tutorial completo dos recursos de busca e substituição em arquivos.
- Boas práticas de Twig, Vue e SASS consolidadas na página de Tecnologias.
- Páginas de Erros, Versionamento, Publicação e Pastas e Arquivos padronizadas no mesmo formato estrutural.
- Reordenação do grupo “Começando” pelo fluxo de leitura do dev: Primeiras edições → Pastas e Arquivos → Tecnologias → Buscar e substituir → Erros → Versionamento → Publicação.
- Renomeação da seção “Template Página” para Referência.
Limites por módulo na documentação de Rate-limit
Adicionamos à página de introdução ao rate-limit uma tabela com os limites de requisições organizados por módulo funcional da API Yampi.A tabela cobre mais de 20 módulos incluindo Pedidos, Catálogo, Checkout, Clientes e outros — com os limites por minuto e por hora, além de observações sobre operações específicas como escrita, exportação e importação.Para a lista completa por rota e verbo HTTP, consulte também a página de Limites.Documentação do comportamento de sanitização de campos de texto
A API Yampi aplica sanitização e normalização em campos de texto no momento da criação ou atualização de recursos. Esse comportamento já existia, mas não estava documentado.Com essa atualização:- Os campos
name,descriptione outros campos de texto nos endpoints de Produtos, Marcas, Categorias, Pedidos, Leads, Banners e Brindes agora informam explicitamente que os valores podem ser sanitizados e normalizados antes de serem persistidos. - Esses endpoints passam a retornar
422 Unprocessable Entityquando o valor enviado resulta em um campo inválido após a sanitização — por exemplo, quando o valor fica vazio após a normalização. - O código
422foi adicionado à seção de retornos HTTP da FAQ.
Atualização na documentação do Tema do Editor de código
Nossa documentação do Tema agora está mais completa:- Componentes reorganizados por categoria: os componentes que ficavam em lista plana foram movidos para subpastas — Cabeçalho e Carrinho, Categoria e Busca, Formulários, Interface, Produto, Rodapé e Seções
- Mixins documentados: 12 mixins com descrição de uso, propriedades e exemplos
- Plugins documentados: 5 plugins com descrição de uso e exemplos
- Estado global (store) documentado: 8 módulos Vuex com estado, getters, actions e mutations
- Variáveis CSS reorganizadas: divididas em 4 arquivos temáticos — paleta, seções, tema e tipografia
Atualização nos endpoints de Pedidos e Busca
Realizamos duas atualizações na documentação relacionada a pedidos:-
Renomeação de parâmetro: O parâmetro
customer_cpffoi renomeado paracustomer_documentno endpoint de listar pedidos. A mudança se alinha com a maneira que a API funciona atualmente. - Filtros adicionados à documentação: Incluímos os parâmetros de filtros na documentação de busca de pedidos, facilitando consultas mais precisas por diferentes critérios.
Conteúdo sobre Rate-limit
Adicionamos à documentação uma seção dedicada a explicar como funcionam as regras de rate-limit, boas práticas e tudo o que o parceiro precisa saber sobre esse importante mecanismo de proteção das nossas APIs. Lá você também encontra informações úteis para identificar possíveis problemas e saber como nos pedir ajuda!Confira a página completa aqui!Documentação do endpoint de Busca está disponível
Publicamos a documentação oficial da rota de{alias}/search, responsável por retornar resultados de produtos, clientes ou pedidos em uma única estrutura, sendo possível, inclusive, usar uma query para buscar termos específicos.Confira a documentação completa aqui!Documentação de Clientes atualizada
Atualizamos a documentação dos endpoints de criar e atualizar cliente com informações importantes:- O campo
birthdayfoi adicionado aos atributos aceitos no payload - Agora está explícito que o envio de
birthdayé obrigatório quando o campo Data de nascimento estiver ativo no checkout da loja - Exemplos de response foram adicionados aos dois endpoints, seguindo o padrão das demais documentações da API
Correção nos campos de data da documentação
Corrigimos a documentação dos camposstart_at e end_at, que estavam incorretamente documentados como arrays. Os contextos afetados foram: Cupom, Brinde, Banners, Coleções, Desconto e Desconto Progressivo.Novo rate-limit nos endpoints de imagens de SKU
Adicionamos à documentação as novas regras de rate-limit aplicadas aos endpoints de visualizar e listar imagens de um SKU.Filtros e includes documentados + novo filtro shopify_order_id
Publicamos a documentação completa dos filtros e includes disponíveis diretamente na API. Também adicionamos ao endpoint de Listar pedidos o filtroshopify_order_id para consulta de pedidos pelo ID da Shopify.Confira Listar pedidos.Rate-limit adicionado ao endpoint de OrderTracking
Adicionamos o snippet de rate-limit ao endpoint de POST OrderTracking.Correção na documentação de Link de Pagamento
Corrigimos a documentação dos endpoints de Link de Pagamento.Navegação da documentação simplificada
Removemos o item redundante Visão Geral da página inicial da documentação, mantendo apenas Página Inicial para uma navegação mais clara e objetiva.Mensagem dos endpoints PUT atualizada
Atualizamos a mensagem de destaque presente em todas as páginas de endpoints com método PUT.O texto anterior causava confusão ao sugerir que era necessário enviar apenas o campo desejado. A nova mensagem deixa claro que:- Os campos obrigatórios do endpoint precisam estar presentes no payload
- Campos opcionais não enviados serão mantidos com o valor atual
Correções na documentação de BatchUpdate, Kits e Etiquetas
Corrigimos a documentação dos seguintes recursos:- Atualização em massa (BatchUpdate): ajustes para refletir o comportamento correto da API
- Kits: informações do payload corrigidas
- Etiquetas: informações do payload corrigidas
Correção no payload de Criar Cashbacks
Corrigimos o payload do endpoint de Criar Cashbacks: os parâmetrosstart_at e end_at foram substituídos pelos corretos starts_at e expires_at.Correções na documentação de SKUs e Notas Fiscais
Corrigimos informações incorretas na documentação dos endpoints de SKUs e Notas Fiscais.Nova orientação sobre conteúdo na Loja de Aplicativos
Adicionamos uma nova diretriz referente ao conteúdo exibido na Loja de Aplicativos.A partir de agora, todos os textos e vídeos associados ao aplicativo — incluindo descrições, tutoriais e explicações sobre funcionalidades — devem obrigatoriamente estar em português do Brasil.Confira aqui!Atualização de terminologia: “Parceiro tech”
Atualizamos a documentação substituindo o termo “Parceiro desenvolvedor” por “Parceiro tech”, alinhando com as mudanças realizadas no painel do parceiro.Nova seção: Desconto, incluindo o Compre X Leve Y diretamente via API da Yampi
Agora ficou muito mais fácil entender e configurar Descontos pela API!A nova seção explica, de forma simples e organizada, como criar e gerenciar esses descontos — incluindo valores, tipos, condições de aplicação e restrições.Você vai encontrar:
- Exemplos práticos de criação de descontos.
- Explicações sobre limites de uso por pedido e condições específicas.
- Detalhes sobre campos importantes, obrigatórios e suas descrições.
- Tudo isso pensado para facilitar a integração e dar mais autonomia ao desenvolver para o nosso ecossistema.
- Todas ações suportadas neste endpoint.

Correções e melhorias na documentação
Diversas correções aplicadas:- Removida a seção de Filas, cujo conteúdo foi descontinuado
- Corrigido o tipo do atributo
plataform.external_idpara string na documentação de Frete por API - Adicionada a referência da documentação do OAuth 2.0 na seção de criação de aplicativos
- Clientes: removidos os atributos
passwordepassword_confirmationdos payloads dos endpoints de clientes
Remoção da página de estatísticas de carrinhos abandonados
Removemos a página Listar estatísticas de carrinhos abandonados, cujo endpoint/checkout/carts/stats foi descontinuado.