Pular para o conteúdo
Olist Ecommerce
Pesquisar
Ctrl
K
Cancelar
GitHub
Selecionar tema
Escuro
Claro
Auto
Templates
Visão geral da customização
Configurações Iniciais
Configurações iniciais
Aplicativos
GitLab e chave SSH
Instalação da Build
Instalação da Build
Migrar lojas iniciadas com a Build anterior à 11/2023
Tokens de Desenvolvedor
Iniciar novo projeto
Processo de customização
Ambientes de loja
Ambientes de loja
Preview
Staging
CDN
Production
Exemplo de customização
Comandos disponíveis
Criação e Estrutura de Template
Template Maker
Organização dos arquivos
Pasta assets
Pasta liquids
Arquivo package.json
Pasta assets_1
Orientações para versionamento de loja
Performance
Liquid
Liquid na Olist
Tipos de dados e operações
Funcionamento básico
Filtros nativos do Liquid
Filtros Olist Ecommerce
Tags
Tags
load_customizations
load_media
load_products
load_banners
load_menus
getparam
Tags de assets
load_tag e load_tags
load_shop_images
load_payment_icons
load_credits
load_locals
gtm
load_videos
facebook_connect_url
opengraphfor
page
Templates de página
Templates de página
layout.liquid
home.liquid
tag.liquid
search.liquid
page.liquid
product.liquid
login.liquid
account.liquid
not_found.liquid
Objetos
Objetos
aggregations
pagination
sort_options
current_shop
template
tag
Objetos que retornam URL
client
forloop
product
variant
cart
video
item
installment
post
Estruturas Comuns
Sistema de componentes
Cart Drawer
Minha Conta
Filtros de Produto
Instagram
Login e Registrar
Preço de Produto
Pop-up de Newsletter
Variantes de Produto
Exemplos e referências
Landing Page para lançamento de loja
Orientações de Cadastro
Como criar as orientações de cadastro
Recursos da Plataforma
Formulários
Assinaturas
Configurações entre plataformas
Cadastro de produtos de assinatura
Alteração de layout para assinaturas
Itens em conjunto no carrinho
Blog
Criação e estrutura do Blog
Blog na vitrine
Posts relacionados
Auto preenchimento de endereço pelo CEP
Avise-me quando chegar
Cálculo de frete na página de produto
Módulo internacional
Vitrine para módulo internacional
SEO em lojas Olist
Catálogo de Produtos
Catálogo de produtos
Atributos de produto
Como usar a API
Token de acesso
Requisições de API via Postman
Filtros e paginação
Pedidos via API
Criação de pedidos via API
Fluxo e status de pedidos
Integrações
ERPs integrados
Integração via API
Integração de pedidos
Controle de fila de integração de pedidos (Feed)
Integração de produtos
Integração de tags (categorias)
Webhooks
Integração com Algolia
Configurações básicas Algolia
Integração Algolia para produtos
Integração Algolia para post
Integração com Stamped
Integração com o Instagram
Google Tag Manager
Visão geral
Exemplo
Camada de dados
Configurações de Lançamento
Apontamento de DNS
Redirecionamento de domínio
Glossário
Termos e definições
Referência da API
Overview
Usuários
User authorize
POST
Faz o login do usuário
POST
Faz o logout do usuário
POST
User
GET
Atualiza um usuário
PUT
Retorna os cupons do usuário
GET
Ativar
POST
Desativar
POST
Lista os usuários
GET
Cria um usuário
POST
Lista as tags dos usuários a partir das funções
GET
Solicita renovação da senha
POST
Cadastra a nova senha
PATCH
Lista os recebíveis do usuário
GET
Créditos
Lista as versões da regra de bônus
GET
Regras de bônus
GET
Atualiza a regras de bônus
PUT
Remove as regras de bônus
DELETE
Produtos
Lista os itens do kit
GET
Adiciona produto ao kit
POST
Remove item do kit
DELETE
Atualiza item do kit
PATCH
Lista os produtos
GET
Cria um produto
POST
Retorna um produto
GET
Remove um produto
DELETE
Atualiza um produto
PATCH
Atualiza um produto pela referência
PATCH
Avalia um produto
POST
Busca os produtos
GET
Lista os preços do produto
GET
Lista as imagens do produto
GET
Cria uma imagem do produto
POST
Deleta uma imagem do produto
DELETE
Reordena imagens do produto
POST
Associa imagem com variante
POST
Desassocia imagem da variante
POST
Variantes
Lista as variantes
GET
Cria uma variante
POST
Remove uma variante
DELETE
Atualiza uma variante
PATCH
Reordena as variantes
POST
Retorna uma variante
GET
Atualiza uma variante
PATCH
Lista as imagens da variante com SKU na URL
GET
Lista as imagens da variante com SKU nos parâmetros
GET
Calcula frete
GET
Estoque
Atualiza em lote
POST
Atualiza
POST
Atualiza um local
PATCH
Tags
Lista as tags
GET
Cria uma tag
POST
Lista os tipos de tags
GET
Retorna uma tag
GET
Remove uma tag
DELETE
Atualiza uma tag
PATCH
Cria ou atualiza uma tag
POST
Templates
Cria ou atualiza um template
POST
Retorna um template
GET
Remove um template
DELETE
Atualiza um template
PATCH
Lista os templates
GET
Cria um template
POST
Templates site assets
Cria ou atualiza um asset
POST
Retorna um asset
GET
Remove um asset
DELETE
Atualiza um asset
PATCH
Lista os assets
GET
Cria um asset
POST
Carrinhos
Lista os carrinhos
GET
Retorna um carrinho
GET
Cria um carrinho
POST
Exclui um carrinho
DELETE
Atualiza um carrinho
PATCH
Retorna as parcelas do total de um carrinho
GET
Adiciona itens ao carrinho
POST
Lista as personalizações do item do carrinho
GET
Remove uma personalização do item do carrinho
DELETE
Cálculo de frete internacional
GET
Lista as amostras
GET
Endereço de entrega
GET
Associa código de cupom ao carrinho
POST
Itens do carrinho
Lista os itens de um carrinho
GET
Cria um item do carrinho
POST
Remove um item do carrinho
DELETE
Atualiza um item do carrinho
PATCH
Locais
Lista os locais
GET
Cria um local
POST
Remove um local
DELETE
Atualiza um local
PATCH
Recebedores
Lista os recebedores
GET
Cria um recebedor
POST
Retorna um recebedor
GET
Remove um recebedor
DELETE
Atualiza um recebedor
PATCH
Pagamentos
Cria um pedido no Paypal
POST
Faz o pagamento do carrinho
POST
Público
Retorna os membros da audiência
GET
Cria uma membro da audiência
POST
Remove um membro da audiência
DELETE
Altera um membro da audiência
PATCH
Clientes
Lista os clientes
GET
Cria um cliente
POST
Retorna um cliente
GET
Remove um cliente
DELETE
Atualiza um cliente
PATCH
Lista os pedidos
GET
Lista os endereços
GET
Lista os endereços cadastrados pelo cliente
GET
Cria um endereço do cliente
POST
Deleta o endereço cadastrados pelo cliente
DELETE
Atualiza um endereço do cliente
PATCH
Reseta a senha
POST
Saldo de créditos
GET
Extrato de créditos
GET
Lista os bônus
GET
Solicitação de esquecimento
PATCH
Faz login do cliente por token
GET
Faz login do cliente
POST
Promoções
Cria uma promoção
POST
Retorna uma promoção
GET
Remove uma promoção
DELETE
Altera uma promoção
PATCH
Regras de desconto
Lista as regras
GET
Cria uma regra
POST
Remove uma regra
DELETE
Altera uma regra
PATCH
Cupons de desconto
Lista os cupons
GET
Cria um cupom
POST
Remove um cupom
DELETE
Atualiza um cupom
PATCH
Retorna um cupom
GET
Menus
Lista os menus
GET
Cria um menu
POST
Retorna um menu
GET
Remove um menu
DELETE
Atualiza um menu
PATCH
Lista as posições dos menus
GET
Reordena os menus
POST
Retorna os menus em árvore
GET
Mensagens do site
Retorna uma mensagem do site
GET
Remove uma mensagem do site
DELETE
Cria ou atualiza uma mensagem do site
PATCH
Loja
Lista as images
GET
Cria uma imagem
POST
Remove uma imagem
DELETE
Cria um atributo customizado de produto
POST
Personalizações
Lista as personalizações
GET
Cria uma personalização
POST
Retorna uma personalização
GET
Remove uma personalização
DELETE
Altera uma personalização
PATCH
Mapeamentos
Lista os mapeamentos
GET
Cria um mapeamento
POST
Retorna um mapeamento
GET
Remove um mapeamento
DELETE
Atualiza um mapeamento
PATCH
Mídias
Lista os banners
GET
Retorna um banner
GET
Retorna os banners agrupados por tag
GET
Eventos
Dispara eventos
POST
Importações
Importa dados a partir de um CSV
POST
SEO
Recupera SEO
GET
Cadastra SEO
POST
Atualiza SEO
PUT
API — Carts
Overview
Carrinhos da loja
Overview
Lista os carrinhos
GET
Cria um carrinho
POST
Retorna um carrinho
GET
Exclui um carrinho
DELETE
Atualiza um carrinho
PATCH
Itens do carrinho
Overview
Lista os itens de um carrinho
GET
Adiciona um item do carrinho
POST
Remove um item do carrinho
DELETE
Atualiza um item do carrinho
PATCH
Adiciona itens em massa no carrinho
POST
Lista as personalizações do item do carrinho
GET
Remove uma personalização do item do carrinho
DELETE
Lista as amostras
GET
Pagamento
Overview
Calcula as parcelas de pagamento
GET
Realiza o pagamento do carrinho
POST
Associa código de cupom ao carrinho
POST
Cria um pedido no Paypal
POST
Envio do carrinho
Overview
Endereço de entrega
GET
Adiciona um endereço de entrega
POST
Atualiza o método de envio de um carrinho
PATCH
Cálculo de frete
GET
Cálculo de frete internacional
GET
API — Inventory
Overview
Itens em estoque
Atualiza em lote
POST
Atualiza itens em estoque
POST
Itens por local
Atualiza um local
PATCH
API — Kits
Overview
Kit
Overview
Listar Itens do Kit
GET
Adicionar Item ao Kit
POST
Remover Item do Kit
DELETE
Atualizar Item do Kit
PATCH
API — Orders
Overview
Pedidos
Overview
Retorna os pedidos da loja
GET
Retorna um pedido
GET
Atualiza dados extras de um pedido
PATCH
Retorna os eventos ocorridos em um pedido
GET
Retorna a avaliação de um pedido
GET
Retorna os descontos de um pedido
GET
Retorna o bônus de um pedido
GET
Lista os canais de compra
GET
Itens de pedido
Overview
Lista os itens de um pedido
GET
Retorna personalizações de um item
GET
Notas fiscais de pedidos
Overview
Retorna notas fiscais de um pacote
GET
Inclui nota fiscal em um pedido
POST
Remove uma nota fiscal
DELETE
Atualiza uma nota fiscal
PATCH
Envio de pedido
Overview
Retorna o endereço de envio
GET
Atualiza endereço do pedido
PATCH
Retorna os estados dos pedidos
GET
Retorna os rastreios de pacote
GET
Inclui código de rastreio em um pacote
POST
Remove rastreio de pacote
DELETE
Lista os pacotes de um pedido
GET
Clientes
Overview
Lista os pedidos de um cliente
GET
Fluxo e andamento
Overview
Captura um pedido
POST
Confirma um pedido
POST
Estorna pagamento por cartão de crédito
POST
Cancela um pedido
POST
Retorna o comprovante de estorno em PDF
GET
Altera pacote para enviado
PATCH
Altera pacote para entregue
PATCH
Altera para empacotado
PATCH
Order Feed
Overview
Lista os pedidos do feed
GET
Marca os pedidos do feed
POST
API — Products
Overview
Produto
Overview
Retorna os produtos do catálogo
GET
Adiciona produto no catálogo
POST
Duplica produto e suas variantes
POST
Retorna um produto
GET
Remove um produto
DELETE
Atualiza um produto
PATCH
Atualiza um produto pela referência
PATCH
Avalia um produto
POST
Lista os preços do produto
GET
Cria uma imagem do produto
POST
Busca os produtos
GET
Variante de produto
Overview
Lista as variantes
GET
Cria uma variante
POST
Remove uma variante
DELETE
Atualiza uma variante
PATCH
Reordena as variantes
POST
Retorna uma variante
GET
Atualiza uma variante
PATCH
Calcula frete
GET
Imagens de produtos e variantes
Overview
Lista as imagens da variante com SKU na URL
GET
Lista as imagens da variante com SKU nos parâmetros
GET
Lista as imagens do produto
GET
Deleta uma imagem do produto
DELETE
Reordena imagens de um produto
POST
Associa imagem com variante
POST
Desassocia imagem da variante
POST
API — Users
Overview
Usuários
Retorna os usuários cadastrados no Admin
GET
Cria um usuário
POST
Lista as tags dos usuários a partir das funções
GET
Retorna os dados do usuário pelo ID
GET
Atualiza os dados de um usuário
PUT
Ativa um usuário
POST
Desativa um usuário
POST
Retorna os cupons do usuário
GET
Acessos de usuários
Solicita renovação da senha
POST
Cadastra uma nova senha
PATCH
Loga o usuário
POST
Logout do usuário
POST
Autoriza operações pelo token de acesso do usuário
POST
Recebíveis de usuários
Lista os recebíveis de um usuário pelo ID
GET
GitHub
Selecionar tema
Escuro
Claro
Auto
Overview
Order Feed
Seção intitulada “Order Feed”
Permite o controle de integração de pedidos no formato de feed