Jump to Content
Home
Documentação
Referências de API
GraphQL
Changelog
Log In
Referências de API
Log In
Home
Documentação
Referências de API
GraphQL
Changelog
Utilização
All
Pages
Start typing to search…
JUMP TO
Storefront API
Utilização
Guia Inicial – Wake OMS API
Introdução à Wake OMS API
Wake Commerce API
Assinatura
Retorna uma lista com os dados das assinaturas
get
Retorna os dados de uma assinatura específica
get
Atualiza um produto em uma assinatura
put
Atualiza a situação de uma assinatura específica
put
Retorna as assinaturas de um determinado usuário
get
Retorna os produtos de uma assinatura específica
get
Insere um novo produto na assinatura
post
Retorna as recorrências cadastradas na loja
get
Gera um novo pedido para a assinatura
post
Retorna as assinaturas com erros
get
Retorna os erros de uma assinatura especifica
get
Retorna os dados de uma assinatura a partir do id do Pedido
get
Altera a data de recorrência de uma assinatura
put
Retorna os dados de um grupo de assinatura de uma loja
get
Cria assinatura com base em uma lista de pedidos
post
Atualiza a recorrência de uma assinatura específica
put
Atributo
Retorna todos os atributos
get
Insere um novo atributo
post
Deleta um atributo
del
Retorna um atributo específico
get
Atualiza um atributo
put
Autenticacao
Realiza a autenticação de usuário no IDM (Identity Manager)
post
Gera um novo access token baseado em um access token expirado por data
post
Troca o usuário de loja e gera um novo access_token para acesso a nova loja
post
Autor
Buscar todos os autores
get
Inserir autor
post
Deletar autor
del
Buscar autor por id
get
Atualizar autor
put
Buscar autor pelo nome
get
Banner
Deleta um banner existente
del
Buscar banner por Id
get
Atualiza um banner existente
put
Busca todos banners
get
Insere um novo banner
post
Atualiza o status do banner pelo id
put
Deleta o vinculo de um ou mais hotsites com um banner específico
del
Busca os hotsites vinculados de um banner específico
get
Vincula hotsites com um banner específico
post
Atualiza a exibição do banner nos hotsites, se deve ser em todos ou não
put
Deleta o vinculo de um ou mais parceiros com um banner específico
del
Busca os parceiros vinculados de um banner específico
get
Vincula parceiros com um banner específico
post
Busca os possíveis posicionamentos para o banner
get
Atualiza a exibição do banner em parceiros, se deve ser em todos ou não
put
Atualiza a imagem do banner
put
Categoria
Retorna todas as categorias
get
Insere uma nova categoria
post
Exclui uma categoria
del
Retorna uma categoria específica
get
Atualiza uma categoria
put
Exclui uma categoria utilizando o id do erp como identificador
del
Retorna uma categoria específica utilizando o id do erp como identificador
get
Atualiza uma categoria utilizando o id do erp como identificador
put
Vincula um ou mais produtos em uma categoria
post
Exclui o vínculo de um ou mais produtos de uma categoria
del
Atualiza a ordem de exibição de um ou mais produtos de uma categoria
put
Retorna lista de produtos vinculados à categoria de forma ordenada
get
CentroDistribuicao
Retorna todos os centros de distribuição
get
Executa uma atualizacao da prioridade do centro de distribuicao
put
Executa uma atualização da ordenação de CentroDistribuicao
put
ContaCorrente
Retorna o saldo de um usuário
get
Realiza um novo lançamento na conta corrente do cliente
post
Busca todas as movimentações de conta corrente de um usuário
get
Lançamentos na conta corrente com uso parcial de créditos e retorno de IDs
post
Conteudo
Busca todos os conteúdos
get
Insere um novo conteúdo na loja
post
Busca o conteúdo pelo seu id
get
Atualiza um conteúdo
put
Dashboard
Retorna indicadores de faturamento (receita, ticket médio e número de pedidos) da loja
get
Retorna dados para carregar o gráfico do faturamento
get
Retorna uma listagem com os últimos dez pedidos da loja
get
Retorna uma listagem com dados dos produtos mais vendidos pela loja ou parceiro
get
Indicador dos Novos Compradores
get
Indicadores dos Produtos no Estoque
get
Indicador do Carrinho Abandonado
get
Retorna dados para alimentar o gráfico forma de pagamento
get
Retorna o relatório de receitas de um determinado período
get
Retorna o relatório de ticket médio de um determinado período
get
Retorna o relatório de transações de um determinado período
get
Evento
Retorna lista de eventos
get
Cria um Novo Evento
post
Retorna um evento especifico
get
Atualiza um evento
put
Busca produtos vinculados a um evento
get
Vincula um ou mais produtos a um evento sem remover os produtos vinculados anteriormente
post
Atualiza lista de produtos vinculados a um evento removendo os itens vinculados anteriormente e mantendo apenas os enviados pelo request
put
Deleta o vinculo de um produto a um evento
del
Atualiza o campo Recebido de um produto vinculado a um evento
put
Fabricante
Retorna todos os fabricantes
get
Insere um novo fabricante
post
Exclui um fabricante
del
Retorna um fabricante específico pelo id
get
Atualiza um fabricante
put
Retorna um fabricante específico pelo nome
get
FormaPagamento
Retorna todas as formas de pagamento da loja
get
Frete
Retorna uma lista de fretes
get
Insere um novo contrato de frete
post
Retorna um contrato de frete
get
Atualiza um contrato de frete
put
Ativa ou Desativa um frete
put
Exclui os detalhes de um contrato de frete
del
Retorna uma lista de detalhes de um contrato de frete
get
Insere um novo detalhe de frete vinculado a um contrato de frete
post
Realiza uma cotação de frete
post
Retorna uma cotação de frete para o carrinho do pedido
get
Busca os critérios score da loja
get
Cria um critério de score para um centro de distribuição
post
GestorScripts
Busca todos os scripts inseridos
get
Insere um novo script
post
Exclui um Script
del
Atualiza um script existente
put
Busca o conteúdo de uma versão
get
Busca todas as versões de um script
get
Insere uma versão para um script existente
post
Compre Junto
Retorna a lista de grupos de compre junto
get
Insere um novo grupo de compre junto
post
Exclui definitivamente um grupo de compre junto
del
Retorna os detalhes de um grupo de compre junto
get
Atualiza um grupo de compre junto e seus respectivos SKUs
put
Atualiza o status de um grupo de compre junto
patch
Atualiza os SKUs de um grupo de compre junto.
patch
GrupoListaCompras
Retorna dados de um grupo de lista de compras
get
Retorna todos os grupos de listas de compras
get
Insere dados de um ou mais grupos de lista de compras
post
Atualiza dados de um ou mais grupos de lista de compras
put
Deleta dados de um ou mais grupos de lista de compras
del
GrupoPersonalizacao
Retorna uma lista de Grupos de Personalização
get
Remove o vinculo de produtos de um Grupo de Personalização
del
Retorna uma lista de produtos vinculados a um Grupo de Personalização
get
Vincula produtos a um Grupo de Personalização
post
Hotsite
Busca todos os hotsites inseridos
get
Insere um novo hotsite
post
Deleta um hotsite que foi inserido manualmente, hotsites gerados automaticamente não podem ser deletados
del
Busca um hotsite específico
get
Atualiza os dados de um hotsite existente
put
Atualiza o status do hotsite, sendo ativo (true) ou inativo (false)
put
Desvincula um ou mais banners de um hotsite específico
del
Busca os banners vinculados a um hotsite específico
get
Vincula um ou mais banners a um hotsite específico
post
Desvincula um ou mais conteúdos de um hotsite específico
del
Busca os conteúdos vinculados a um hotsite específico
get
Vincula um ou mais conteúdos a um hotsite específico
post
ListaCompras
Insere dados básicos de uma nova lista de compras
post
Atualiza dados básicos de uma lista de compras
put
Retorna as listas de compras
get
Retorna uma lista de compra especifica
get
Excluir uma lista de compras
del
Vincula produto(s) a uma lista de compras
post
Exclui vínculo do(s) produto(s) de uma lista de compras
del
Vincula grupo(s) de lista a uma lista de compras
post
Exclui vínculo de grupo(s) de lista de uma lista de compras
del
Insere dados de SEO em uma lista de compras
post
Atualiza o title do SEO de uma lista de compras
put
Exclui vínculo de SEO de uma lista de compras
del
Vincula imagens a uma lista de compras
post
Atualiza a ordem das imagens de uma lista de compras
put
Exclui imagens de uma lista de compras
del
Loja
Retorna dados da loja
get
LojaFisica
Retorna todas as Lojas Físicas
get
Insere uma Loja Física
post
Remove uma Loja Física
del
Retorna Loja Física pelo Id
get
Atualiza uma Loja Física
put
Remove uma lista de range de cep de uma Loja Física
del
Retorna todos ranges de cep que essa loja atende
get
Insere um range de cep em uma Loja Física
post
Busca os estados
get
Midia
Retorna o xml com os dados de todas as mídias entre duas datas
get
Retorna o xml com os dados de uma mídia específicas entre duas datas
get
Parceiro
Retorna todos os parceiros
get
Insere um novo parceiro
post
Retorna todos os parceiros com pedidos
get
Exclui um parceiro
del
Retorna o parceiro pelo id
get
Atualiza um parceiro
put
Retorna o parceiro pelo nome
get
Retorna os usuários pelo id do parceiro
get
Retorna os usuários pelo nome do parceiro
get
Atualiza um parceiro para tipo marketplace ou não
patch
Pedido
Retorna uma lista de pedido na ordem decrescente dentro do limite de datas passadas
get
Insere um novo pedido
post
Retorna um pedido específico
get
Retorna uma lista de pedido baseado nas situações de pedidos
get
Retorna o histórico de situações de um pedido
get
Retorna uma lista de pedido baseado nas formas de pagamento
get
Retorna o último status de um pedido
get
Atualiza a situação do status do pedido
put
Retorna os dados de rastreamento/nf de um pedido
get
Insere um rastreamento e status a um pedido
post
Atualiza a data de entrega do pedido
put
Atualiza rastreamento completo (com os dados da N.F.)
put
Atualiza rastreamento parcial (Rastreamento e UrlRastreamento)
put
Insere um rastreamento e status a um produto variante
post
Retorna um rastreamento de produto
get
Atualiza rastreamento de produto completo (com os dados da N.F.)
put
Atualiza rastreamento parcial (Rastreamento e UrlRastreamento)
put
Retorna os dados de rastreamento/nf dos produtos de um pedido
get
Atualiza a situação do status de um produto do pedido
put
Retorna os detalhes da transação de um pedido
get
Retorna os detalhes do serviço de frete
get
Liberar reservas de pedidos
post
Busca pedidos que ainda não foram setado o complete
get
Seta o pedido como integrado
post
Retorna a observação de um pedido
get
Insere uma observação a um pedido
post
Atualiza o frete de todos os produtos de um pedido
put
Estorna total ou parcial de um pedido
post
Atualiza os produtos de um pedido
put
Atualiza o endereço de entrega de um pedido
put
Portfolio
Retorna todos os portfolios
get
Insere um novo portfolio
post
Deleta um portfolio
del
Retorna o portfolio pelo id
get
Atualiza um portfolio
put
Retorna o portfolio pelo nome
get
Retorna a lista de produtos de um portfolio
get
Vinculo de produtos ao portfolio
put
Altera o status de um portfolio
put
Produto
Retorna todos os produtos
get
Adiciona novo produto
post
Retorna um produto buscando pelo seu identificador
get
Atualiza parcialmente um produto
patch
Atualiza um produto
put
Deleta um conjunto de produtos por SKU ou ProdutoVarianteId
del
Busca os produtos relacionados
get
Retorna todos os produtos
get
Atualiza a data de cadastro de um produto
put
Atualiza o estoque de vários produtos
put
Atualiza o preço de vários produtos
put
Atualiza para o mesmo preço, todos os variantes de um produto encontrado com o SKU informado
put
Retorna a situação reseller de um produto
get
Atualiza o prazo de entrega de vários produtos
put
Atualiza a data de cadastro de vários produtos
put
Retorna todas as informações de um produto
get
Adiciona uma nova informação
post
Exclui uma informação de um produto
del
Atualiza uma informação de um produto
put
Retorna todas as categorias de um produto
get
Adiciona o vínculo entre um produto e uma categoria
post
Exclui o vínculo entre uma categoria e um produto
del
Define uma categoria de um produto como principal
put
Retorna uma lista de imagens de um produto
get
Adiciona uma nova imagem vinculada a um produto
post
Atualiza a imagem de estampa do produto
put
Retorna se o produto variante está disponível ou não
get
Exclui uma imagem de um produto
del
Retorna o precoDe e precoPor de um produto
get
Retorna o estoque total e o estoque por centro de distribuição
get
Retorna uma lista de avaliações referente ao identificador informado
get
Retorna Lista de Atacarejos do Produto Variante
get
Adiciona novos Atacarejos
post
Remove um Atacarejo
del
Retorna um Atacarejo pelo Id
get
Atualiza um Atacarejo
put
Seta identificador como variante principal
put
Seta status ativo/inativo do produto variante
put
Retorna todos os preços referente ao produto variante, incluindo os preços de tabela de preço
get
Deleta o SEO de um produto específico
del
Busca o SEO de um produto específico
get
Insere um SEO para um produto específico
post
Atualiza um SEO de um produto específico
put
Deleta um ou mais Metatags de produto
del
Busca os metatags de um produto específico
get
Insere um ou mais metatags para um produto
post
Atualiza a ordem de exibição dos produtos nas categorias
put
Atualiza o exibir site de vários produtos
put
Retorna todos os produtos com seus variantes e categorias vinculadas em lote
get
ProdutoAvaliacao
Retorna todas as avaliações dos produtos variantes da loja
get
Atualiza o status de uma avaliação de um produto variante
put
Insere uma avaliação para um produto variante
post
Promoções
Retorna uma lista de promoções
get
Vincular Cupons a uma Promoção
put
Retorna uma promoção completa pelo Id
get
Regionalização
Retorna uma região específica
get
Atualiza uma região específica
put
Retorna uma lista de regiões
get
Insere uma região
post
Arquiva uma região
put
Reseller
Retorna todos os Sellers da loja
get
Insere um novo Seller no marketplace
post
Atualiza um novo Seller no marketplace
put
Retorna um Seller específico da loja
get
Retorna um Seller específico da loja
get
Retorna produtos por Seller
get
Atualiza a autonomia de um Seller
put
Ativa ou desativa um Seller
put
Atualiza a ativação automática de produtos de um Seller
put
Retorna as categorias nas quais os vendedores poderão vincular os seus produtos
get
Atualiza o status de várias categorias
put
SituacaoPedido
Retorna todas as situações de pedido da loja
get
TabelaPreco
Retorna todas as tabelas de preços
get
Insere uma nova tabela de preços
post
Exclui uma tabela de preços
del
Retorna uma tabela de preços
get
Atualiza uma tabela de preços
put
Retorna os produtos de uma tabela de preços
get
Inseri uma lista de produto variantes em uma tabela de preços
post
Atualiza uma lista de produto variantes em uma tabela de preços
put
Remove um produto de uma tabela de preço
del
Atualiza os campos "apenasSite" e "ativo" de várias tabelas de preço
put
Template
Templates
get
TipoEvento
Busca os produtos sugeridos para a lista de evento
get
Vincula um ou mais produtos como sugestão para um tipo de evento
post
Atualiza os produtos sugeridos de um tipo de evento
put
Deleta um produto da lista de sugestões de produtos de um tipo de evento
del
Retorna um tipo de evento especifico
get
Atualiza o tipo evento
put
Retorna todos os tipos de eventos
get
Insere um novo tipo de evento
post
Atualiza o status do tipo de evento, ativando-o ou inativando-o
put
Usuario
Retorna todos os usuários
get
Insere um novo usuário
post
Retorna um usuário específico pelo e-mail
get
Retorna um usuário específico pelo id
get
Retorna um usuário específico pelo cpf
get
Retorna um usuário específico pelo cnpj
get
Atualiza um usuário pelo id
put
Atualiza um usuário pelo e-mail
put
Atualiza as informações cadastrais de um ou mais usuários
put
Retorna uma lista de endereços de um usuário pelo e-mail do usuário
get
Insere um endereço para um usuário pelo e-mail
post
Retorna uma lista de endereços de um usuário pelo id do usuário
get
Insere um endereço para um usuário pelo id do usuário
post
Atualiza um endereço de um usuário pelo e-mail do usuário
put
Atualiza um endereço de um usuário pelo id do usuário
put
Ativa ou desativa um endereço de um usuário com base no id do usuário
put
Ativa ou desativa um endereço de um usuário com base no e-mail do usuário
put
Retorna uma lista de vínculos entre usuário e parceiro
get
Remove o vínculo entre usuário e parceiro
del
Adiciona um vínculo entre usuário e parceiro
post
Atualiza um vínculo entre usuário e parceiro
put
Retorna uma lista de usuários com o limite de credito de cada um
get
Retorna o limite de crédito de um usuário específico
get
Retorna o limite de crédito de um usuário específico
get
Atualiza o limite de crédito para um usuário
put
Retorna lista de usuários cadastrados/descadastrados na newsletter
get
Retorna uma lista contendo o id dos pedidos de um usuário
get
Retorna uma lista contendo o id dos pedidos de um usuário
get
Retorna se o usuário ativou o recebimento de newsletter
get
Atualiza a comunicação de um usuário via newsletter
put
Retorna os dados da lista de desejos de um usuário
get
Deleta um avatar de um usuário
del
Retorna a url do avatar de um usuário
get
Insere um novo avatar para o usuário
post
Insere um novo campo de cadastro personalizado
post
Retorna os campos de cadastro personalizado existentes
get
Remove um campo de cadastro personalizado
del
Atualiza um campo de cadastro personalizado pelo id
put
Remove um valor pré definido
del
Atualiza um valor pré definido pelo id
put
Aprova um cadastro de usuário
put
Bloqueia ou desbloqueia usuários
put
Webhook
Busca todas as inscrições inseridas
get
Insere uma inscrição
post
Busca a inscrição por seu identificador
get
Atualiza uma inscrição
put
Ativa ou inativa uma inscrição
put
Busca os tópicos disponíveis para inscrição
get
Wake OMS API
Autenticações
Autenticar
post
Renovar Token
get
Contas
Incluir Conta
post
Consultar Contas
get
Atualizar Conta
put
Permissões da Conta
Listar Permissões
get
Consultar Permissões da Conta
get
Incluir Permissões da Conta
post
Excluir Permissões da Conta
del
Devoluções
Consultar Solicitação de Devolução
get
Atualizar dados NF
post
Estoques
Consultar Estoques
get
Atualizar Estoques
post
Atualizar Deflatores
post
Adicionar ou Remover do Estoque
post
Pedidos
Consultar Pedidos
get
Faturar
post
Consultar Produtos Recusados
post
Cancelar Pedido
post
Pedido Entregue
post
Expedir Pedido
post
Consultar Faturamento
get
Concluir Separação
post
Consultar Pedidos com Ruptura
get
Adicionar Etiqueta ao Pedido
patch
Incluir Vendedores
post
Configurações
Consultar Inscrições de Webhook
get
Cadastrar e Atualizar Inscrição no Webhook
post
Desativar Inscrição ao Webhook
post
Powered by
Utilização
Ask AI
Storefront API
