Pré-Requisitos
Para garantir o uso correto da funcionalidade, é necessário atender aos seguintes pré-requisitos:
- Usar o sistema Wake OMS;
- Ter um usuário habilitado para utilização da API.
🌐 Visão Geral – Wake OMS API
A Wake OMS API é uma interface que possibilita a integração entre sistemas externos e a plataforma Wake OMS, permitindo o gerenciamento completo do ciclo de pedidos, contas, estoques e integrações de eventos.
Projetada com foco em escalabilidade, rastreabilidade e controle, a API oferece recursos essenciais para automatizar operações logísticas, comerciais e fiscais em ambientes omnichannel.
⚙️ Principais Funcionalidades
A Wake OMS API é estruturada em endpoints RESTful e abrange funcionalidades organizadas em diferentes domínios operacionais:
🔐 Autenticação
- Autenticar: Geração do token de acesso via credenciais.
- Renovar Token: Atualização do token para sessões contínuas e seguras.
👤 Gerenciamento de Contas e Permissões
- Incluir Contas: Endpoint público para inclusão de uma nova conta no Wake OMS
- Consultar Conta: Endpoint público com paginação para consulta das contas cadastradas no Wake OMS.
- Atualizar ContaEndpoint publico para atualização dos dados das contas cadastradas no Wake OMS
- Lista de Permissões: Endpoint público para listar as permissões disponíveis no Wake OMS
- Consultar as Permissões da Conta: Endpoint público para listar as permissões de uma conta do Wake OMS
- Incluir Permissões da Conta: Objeto com as informações das permissões a serem adicionadas à conta.
- Excluir Permissões da Conta: Endpoint público para remover permissões de uma conta.
📦 Pedidos e Operações Comerciais
- Consultar Pedidos: Endpoint público para consulta de pedidos no Wake OMS.
- Faturar: Endpoint público para atualização das informações de faturamento do pedido.
- Cancelar Pedidos: Endpoint público para cancelamento de pedidos no Wake OMS.
- Pedido Entregue: Endpoint público para marcar um pedido como entregue no Wake OMS
- Expedir Pedido: Endpoint público para indicar que um pedido foi expedido no ponto de envio
- Concluir Separação: Endpoint para indicar que um pedido teve a separação concluída. Após concluir a separação, os itens que não foram atendidos serão removidos e o pedido será aceito para seguir com o faturamento.
- Consultar Faturamento: Endpoint para consultar os dados de faturamento do pedido no Wake OMS
- Consultar Pedidos com Ruptura: Endpoint público com paginação para consulta dos pedidos com ruptura no Wake OMS
- Consultar Produtos Recusados: Endpoint público utilizado para consulta de produtos recusados pelos clientes.
- Consultar solicitação de devolução: Endpoint para consulta das solicitações de devolução/devoluções dos pedidos no Wake OMS
- Atualizar dados na NF: Endpoint para atualização das solicitações de devolução com dados da NF de devolução gerada no PDV.
🧮 Estoque
- Consultar Estoques: Endpoint público utilizado para consulta de estoque no Wake OMS.
- Atualizar Estoques: Endpoint público utilizado para atualização de estoque no nível de contas do Wake OMS e /ou SKU.
- Atualizar Deflatores: Endpoint público utilizado para atualização do deflator de estoque no nível de contas do Wake OMS e/ou SKU.
🧑💼 Vendedores
- Incluir Vendedores: Endpoint público para inclusão ou atualização de vendedores no Wake OMS.
📡 Webhooks
- Consultar inscrições de Webhook: Endpoint público para consulta de inscrições de Webhook por tópico.
- Cadastrar ou Atualizar inscrição: Endpoint público para cadastro e atualização de inscrição no Webhook por tópico.
- Desativar Inscrição ao Webhook: Endpoint público para inativar uma inscrição ao Webhook.