Especificações para Integração com o sistema tryideas via API

Integração de Pedidos

Iremos descrever neste capítulo, como realizar a integração de Pedidos via api, com o sistema tryideas.

 

 

No campo "codeOrder", utilizar o ID ou algum identificador do Pedido, para evitar o salvamento de Pedidos repetidos, e possibilitar futuras Consultas e Cancelamentos via chamada na api.

Serviços disponíveis
Enviar Pedido:
Endereço IP/SincronizacaoTryApp/api/Orders/SendOrders

Retorno:
true - salvou o pedido com sucesso; ou
erro + a descrição do problema ocorrido.
Consultar Pedido:
Endereço IP/SincronizacaoTryApp/api/Orders/SearchOrders

Retorno:
true - pedido foi localizado (está salvo);
false - pedido não foi localizado com o "codeOrder" informado; ou
erro + a descrição do problema ocorrido.
Cancelar Pedido:
Endereço IP/SincronizacaoTryApp/api/Orders/CancelOrder

Retorno:
true - pedido foi cancelado com sucesso;
nao encontrado - pedido não foi localizado com o "codeOrder" informado; ou
erro + a descrição do problema ocorrido.

Integração de Pedido Delivery

Iremos descrever neste capítulo, como realizar a integração de Pedidos via api, com o sistema tryideas.

 

 

No campo "codeOrder", utilizar o ID ou algum identificador do Pedido, para evitar o salvamento de Pedidos repetidos, e possibilitar futuras Consultas e Cancelamentos via chamada na api.

 

Serviços disponíveis
Enviar Pedido:
Endereço IP/SincronizacaoTryApp/api/Orders/SendOrders

Retorno:
true - salvou o pedido com sucesso; ou
erro + a descrição do problema ocorrido.
Consultar Pedido:
Endereço IP/SincronizacaoTryApp/api/Orders/SearchOrders

 

Retorno:
true - pedido foi localizado (está salvo);
false - pedido não foi localizado com o "codeOrder" informado; ou
erro + a descrição do problema ocorrido.
Cancelar Pedido:
Endereço IP/SincronizacaoTryApp/api/Orders/CancelOrder

Retorno:
true - pedido foi cancelado com sucesso;
nao encontrado - pedido não foi localizado com o "codeOrder" informado; ou
erro + a descrição do problema ocorrido.

Consultar Ordem de Serviço

Obter os Produtos cadastrados

Os serviços abaixo, retornam algumas informações dos itens cadastrados no sistema tryideas.

 

Serviço que obtêm todos os Produtos cadastrados:

Endereço IP/SincronizacaoTryApp/api/Products/GetAllProductsInfo

Json a ser enviado na chamada do serviço.

idFilial - Código do Emitente no sistema tryideas.

idContaEstoque - Campo opcional. Utilizado nos casos em que a empresa trabalha com mais de uma conta de Estoque.

idTabelaPreco - Campo opcional. Utilizado nos casos em que é necessário obter o valor do item, considerando uma variação de preço, já cadastrada e configurada no sistema tryideas.

 

Serviço que obtêm todos os Produtos que tiveram alguma alteração, após uma determinada data:

Endereço IP/SincronizacaoTryApp/api/Products/GetModifyProductsInfo

Json a ser enviado na chamada do serviço.

idFilial - Código do Emitente no sistema tryideas.

idContaEstoque - Campo opcional. Utilizado nos casos em que a empresa trabalha com mais de uma conta de Estoque.

dataUltimaSincronizacao - Data e Hora da última chamada a este serviço, ou ao mencionado acima. Serão retornados os itens que tiveram alguma alteração após a data informada neste campo.

idTabelaPreco - Campo opcional. Utilizado nos casos em que é necessário obter o valor do item, considerando uma variação de preço, já cadastrada e configurada no sistema tryideas.

Campos retornados:

- Código do Produto;

- Código da Classificação do Produto;

- Preço de Venda;

- Quantidade em Estoque;

Json de retorno das chamadas acima.

Consulta de Pedidos

Para realizar uma consulta dos Pedidos, faça uma chamada à API utilizando os parâmetros abaixo.

Endereço IP/SincronizacaoTryApp/api/Orders/GetOrders

idFilial - Código do emitente no sistema tryideas.

idOperacao - Código da operação no sistema tryideas. Poderá ser enviado o código desejado, caso queira os pedidos de determinada operação, ou então "0" (zero), para retornar de todas.

dataUltimaSincronizacao - após cada requisição, a data e hora naquele momento deverá ser armazenada, para ser enviada neste campo na próxima solicitação. Apenas os pedidos que tiveram alguma alteração ou inclusão após esta data, serão retornados.

 

 

O retorno da chamada será uma lista de pedidos, algo conforme o exemplo abaixo.

codeOrder - número do pedido no sistema tryideas.

statusPedido - opções disponíveis: recebido, faturado, producao, expedicao ou cancelado.

codProduto - poderá estar no formato "código" ou "código-classificação".

Por exemplo: 1-10 onde 1 é o código do produto e 10 o código da Classificação (variação) deste produto.