Baixa de Pedido

Com a API da Tray Corp é possível baixar todos os pedidos quantas vezes forem necessárias por meio do endpoint GET/pedidos.

A baixa de pedidos pode ser realizada após o envio de alguns dados obrigatórios como dataInicial e dataFinal, que precisam estar no formato ano - mês - dia.

Além desses, existem outros campos opcionais que ajudam a filtrar a lista de pedido:

  • enumTipoFiltroData - por qual data deseja ordenar o retorno dos pedidos (padrão “dataPedido”);
  • situacoesPedido - lista das situações para retorno;
  • formasPagamento - lista das formas de pagamento para retorno;
  • pagina - para não vir todos os pedidos, a API retorna os pedidos paginados (padrão 1);
  • quantidadeRegistros - essa opção é para dizer quantos pedidos deverão ser retornados em cada página (padrão 50);
  • email - retorna apenas pedidos realizados pelo usuário informado;
  • valido - retorna pedidos válidos e inválidos ou caso não seja informado retorna todos os pedidos.

❗️

Importante

A lista de pedidos sempre é retornada na ordem decrescente pelo campo "enumTipoFiltroData" e isso influencia diretamente na lista de retorno.

A API também conta com alguns métodos de GET de baixa pedidos auxiliares que realizam consultas mais específicas, são eles:

GET/pedidos/situacaoPedido
GET/pedidos/formaPagamento

Consultando um pedido específico

Para realizar a consulta de um pedido específico, utilize o endpoint Consultando um pedido específico.

Na consulta é possível identificar diversas informações sobre o pedido, confira na listagem abaixo algumas delas:

  • Valor subtotal sem desconto;
  • Embalagens;
  • Personalização;
  • Valor Frete Cliente e Valor Frete Empresa;
  • Centro de Distribuição de itens;
  • Valor de desconto de um produto;
  • Observações adicionais inseridas no pedido;
  • Entrega agendada;
  • Retirada na Loja, e outras.

Atualizando o status de um pedido

Para atualizar o status de um pedido, utilize o endpoint PUT/pedidos/{pedidoId}/status.

Inserindo uma observação em um pedido

Para inserir uma observação em um pedido, utilize o endpoint POST/pedidos/{pedidoId}/observacao.