Jump to Content
Home
Guias e Tutoriais
Referência de API
Lançamento de produto
Comunidade
Deixe seu feedback
Log In
Referência de API
Deixe seu feedback
Log In
Home
Guias e Tutoriais
Referência de API
Lançamento de produto
Comunidade
Como realizar requisições pela Referência de API
All
Pages
Start typing to search…
JUMP TO
Primeiros passos
Referência de API
Como realizar requisições pela Referência de API
Users API
Visão geral Users API
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
Carts API
Visão geral Carts API
Carrinhos da loja
Lista os carrinhos
get
Cria um carrinho
post
Retorna um carrinho
get
Atualiza um carrinho
patch
Exclui um carrinho
del
Itens do carrinho
Lista os itens de um carrinho
get
Adiciona um item do carrinho
post
Atualiza um item do carrinho
patch
Remove um item do carrinho
del
Adiciona itens em massa no carrinho
post
Lista as personalizações do item do carrinho
get
Remove uma personalização do item do carrinho
del
Lista as amostras
get
Pagamento
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
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
Orders API
Pedidos
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
Lista os itens de um pedido
get
Retorna personalizações de um item
get
Notas fiscais de pedidos
Retorna notas fiscais de um pacote
get
Inclui nota fiscal em um pedido
post
Atualiza uma nota fiscal
patch
Remove uma nota fiscal
del
Envio de pedido
Retorna o endereço de envio
get
Atualiza endereço do pedido
patch
Retorna os estados dos pedidos
get
Inclui código de rastreio em um pacote
post
Retorna os rastreios de pacote
get
Remove rastreio de pacote
del
Lista os pacotes de um pedido
get
Clientes
Lista os pedidos de um cliente
get
Fluxo e andamento
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
Lista os pedidos do feed
get
Marca os pedidos do feed
post
Products API
Produto
Retorna os produtos do catálogo
get
Adiciona produto no catálogo
post
Duplica produto e suas variantes
post
Retorna um produto
get
Atualiza um produto
patch
Remove um produto
del
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
Lista as variantes
get
Cria uma variante
post
Atualiza uma variante
patch
Remove uma variante
del
Reordena as variantes
post
Retorna uma variante
get
Atualiza uma variante
patch
Calcula frete
get
Imagens de produtos e variantes
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
del
Reordena imagens de um produto
post
Associa imagem com variante
post
Desassocia imagem da variante
post
Kits
Lista os itens do kit
get
Adiciona produto ao kit
post
Remove item do kit
del
Atualiza item do kit
patch
Inventário
Itens em estoque
Atualiza em lote
post
Atualiza itens em estoque
post
Itens por local
Atualiza um local
patch
API DE CRÉDITOS
Bônus
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
del
Créditos
Retorna a lista de créditos da loja
get
Retorna uma planilha xlsx de créditos
get
Adiciona créditos a um cliente
post
Estorna valores de um saque de crédito
post
Estorna valores de um depósito de crédito
post
Retira créditos de um cliente
post
Retorna os detalhes do saque
get
Bloqueia créditos para serem utilizados
post
Libera créditos bloqueados
del
Saca créditos previamente bloqueados
post
Limpa os saldos bloqueados de um cliente
post
Retorna o saldo de um cliente
get
Lista os webhooks
get
Registra um webhook
post
Atualiza um webhook
put
Deleta um webhook
del
STORE FRONT
Templates
Cria ou atualiza um template
post
Retorna um template
get
Atualiza um template
patch
Remove um template
del
Cria um template
post
Lista os templates
get
Templates site assets
Cria ou atualiza um asset
post
Retorna um asset
get
Atualiza um asset
patch
Remove um asset
del
Cria um asset
post
Lista os assets
get
SEO
Recupera SEO
get
Cadastra SEO
post
Atualiza SEO
put
API
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
Produtos
Lista os produtos
get
Cria um produto
post
Retorna um produto
get
Atualiza um produto
patch
Remove um produto
del
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
del
Reordena imagens do produto
post
Associa imagem com variante
post
Desassocia imagem da variante
post
Variantes
Lista as variantes
get
Cria uma variante
post
Atualiza uma variante
patch
Remove uma variante
del
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
Atualiza uma tag
patch
Remove uma tag
del
Cria ou atualiza uma tag
post
Carrinhos
Lista os carrinhos
get
Atualiza um carrinho
patch
Exclui um carrinho
del
Retorna um carrinho
get
Cria um carrinho
post
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
del
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
Atualiza um item do carrinho
patch
Remove um item do carrinho
del
Locais
Lista os locais
get
Cria um local
post
Atualiza um local
patch
Remove um local
del
Recebedores
Lista os recebedores
get
Cria um recebedor
post
Retorna um recebedor
get
Atualiza um recebedor
patch
Remove um recebedor
del
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
del
Altera um membro da audiência
patch
Clientes
Lista os clientes
get
Cria um cliente
post
Retorna um cliente
get
Atualiza um cliente
patch
Remove um cliente
del
Lista os pedidos
get
Lista os endereços
get
Lista os endereços cadastrados pelo cliente
get
Cria um endereço do cliente
post
Atualiza um endereço do cliente
patch
Deleta o endereço cadastrados pelo cliente
del
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
Altera uma promoção
patch
Remove uma promoção
del
Regras de desconto
Lista as regras
get
Cria uma regra
post
Remove uma regra
del
Altera uma regra
patch
Cupons de desconto
Lista os cupons
get
Cria um cupom
post
Atualiza um cupom
patch
Remove um cupom
del
Retorna um cupom
get
Menus
Lista os menus
get
Cria um menu
post
Retorna um menu
get
Atualiza um menu
patch
Remove um menu
del
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
Cria ou atualiza uma mensagem do site
patch
Remove uma mensagem do site
del
Loja
Lista as images
get
Cria uma imagem
post
Remove uma imagem
del
Cria um atributo customizado de produto
post
Personalizações
Lista as personalizações
get
Cria uma personalização
post
Remove uma personalização
del
Altera uma personalização
patch
Retorna uma personalização
get
Mapeamentos
Lista os mapeamentos
get
Cria um mapeamento
post
Retorna um mapeamento
get
Atualiza um mapeamento
patch
Remove um mapeamento
del
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
Powered by
Como realizar requisições pela Referência de API
Ask AI
