Ops! Esse email nao possui permissão para abertura de ticket. Por favor, entre em contato com o responsável pela sua loja para providenciar o acesso.

Usando os filtros do OMS em sua API

Este processo será trabalhado utilizando a API de Listar Pedidos do OMS: http://lab.vtex.com/docs/oms/api/latest/orders/index.html#listar-pedidos

A estrutura de origem para a URL de request ficará da seguinte forma: http://nome_loja.vtexcommercestable.com.br/api/oms/pvt/orders/
Da forma acima, serão listados todos os pedidos de 15 em 15 de forma paginada.

Aplicando os Filtros:

1. Ingressar no OMS da Loja
2. Acessar os filtros de busca

Vamos pegar de exemplo a busca pela data de criação do pedido em um range que traga todos os pedidos realizados há um mês e que estejam no status de ProntoParaManuseio:

Quando feito os filtros, será gerada uma URL no próprio navegador montada nos parâmetros selecionados:

3. Como a URL estará codificada, será necessário decodifica-la para ser interpretada pela interface de REST.
Uma ferramenta ágil para ajustar isso manualmente é esta: http://meyerweb.com/eric/tools/dencoder/
- isto irá acertar os parâmetros de data e de status de pedido:

4. Feito isso, basta copiar a extensão da URL a partir do “?” e colar na estrutura de origem para a URL de request anteriormente comentada.
Ficará da seguinte forma:

http://nome_loja.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

5.  É possível trabalhar também, em cima da mesma URL de request acima, a paginação e a quantidade de pedidos listados por página.
Para isso, basta inserir no fim desta o seguinte parâmetros:  “&page=1&per_page=100″

6. Manuseando a URL de request: Qualquer filtro que for montado dentro do OMS poderá ser utilizado no intuito de consulta na interface de REST. Cada um possui sua particularidade de manuseio, como no range de data de criação do pedido, basta apenas alterar o De e o Até – sempre no formato de AAA-MM-DD. Além disso, para todos, sempre haverá por default a quantidade por página de 15 pedidos, onde é preciso apenas trabalhar em cima do 5º tópico, que é alterar a atual página a ser buscada (page)e a quantidade por página (per_page) – esta possui um limite máximo de 100 pedidos por página.

7. Testando: todo este passo a passo pode ser devidamente validado na ferramente do POSTMAN, utilizada por nós como padrão para consultas e para as diversas análises.
Qualquer dúvida sobre a ferramenta como autenticação dos Headers, possuímos a seguinte documentação em nosso Help: http://vtex.com.br/help/utilizando-o-postman/



Tem mais dúvidas? Envie uma solicitação

Comentários

Powered by Zendesk