Usar os filtros do OMS na API

Integração

VTEX Team

VTEX Team

Última atualização

Esse artigo tem o objetivo de demonstrar maneiras de usar os filtros aplicáveis pela API do OMS nas consultas por API.

Você pode consultar a listagem com todas as APIs disponíveis no OMS em nossa documentação para desenvolvedores.

O exemplo utilizado é a API de consulta aos pedidos: http://{NOMEDALOJA}.vtexcommercestable.com.br/api/oms/pvt/orders/, onde serão listados todos os pedidos de 15 em 15 de forma paginada.

Aplicando os filtros

  1. Acesse o módulo OMS;
  2. Clique no símbolo de filtros.

Usaremos o filtro pela data de criação do pedido em um intervalo que traga todos os pedidos realizados há um mês e que estejam no status pronto **para manuseio.**

Quando feitos os filtros, será gerada uma URL no próprio navegador com os parâmetros selecionados:

Então, é preciso decodificar a URL para ser interpretada pela interface de REST. Uma ferramenta ágil para ajustar isso manualmente é a URL dencoder.

Feito isso, basta copiar a extensão da URL a partir do “?” e colar na estrutura de origem para a URL de request. Ex.: http://nomedaloja.vtexcommercestable.com.br/api/oms/pvt/orders/?orderBy=creationDate,desc&f_creationDate=creationDate:[2014-09-03T03:00:00.000Z TO 2014-10-04T02:59:59.999Z]&f_statusDescription=Pronto para o manuseio

Para usar a paginação e determinar a quantidade de registros por página, insira os parâmetros _&page=1&per_page=100_.