#navbar img[src*="/logo/yampi-negative.svg"], 
#navbar img[src*="/logo/yampi-positive.svg"] {
    height: 20px;
}   

Yampi Developer Portal

Seja bem-vindo ao Portal dos desenvolvedores da Yampi. Aqui você encontrará informações sobre nossas APIs e como criar ou customizar temas.

Visão geral

User Token

OAuth 2.0

Como funcionam os webhooks na Yampi e exemplos de payloads.

Visão Geral

Gerencie todos os recursos de uma loja através da nossa API REST.

Introdução

Ativar

Editor de Temas

Pastas e Arquivos

Versionamento

Restaurar Código

Publicação

Componente para exibir a média de avaliações de um produto.

AverageRating

O componente Banners.vue exibe banners em diferentes seções do site.

Banners

O componente Collection.vue exibe coleções de produtos.

Collection

O componente DiscountTag.vue exibe a tag de desconto de um produto.

DiscountTag

O componente CategoriesHighlight.vue exibe as categorias em destaque na página inicial.

CategoriesHighlight

O componente Highlights.vue exibe os destaques informativos na página inicial.

Highlights

O componente Installments.vue exibe as opções de parcelamento disponíveis para o produto.

Installments

O componente ProductCombos.vue gerencia a seção 'Compre junto' na página de produto.

ProductCombos

O componente ProductCustomizations.vue gerencia a seleção de SKUs, botão de compra e formulário de frete.

ProductCustomizations

O componente ProductInfo.vue exibe as principais informações do produto.

ProductInfo

O componente ProductReviews.vue exibe avaliações e dúvidas na página do produto.

ProductReviews

O componente ProductSimilars.vue exibe produtos relacionados na página do produto.

ProductSimilars

O componente ProductZoom.vue exibe o carrossel de imagens do produto.

ProductZoom

Componente para exibir uma seção com texto e banners.

SectionTextButton2Banners

Componente para exibir avaliações em destaque na loja.

TopRatings

VideoPlayer

Os templates são arquivos Twig que definem a estrutura e o layout das páginas da sua loja.

Templates

Filtros e Funções

Text, title, and styling in standard markdown

Markdown Syntax

Code Blocks

Add image, video, and other HTML elements

Images and Embeds

Mintlify gives you complete control over the look and feel of your documentation using the mint.json file

Global Settings

The navigation field in mint.json defines the pages that go in the navigation menu

Navigation

Reusable, custom snippets to keep content in sync

Reusable Snippets

Através dessa API Rest você conseguirá administrar todos os recursos que uma loja possui dentro do nosso ambiente.

Autenticação

Descrição

Como utilizar o editor

Editor de código

Pastas e arquivos

Restaurar código

Pré-visualização

O componente Banners.vue é responsável por renderizar os seus banners.

O componente Collection.vue é responsável por renderizar as suas coleções.

O componente Highlights.vue é um componente para renderizar os Destaques Informativos.

O componente videoPlayer.vue é um componente para renderizar os vídeos em sua loja.

Video Player

O componente TopRatings.vue é um componente para renderizar as avaliações em destaque na sua loja.

O componente CategoriesHighlight.vue é responsável renderizar as catagorias em destaque.

O componente SectionTextButton2Banners.vue é um componente para renderizar uma seção com texto e banners na sua loja virtual.

O componente ProductZoom.vue é responsável por renderizar o carrossel de imagens do produto

O componente ProductInfo.vue é responsável por renderizar as principais informações do produto

O componente AverageRating.vue é responsável por renderizar a média de avaliações do seu produto

O componente DiscountTag.vue é responsável por renderizar a tag de desconto do produto

O componente Installments.vue é responsável por renderizar as opções de parcelamento do produto

O componente ProductCustomizations.vue é responsável por renderizar os componentes de seleção de Sku, botão comprar e formulário de frete.

O componente ProductCombos.vue é o principal componente da seção Compre junto da página do produto.

O componente ProductReviews.vue é o principal componente da seção de Avaliações da página do produto.

O componente ProductSimilars.vue é o principal componente da seção de Produtos relacionados.

O layout padrão da aplicação é responsável por estruturar suas páginas. Será apresentado os principais arquivos de layout.

Templates Principais

Filtros são operações simples que formatam uma variável ou expressão para serem exibidos para o usuário.

Filtros no Twig

Suporte Técnico

Perguntas Frequentes

Retorna os dados do usuário atualmente logado

Visualizar dados do usuário logado

Visualiza os detalhes de uma determinado usuário a partir do seu ID

Visualizar detalhes de um usuário

Listar marcas

Criar marca

Visualiza as informações de uma marca específica no catálogo

Visualizar marca

Atualiza os detalhes de uma marca específica

Atualizar marca

Excluir marca

Listar categorias

Criar categoria

Visualiza os detalhes de uma categoria específica

Visualizar categoria

Atualiza os detalhes de uma categoria específica

Atualizar categoria

Excluir categoria

Lista os produtos que estão associados a uma categoria específica

Listar produtos associados a uma categoria

Associa uma lista de produtos a uma categoria específica

Associar produtos a uma categoria

Remove a associação de produtos a uma categoria específica

Excluir produtos de uma categoria

Lista de todos os banners associados a uma categoria específica

Listar banners associados a uma categoria

Exporta a lista de todas as categorias em um formato específico

Exportar categorias

Esse recurso é útil quando você precisa transferir produtos de outras categorias

Associar produtos de outras categorias

Lista todas as coleções. Use o parâmetro `onlyParents=true` para listar apenas as coleções pai

Listar coleções

Cria uma nova coleção com os parâmetros especificados

Criar coleção

Retorna os detalhes de uma coleção específica

Visualizar coleção

Atualiza os detalhes de uma coleção específica

Atualizar coleção

Excluir coleção

Retorna a lista de produtos associados a uma coleção específica

Listar produtos associados a uma coleção

Associa uma lista de produtos a uma coleção específica

Associar produtos a uma coleção

Exclui uma lista de produtos de uma coleção específica

Excluir produtos de uma coleção

Listar comentários de produtos

Criar comentário de produto

Obtém os detalhes de um comentário específico de um produto

Visualizar comentário de produto

Atualiza os detalhes de um comentário específico de um produto

Atualizar comentário de produto

Exclui um comentário específico de um produto

Excluir comentário de produto

Obtém uma lista de todas as customizações disponíveis

Listar customizações

Criar customização

Visualiza os detalhes de uma customização específica

Visualizar customização

Atualizar customização

Excluir customização

Lista todos os feeds de catálogo disponíveis

Listar feeds

Criar feed

Obtém os detalhes de um feed específico

Visualizar feed

Atualiza os detalhes de um feed específico

Atualizar feed

Excluir feed

Retorna uma lista de valores associados a um filtro específico

Listar valores de um filtro

Cria um novo valor associado a um filtro específico

Criar valor de filtro

Retorna detalhes de um valor específico associado a um filtro

Visualizar valor de um filtro

Atualiza um valor específico associado a um filtro

Atualizar valor de filtro

Exclui um valor específico associado a um filtro

Excluir valor de filtro

Obtém uma lista de filtros disponíveis para busca de produtos

Listar filtros de busca de produtos

Cria um novo filtro para a busca de produtos

Criar filtro de busca de produtos

Obtém os detalhes de um filtro específico

Visualizar filtro

Atualiza os detalhes de um filtro específico

Atualizar filtro

Excluir filtro

Lista de selos com base nos parâmetros fornecidos

Listar selos

Criar selo

Visualiza os detalhes de um selo específico do catálogo

Visualizar selo

Atualiza os detalhes de um selo específico do catálogo

Atualizar selo

Excluir selo

Lista os produtos associados a um selo específico do catálogo

Listar produtos associados a um selo

Associa produtos a um selo específico do catálogo

Associar produtos a um selo

Exclui produtos de um selo específico do catálogo

Excluir produtos de um selo

Lista os valores de uma variação específica

Listar valores de uma variação

Cria um novo valor para uma variação específica

Criar valor de variação

Retorna os detalhes de um valor específico de uma variação

Visualizar valor de uma variação

Atualiza os detalhes de um valor específico de uma variação

Referência da API

Visualizar afiliação