Jump to Content
Home
Documentação
Referências de API
GraphQL
Changelog
Log In
Documentação
Log In
Moon (Dark Mode)
Sun (Light Mode)
Home
Documentação
Referências de API
GraphQL
Changelog
Search
Documentação
Visão Geral
Guia Wake Commerce
Base de Conhecimento
Central de Atendimento
Storefront API
Visão Geral
Criação e Autenticação do Token
Explorando a API
Limites de Requisições
Paginação
Queries
Autocomplete
Banners
Brands
BuyList
CalculatePrices
Categories
Checkout
Contents
Customer
CustomerAccessTokenDetails
EventList
EventLists
EventListType
Hotsite
Hotsites
InformationGroupFields
MenuGroups
NewsletterInformationGroupFields
Partners
PaymentMethods
PartnerByRegion
Product
ProductRecommendations
Products
Scripts
Search
Sellers
ShippingQuotes
ShippingQuoteGroups
Shop
ShopSetting
ShopSettings
Uri
Mutations
CheckoutAddressAssociate
CheckoutAddCoupon
CheckoutAddKit
CheckoutAddMetadata
CheckoutAddMetadataForProductVariant
CheckoutAddProduct
CheckoutClone
CheckoutComplete
CheckoutCustomerAssociate
CheckoutGiftVariantSelection
CheckoutPartnerAssociate
CheckoutPartnerDisassociate
CheckoutRemoveCoupon
CheckoutRemoveMetadata
CheckoutRemoveProductCustomization
CheckoutRemoveProductSubscription
CheckoutRemoveProduct
CheckoutRemoveKit
CheckoutReset
CheckoutSelectInstallment
CheckoutSelectPaymentMethod
CheckoutSelectShippingQuote
CheckoutUpdateProduct
CheckoutUseCheckingAccount
CreateCheckout
CreateNewsletterRegister
CreateProductReview
CreateSearchTermRecord
CustomerAccessTokenCreate
CustomerAccessTokenRenew
CustomerAddressCreate
CustomerAddressUpdate
CustomerAddressRemove
CustomerAuthenticatedLogin
CustomerCreate
CustomerCompletePartialRegistration
CustomerEmailChange
CustomerImpersonate
CustomerPasswordChange
CustomerPasswordRecovery
CustomerPasswordChangeByRecovery
CustomerSimpleLoginStart
CustomerSimpleLoginVerifyAnwser
CustomerSocialLoginFacebook
CustomerSocialLoginGoogle
CustomerSubscriptionAddressChange
CustomerSubscriptionProductAdd
CustomerSubscriptionProductRemove
CustomerSubscriptionUpdateStatus
CustomerUpdate
EventListAddProduct
PartnerAccessTokenCreate
ProductCounterOfferSubmit
ProductFriendRecommend
ProductPriceAlert
ProductRestockAlert
SendGenericForm
UpdateAddress
WishlistAddProduct
WishlistRemoveProduct
OrderChangePayment
CustomerSendAccessKeyEmail
CustomerAuthenticateAccessKey
Processo de Fechamento de Pedido através do Storefront API
Carrinho de Compras em um APP
Formas de Login Rápido e Social
Idiomas no Storefront API
Tipos de Parceiros
Kits
Tokens com ReCAPTCHA
Storefront SSR
Visão Geral
Funcionamento
Storefront no Admin
Acessando o Storefront
Integração com o Repositório (GIT)
Configuração do Template de E-mail
Campo de Busca
Estrutura de pastas
Assets
Img
JS
CSS
Components
Configs
components.json
emails.json
pages.json
settings.json
colors.json
Emails
Carrinho abandonado - abandoned_cart.html
Lista de Eventos
Pages
Queries
Root
Snippets
Scriban
Internacionalização com lang
Agrupamento com group
Imprimindo com debug
Storefront Local
Storefront SDK
Template Padrão
Extension VS Code
Headers e Cookies
Feature Policy
Recaptcha
Arquivos estáticos
Checkout
Checkout SSR
Novos Tipos de Páginas
Componentes Fechados
Performance
Page Speed
Banners Responsivos
Busca Estilo Hotsite
Frameworks Javascript
Redirecionamento de erro 500
Configurando o login social em seu template
Parceiro por Região
Indexação Automática Storefront
Data Layer e Google Analytics
Implementando o Data Layer
Integração Wake Experience
API Pública
Visão Geral
Criação e Autenticação do Token
Responsável Técnico do Token da API
Limite de Requisições
Códigos de erros mapeados na API
Estratégias para o Consumo de Pedidos
Cenários de controle de estoque via API
Assinatura
Consultando uma lista de assinaturas
Consultando uma assinatura específica
Atualizando uma assinatura específica
Consultando as assinaturas de um usuário
Consultando os Produtos de uma assinatura específica
Inserindo Produtos em uma assinatura específica
Consultando as recorrências da loja
Gerando um pedido para uma assinatura
Atualizando um produto em uma assinatura específica
Consultando assinaturas com falha
Consultando uma assinatura específica com falha
Consultando assinaturas pelo ID do pedido
Alterando a data de recorrência de uma assinatura
Consultando os dados de um grupo de assinatura de uma loja
Criando assinatura com base em uma lista de pedidos
Atributo
Consultando todos os atributos
Inserindo um novo atributo
Excluindo um atributo
Consultando um atributo específico
Atualizando um atributo
Autor
Consultando autores cadastrados
Inserindo autor
Excluindo autor
Consultando um autor específico
Atualizando um autor específico
Consultando um autor específico pelo nome
Banner
Excluindo um banner específico
Consultando um banner específico
Atualizando um banner específico
Consultando banners cadastrados
Inserindo um banner
Atualizando o status de um banner específico
Excluindo o vínculo de um hotsite com um banner específico
Consultando hotsites vinculados a um banner específico
Inserindo hotsites a um banner Específico
Atualizando a exibição de um banner específico nos hotsites
Excluindo o vínculo de um ou mais parceiros a um banner específico
Consultando os parceiros vinculados a um banner específico
Inserindo vínculo de parceiros a um banner específico
Consultando os posicionamentos para um Banner
Atualizando a exibição de um banner específico em parceiro
Atualizando a imagem de um banner específico
Conteúdo
Consultando todos os conteúdos cadastrados
Inserindo um conteúdo
Consultando um conteúdo específico
Atualizando um conteúdo específico
Hotsite
Consultando hotsites cadastrados
Inserindo um hotsite
Excluindo um hotsite inserido manualmente
Consultando um hotsite específico
Atualizando o status de um hotsite específico
Excluindo um ou mais banners de um hotsite específico
Consultando banners vinculados a um hotsite específico
Inserindo banners a um hotsite específico
Excluindo um ou mais conteúdos de um hotsite específico
Consultando conteúdos vinculados a um hotsite específico
Inserindo conteúdos a um hotsite específico
Atualizando os dados de um hotsite específico
Categoria
Consultando todas as categorias
Inserindo uma nova categoria
Excluindo uma categoria
Consultando uma categoria específica
Atualizando uma categoria
Excluindo uma categoria utilizando o id do ERP
Consultando uma categoria específica utilizando o id do ERP
Atualizando uma categoria utilizando o id do ERP
Vinculando um ou mais produtos em uma categoria
Atualizando a ordem de exibição de um ou mais produtos de uma categoria
Excluindo o vínculo de um ou mais produtos de uma categoria
Consultando uma lista de produtos vinculados à categoria de forma ordenada
Centro Distribuição
Consultando todos os centros de distribuição
Executando uma atualização da prioridade do centro de distribuição
Conta corrente
Consultando o saldo de um usuário específico
Inserindo lançamento na conta corrente do cliente
Consultando o extrato de conta corrente de um usuário específico
Dashboard
Consultando indicadores de faturamento
Consultando dados para gerar gráfico de faturamento
Consultando os últimos dez pedidos da loja
Consultando os dados dos produtos mais vendidos
Consultando clientes de primeira compra
Consultando produto em estoque
Consultando carrinhos abandonados
Consultando dados para gerar gráfico forma de pagamento
Consultando dados de receita por período
Consultando dados do ticket médio da loja de uma determinado período
Consultando movimentações transacionais da loja de um determinado período
Eventos
Consultando os eventos cadastrados
Inserindo um evento
Consultando um evento específico
Atualizando um evento específico
Consultando produtos vinculados a um evento
Inserindo produtos a um evento
Atualizando os produtos de um evento
Excluindo o vínculo de um produto a um evento
Atualizando um produto de um evento como recebido fora da lista
Fabricante
Consultando fabricantes cadastrados
Inserindo um fabricante
Excluindo um fabricante específico
Consultando um fabricante específico pelo ID
Atualizando um fabricante especifico
Consultando um fabricante específico pelo nome
Frete
Consultando uma lista de fretes
Inserindo um novo contrato de frete
Consultando um contrato de frete
Atualizando um contrato de frete
Ativando ou Desativando um frete
Excluindo os detalhes de um contrato de frete
Consultando uma lista de detalhes de um contrato de frete
Inserindo um novo detalhe de frete vinculado a um contrato de frete
Realizando uma cotação de frete
Realizando uma cotação de frete para o carrinho do pedido
Buscando os critérios score da loja
Cria um critério de score para um centro de distribuição
Forma de Pagamento
Consultando todas as formas de pagamento da loja
Gestor de Script
Consultando scripts cadastrados
Inserindo um script
Excluindo um script
Atualizando um script existente
Buscando o conteúdo de uma versão específica
Buscando todas as versões de um script
Inserindo uma versão para um script existente
Grupo de Lista de Compra
Consultando uma lista com os Grupo de Lista de Compra
Grupo de Personalização
Consultando grupo de personalização
Deletando um produto do grupo de personalização
Consultando lista de produtos de um grupo de personalização
Inserindo um produto ao grupo de personalização
Loja
Consultando dados da loja
Loja Física
Consultando todas as lojas físicas
Inserindo uma loja física
Excluindo uma loja física
Consultando uma loja física pelo Id
Atualizando uma loja física
Excluindo uma lista de range de cep de uma loja física
Consultando todos os ranges de cep que uma loja atende
Inserindo um range de cep em uma loja física
Consultando os estados
Mídia
Consultando o xml com os dados de todas as mídias entre duas datas
Consultando o xml com os dados de uma mídia específicas entre duas datas
Parceiro
Consultando todos os parceiros
Inserindo um novo parceiro
Consultando todos os parceiros com pedidos
Excluindo um parceiro
Consultando o parceiro pelo id
Atualizando um parceiro
Consultando o parceiro pelo nome
Consultando os usuários pelo id do parceiro
Consultando os usuários pelo nome do parceiro
Pedido
Consultando uma listagem de pedidos
Inserindo um pedido externo na plataforma
Consultando um pedido específico
Consultando uma listagem de pedido por situação
Consultando o histórico de situações de um pedido
Consultando uma listagem de pedidos por forma de pagamento
Consultando o último status de um pedido
Atualizando a situação de um pedido
Consultando os dados de rastreamento e fiscais de um pedido
Inserindo rastreamento e status em um pedido
Atualizando a data de entrega do pedido
Atualizando rastreamento completo (com os dados da N.F.)
Atualizando o rastreamento parcialmente
Inserindo rastreamento e status a um produto variante
Consultando o rastreamento de um produto
Atualizando o rastreamento de produto completo (com os dados da N.F.)
Atualizando o rastreamento de produto parcial
Consultando os dados de rastreamento/nf dos produtos de um pedido
Atualizando a situação do status de um produto do pedido
Atualiza o status de um produto para removê-lo do pedido e depois adiciona uma lista de produtos no pedido
Consultando os detalhes da transação de um pedido
Consultando os detalhes do serviço de frete
Liberando reserva de estoque de pedidos
Consultando pedidos não integrados
Setando um pedido como integrado
Consultando observações de um pedido
Inserindo uma observação em um pedido
Baixa de Pedido
Ajustes do Pedido
Identificando Descontos e Cupons em um pedido
Atualizando o frete de todos os produtos de um pedido
Estorno total ou parcial de um pedido
Portfólio
Consultando todos os portfolios
Inserindo um novo portfolio
Excluindo um portfolio
Consultando o portfolio pelo id
Atualizando um portfolio
Consultando o portfolio pelo nome
Consultando a lista de produtos de um portfolio
Vinculando produtos ao portfolio
Atualizando o status de um portfolio
Produto
Gestão de Produtos
Gestão de SEO de Produtos via API
Consultando todos os produtos
Inserindo um novo produto
Consultando um produto específico
Atualizando um produto específico
Deletando um conjunto de produtos variante
Consultando produtos relacionados
Consultando produtos alterados
Atualizando a data de cadastro de um produto
Atualizando o estoque de vários produtos
Atualizando o preço de vários produtos
Atualizando para o mesmo preço, todos os variantes de um produto encontrado com o SKU informado
Consultando a situação reseller de um produto
Consultando todas as informações de um produto
Inserindo uma nova informação
Excluindo uma informação de um produto
Atualizando uma informação de um produto
Consultando todas as categorias de um produto
Inserindo o vínculo entre um produto e uma categoria
Excluindo o vínculo entre uma categoria e um produto
Definindo uma categoria de um produto como principal
Atualiza a ordem de exibição dos produtos nas categorias
Consultando uma lista de imagens de um produto
Inserindo uma nova imagem vinculada a um produto
Atualizando a imagem de estampa do produto
Excluindo uma imagem de um produto
Consultando se o produto variante está disponível ou não
Consultando o precoDe e precoPor de um produto
Consultando o estoque total e o estoque por centro de distribuição
Consultando uma lista de avaliações referente ao identificador informado
Consultando uma lista de atacarejos do produto variante
Inserindo novos atacarejos
Excluindo um atacarejo
Consultando um atacarejo pelo Id
Atualizando um atacarejo
Setando identificador como variante principal
Setando status ativo/inativo do produto variante
Consultando todos os preços referente ao produto variante, incluindo os preços de tabela de preço
Excluindo o SEO de um produto específico
Consultando o SEO de um produto específico
Inserindo um SEO para um produto específico
Atualizando um SEO de um produto específico
Excluindo um ou mais Metatags de produto
Consultando os metatags de um produto específico
Inserindo um ou mais metatags para um produto
Produto Avaliação
Consultando todas as avaliações dos produtos variantes da loja
Atualizando o status de uma avaliação de um produto variante
Inserindo uma avaliação para um produto variante
Promoções
Consultando uma promoção completa pelo id
Vincular Cupons a uma Promoção
Consultando todas as Promoções de uma loja
Regionalização
Consultando uma região específica
Atualizando uma região específica
Consultando regiões em massa
Inserindo uma nova regionalização
Arquivando uma região
Reseller
Consultando todos os sellers da loja
Inserindo um novo seller no marketplace
Atualizando um novo seller no marketplace
Consultando um seller específico da loja
Consultando um seller específico da loja
Consultando produtos por seller
Atualizando a autonomia de um seller
Ativando ou desativando um Seller
Atualizando a ativação automática de produtos de um seller
Situação do Pedido
Consultar todas as situações de pedido da loja
Tabela Preço
Consultando todas as tabelas de preços
Inserindo uma nova tabela de preços
Excluindo uma tabela de preços
Consultando uma tabela de preços
Atualizando uma tabela de preços
Consultando os produtos de uma tabela de preços
Inserindo uma lista de produto variantes em uma tabela de preços
Atualizando uma lista de produto variantes em uma tabela de preços
Excluindo um produto de uma tabela de preço
Template
Consultando os templates cadastrados na base
Tipo Evento
Consultando os produtos sugeridos para a lista de evento
Vinculando um ou mais produtos como sugestão para um tipo de evento
Atualizando os produtos sugeridos de um tipo de evento
Deletando um produto da lista de sugestões de produtos de um tipo de evento
Consultando um tipo de evento específico
Atualizando o tipo evento
Consultando todos os tipos de eventos
Inserindo um novo tipo de evento
Atualizando o status do tipo de evento, ativando-o ou inativando-o
Usuário
Consultando todos os usuários
Inserindo um novo usuário
Consultando um usuário específico pelo e-mail
Consultando um usuário específico pelo id
Consultando um usuário específico pelo CPF
Consultando um usuário específico pelo CNPJ
Atualizando um usuário pelo id
Atualizando um usuário pelo e-mail
Atualizando as informações cadastrais de um ou mais usuários
Consultando uma lista de endereços de um usuário pelo e-mail do usuário
Inserindo um endereço para um usuário pelo e-mail
Consultando uma lista de endereços de um usuário pelo id do usuário
Inserindo um endereço para um usuário pelo id do usuário
Atualizando um endereço de um usuário pelo e-mail do usuário
Atualizando um endereço de um usuário pelo id do usuário
Ativando ou desativando um endereço de um usuário com base no id do usuário
Ativando ou desativando um endereço de um usuário com base no e-mail do usuário
Consultando uma lista de vínculos entre usuário e parceiro
Excluindo o vínculo entre usuário e parceiro
Inserindo um vínculo entre usuário e parceiro
Atualizando um vínculo entre usuário e parceiro
Consultando uma lista de usuários com o limite de credito de cada um
Consultando o limite de crédito de um usuário específico
Consultando o limite de crédito de um usuário específico através do e-mail
Atualizando o limite de crédito para um usuário
Consultando lista de usuários cadastrados/descadastrados na newsletter
Consultando uma lista contendo o id dos pedidos de um usuário
Consultando uma lista contendo o id dos pedidos de um usuário através do documento
Consultando se o usuário ativou o recebimento de newsletter
Atualizando a comunicação de um usuário via newsletter
Consultando os dados da lista de desejos de um usuário
Deletando um avatar de um usuário
Consultando a url do avatar de um usuário
Inserindo um novo avatar para o usuário
Inserindo um novo campo de cadastro personalizado
Consultando os campos de cadastro personalizado existentes
Removendo um campo de cadastro personalizado
Atualizando um campo de cadastro personalizado pelo id
Removendo um valor pré definido
Atualizando um valor pré definido pelo id
Aprovando um cadastro de usuário
Bloqueando ou desbloqueando usuários
❔ Dúvidas Frequentes
API Página de Produto
Visão Geral
Chamada da API
Informações disponíveis na API de produto
Webhook
Visão Geral
Timeout / Retentativas
Tópicos e Payloads
Centro de Distribuição
Parceiro
Pedido
Produto
Produto Variante
Tabela de Preço
Usuário / Cliente
Assinatura/Recorrência
PAGAMENTOS
Conector de Pagamento Customizado
Seja um Parceiro Homologado
Visão Geral
Payloads/objetos
Payment Details
Tokenize
Payment
Authorize
Capture
Cancel
Pag. Confirmação
Chargeback
Card
Formulário de Pagamento
Postback
Script de confirmação de pagamento
Salvar Cartões
Cartões Sugeridos - Como configurar no Checkout da Loja
Configuração do Pagamento Customizado
❔Dúvidas Frequentes
Antifraude Personalizado
Antifraude Clearsale
Troca na forma de pagamento do pedido
IPs de Saída
Frete Customizado
Visão Geral
Modelo do objeto enviado
Retorno da cotação
Alíquotas
Visão Geral
Cadastro de alíquota usando API
Blog
Vinculando um blog a uma loja
DATA PROVIDER
Visão Geral
Como conectar ao Power BI
Powered by
Suggest
Introdução
