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
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 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
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
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
