Documentation Index
Fetch the complete documentation index at: https://docs.yampi.com.br/llms.txt
Use this file to discover all available pages before exploring further.
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.