Jump to Content
API Reference
v1.0
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
v1.0
API Reference
Lista de cupons
Search
JUMP TO
OMS
OMS API
Autenticação
Visualização do usuário autenticado
get
Contas com acesso
get
Permissões por organização
get
Balanças de produtos
Cria uma balança
post
Atualiza uma balança
put
Listagem de balanças
get
Consulta uma balança
get
Canais de Venda
Cria Canal de Venda
post
Lista Canais de Venda
get
Listar Canal de Venda ( Por Organização)
get
Consulta Canal de Venda (por id)
get
Consulta Canal de Venda (por nome)
get
Atualiza Canal de Venda
put
Consulta de preço em lote por canal de venda
get
Deletar um Canal de Venda
delete
Canais de Aquisição
Cria Canal de Aquisição
post
Atualiza Canal de Aquisição
put
Lista Canais de Aquisição
get
Características
Lista Características
get
Consulta Característica
get
Criação Característica
post
Atualização Característica
put
Categorias
Cria uma categoria
post
Lista categorias
get
Consulta uma categoria
get
Lista categorias (V2)
get
Exclusão da categoria do produto
delete
Atualização de categorias/subcategorias
patch
Categoria de Clientes
Cria uma nova Categoria de Cliente
post
Lista Categorias de Clientes
get
Consulta uma Categoria de Cliente
get
Altera Categoria de Clientes
put
Clientes
Cria cliente - Pessoa Física
post
Cria cliente - Pessoa Jurídica
post
Atualiza cliente - Pessoa Física
put
Atualiza cliente - Pessoa Jurídica
put
Lista clientes - Pessoa Física
get
Lista clientes - Pessoa Jurídica
get
Cria um vale troca
post
Consulta cliente
get
Consulta de campos configuráveis no cadastro de clientes
get
Lista tipos de clientes
get
Histórico cliente
get
Colaboradores
Lista colaboradores
get
Consulta Colaborador
get
Lista vendedores de uma conta unificados por email
get
Configurações de Leilão de Pedidos
Consultar configurações da conta para Leilão de Pedidos
get
Criar ou atualizar configurações da conta para Leilão de Pedidos
patch
Consulta opções para configuração
get
Cupons
Lista de cupons
get
Lista de cupons por skus
post
Lista ampla de cupons por skus
post
Departamentos de Produto
Cria um departamento de produto
post
Atualiza um departamento de produto
put
Listagem de departamentos de produto
get
Consulta de departamento de produtos
get
Descontos
Descontos
get
Devoluções
Consultar devolução de um pedido
get
Listagem de devoluções
get
Embarques
Cria um embarque
post
Consulta Embarque
get
Adiciona pedido ao Embarque
put
Remove pedido do Embarque
delete
Deleta o Embarque
delete
Finaliza o Embarque
post
Estoques
Consulta um estoque
get
Consulta de SKUs de produto vinculados a estoque
get
Lista estoque por estabelecimento
get
Lista de skus por estoque
get
Busca SKUs de produtos vinculados a estoques
post
Busca estoques disponíveis por product_sku_id
post
Busca estoques consolidados por product_sku_code
post
Ajuste de quantidade em estoque
post
Ajuste de quantidade em estoque (V2)
post
Consulta de preço de um sku em um determinado estoque
get
Busca de skus em um determinado estoque
get
Entrada de mercadorias
Cria uma entrada de mercadoria
post
Cria uma entrada de mercadoria V2
post
Cria uma entrada de mercadoria simplificada
post
Listagem entradas de mercadoria
get
Listagem do histórico de entrada de mercadoria
get
Listagem de itens de uma entrada de mercadoria
get
Consulta detalhada de uma entrada de mercadoria
get
Validar entrada de mercadoria
post
Finalizar entrada de mercadoria
post
Finalizar entrada de mercadoria V2
post
Cancelar entrada de mercadoria
post
Conferência automática de uma entrada de mercadoria
put
Conferência manual de um item da entrada de mercadoria
put
Fabricantes
Criar um fabricante
post
Consulta um fabricante
get
Listagem de fabricantes
get
Exclusão de Fabricante
delete
Editar Fabricante
put
Faturas
Status Documento Fiscal (NFc-e) em Contingência
put
Fornecedores
Cria um fornecedor
post
Edita um fornecedor
put
Consulta de Fornecedor
get
Listagem de Fornecedor
get
Remover Fornecedor
delete
Marcas
Cria uma marca
post
Consulta uma marca
get
Lista marcas
get
Listar Marca por Nome
get
Remover Marca
delete
Editar Marca
put
Metas de vendas
Criar uma meta de venda
post
Consultar uma meta de venda
get
Editar uma meta de venda
put
Listagem metas de vendas
get
Deleta uma meta de venda
delete
Motivos de Cancelamento
Cria um motivo de cancelamento
post
Consulta de motivos de cancelamento disponíveis
get
Movimentações de estoque
Consulta de movimentações de estoque
get
NexaasTax
Webhook de Cancelamento
post
NPS Nexaas
Visualizar o NPS ativo
get
Adiar respostas
patch
Criar questionário
post
Responder questões
post
Organizações
Cria organização
post
Lista organizações
get
Retorna uma Organização
get
Atualiza organização
put
Excluir Organização
delete
Lista inventários relacionados aos estoques
get
Outras Saídas
Consulta de uma "Outra Saída"
get
Listagem de "Outras Saídas"
get
Listagem de histórico de "Outras Saídas"
get
Consulta de preço dos items de uma Outra Saída
get
Gera espelho de nota "Outra Saída"
post
Cria uma nova saída do tipo "outras"
post
Atualiza saída do tipo "outras"
put
Validação de produtos na importação de "Outras Saídas"
post
Confirma saída do tipo "outras"
post
Cancelar saída do tipo "outras"
post
Emitir nota fiscal para saída do tipo "outras"
post
Sincronizar nota fiscal para saída do tipo "outras"
post
Cancelar nota fiscal para saída do tipo "outras"
post
Pedidos
Cria um pedido
post
Associar um Documento Fiscal para um Pedido Entregue
post
Cancelar um Documento Fiscal para um Pedido Entregue
put
Cria um pedido entregue
post
Consulta de Pedido
get
Atualiza um pedido
put
Adiciona itens ao Pré Pedido
post
Remove itens do Pré Pedido
delete
Deleta o Pré Pedido
delete
Conclui o Pré Pedido
post
Listagem de Pedidos
get
Confirma entrega de um pedido
post
Coloca pedido em rota de entrega
post
Cria um pedido legado
post
Solicita a devolução parcial de um pedido
post
Solicita o cancelamento de um pedido
post
Consulta razões de cancelamento do Pedido
get
Devolução de um pedido
post
Consulta Coupons do Pedido
get
Atualiza estado do pagamento (Cartão)
put
Atualização de pagamentos (outros)
put
Altera o pedido para o status de Empacotado
patch
Associar um Documento Fiscal em uma devolução
post
Devolver pedido ao remetente
post
Problema na entrega
post
Fatura um pedido
post
Cancela nota fiscal de venda
post
Listagem de pedidos sem histórico
get
Consulta pedido sem histórico
get
Histórico de pedido
get
Atualiza um pedido sem histórico
put
Cria um pedido (sem histórico no retorno)
post
Forçar sincronização de emissão fiscal
post
Listagem de Tipos de Pedidos
get
Listagem de Status dos Pedidos
get
Atualizar link de pagamento
put
Pontos de Retirada
Busca pontos de retirada
post
Preços
Adiciona ou Atualiza preços
post
Produtos
Consulta de produtos
get
Listagem de Produtos
get
Cria um Produto Kit
post
Criar um produto
post
Atualiza um produto
put
Recebimento
Consulta recebimento
get
Romaneio
Listagem de pedidos (Romaneio)
get
Listagem de Romaneios
get
Criar Romaneio
post
Upload de arquivos
patch
Upload de arquivos PLP
patch
Editar Romaneio
put
Consulta de Romaneio
get
Pronto para coleta
patch
Reabrir Romaneio
patch
Fechar Romaneio
patch
Cancelar um romaneio
patch
Saída de mercadorias
Cria uma saída de mercadoria simplificada
post
Skus de produto
Consulta um Sku de produto
get
Consulta um Sku de produto por organização, ean ou código
get
Consulta preço
get
Cria um sku
post
Atualiza sku
put
Consulta de juros
post
Lista skus por tabela de preço
get
Listagem simplificada de Skus para o Promo
get
Tabelas de Preço
Cria uma tabela de preço
post
Lista tabelas de preço
get
Transferências
Cria uma transferência
post
Consulta transferência
get
Confirma envio de uma transferência
post
Confirma recebimento e finalização de uma transferência
post
Transportadoras
Listagem de transportadoras
get
Criar uma transportadora
post
Editar uma transportadora
put
Consulta transportadora
get
Deleta uma transportadora
delete
Vale Trocas
Busca vale troca
get
Consulta vale troca
get
Variações
Cria uma variação
post
Volumes de pedido
Consulta um volume de pedido
get
Webhooks
Webhooks de Canal de Vendas
Webhooks de Características
Webhooks de Categorias
Webhooks de Clientes
Webhooks de Estoque
Webhooks de Fabricantes
Webhooks de Marcas
Webhooks de Outras Saídas
Webhooks de Pedido
Webhooks de Produto
Webhooks de Produto Sku
Webhooks de Recebimentos
Webhooks de Romaneio
Webhooks de Transferência
Webhooks de Variações de característica
Webhooks de Voucher de Troca
Powered by
Lista de cupons
get
https://homologation.oms.nexaas.com/api/v1/coupons/search
Lista de cupons
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header
Header
RESPONSE
Click
Try It!
to start a request and see the response here!