API Pública para Consulta de Ruptura de Pedidos

Pré-requisitos:

Para garantir o uso correto da funcionalidade, é necessário atender aos seguintes pré-requisitos:

Ser cliente da Wake OMS

Nesta documentação você aprenderá sobre:

1 Sobre a API de Consulta de Pedidos com Ruptura
2 Obtendo o Token para Consulta de Pedidos com Ruptura
3 Parâmetros da API de Consulta de Pedidos com Ruptura
4 Resultados da API de Consulta de Pedidos com Ruptura

Sobre a API de Consulta de Pedidos com Ruptura

O principal objetivo da API pública para consulta de ruptura de pedidos, é proporcionar maior visibilidade na gestão de pedidos e promover uma integração mais fluida com a plataforma Wake e outras soluções empresariais, proporcionando autonomia aos clientes para consultarem as rupturas de pedidos ocorridas na operação e integrarem essas informações aos seus sistemas internos, trazendo maior agilidade aos processos dos clientes, uma vez que a alternativa é o processo manual de extração de relatórios no Wake OMS.

Obtendo o Token para Consulta de Pedidos com Ruptura

Para utilizar a API Pública de Consulta de Pedidos com Ruptura, será necessário realizar o processo de autenticação e obtenção do token que permitirá a utilização do endpoint. Veja como realizar a autenticação Aqui.

Parâmetros da API de Consulta de Pedidos com Ruptura

O endpoint utilizado é do tipo GET e necessita de alguns parâmetros para buscar os resultados:

pagina → Indica a página que deseja que seja buscada.
dataInicial → Indica o período inicial a ser considerado para busca dos pedidos;
dataFinal → Indica a data limite a ser considerada para busca dos pedidos;
pedido → Indica a consulta de um pedido específico.

Nota:

quando nenhum código de pedido for informado no parâmetro pedido, os parâmetros dataInicial e dataFinal deverão ser obrigatoriamente informados.
quando utilizado os parâmetros de dataInicial e dataFinal, o período não poderá exceder 31 dias.

Exemplo:

CURL -- request GET  \
--url 'https://subdominio.sintesesolucoes.com.br/SinOMS.API/pub/pedidos/ruptura?pagina=1&dataInicial=11/01/2024&dataFinal=11/28/2024'
--header 'accept: application/json' \
--header 'authorization: Bearer ‘token’

Resultados da API de Consulta de Pedidos com Ruptura

Em caso de sucesso na requisição, a API retornará um Array de dados dos pedidos e Change Seller. Veja Aqui no site de documentação e teste da API os retornos possíveis e os campos que retornam.