API  Versão 2 – Português (Brasil)

Pedido

Buscar Pedidos de uma Loja

https://deliverydireto.com.br/admin-api/v1/orders
  • Credenciais necessárias: administrador.

  • Entidades relacionadas: Cliente, Pagamento, Endereço de Entrega, Cupom, Programa de Fidelidade, Member Get Member (MGM), Produto, Variação, Opção.

Busca informações sobre pedidos de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

A busca pode conter diversos filtros para facilitar encontrar diversos sub-grupos de pedidos. Os filtros possíveis são:

  • Por informações do cliente que realizou o pedido (ID, nome, email ou telefone podem ser utilizados).

  • Por informações do próprio pedido (ID, intervalo de tempo em que o pedido foi criado, ou se o pedido é agendado ou não são filtros possíveis).

Para evitar sobrecargas em buscar que retornem muitos resultados, não mostramos os detalhes de produtos por padrão no retorno desta requisição. Para exibir os produtos dos pedidos retornados, utilize-se do parâmetro showItems.

Alterar Status de um Pedido

https://deliverydireto.com.br/admin-api/v1/orders/{id}/status
  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

Atualiza o estado de um determinado pedido no Delivery Direto.

Pedidos no Delivery Direto transicionam entre uma variedade de estados, começando em grande parte pelo estado “em espera”. O seguinte diagrama exemplifica as possíveis transições entre estados de pedidos no Delivery Direto:

Todas as requisições feitas para este endpoint devem respeitar as regras de transição entre estados do Delivery Direto para que obtenham sucesso.

Sobre os estados, é importante detalhar alguns pontos:

  • Os estados “em trânsito” e “finalizado” tomam nomes diferentes no painel de pedidos do Delivery Direto, dependendo do tipo do pedido (entrega ou retirada). Para pedidos de entrega, temos que “em trânsito” mantém-se como “em trânsito”, e “finalizado” aparece como “entregue”. Para pedidos de retirada, temos que “em trânsito” aparece como “pronto para retirada”, e “finalizado” aparece como “retirado”.

  • Quando o pedido entra no estado “apagado”, ele some do painel do Delivery Direto, e não pode mais ser operado pelo lojista.

  • Pedidos agendados são criados no estado “oculto” originalmente. Vinte minutos antes do tempo mínimo de espera da loja (configurado pelo lojista), o estado do pedido agendado muda para “em espera”. O lojista pode aceitar o pedido agendado antes deste momento, e então ele passa diretamente para o estado “aprovado”.

  • O estado de “atenção” é um estado que representa de forma genérica algum problema que pode ocorrer no processamento do pedido. Ele é utilizado para problemas com integrações (por exemplo, com a TOTVS Chef ou a NCR Colibri), ou para problemas no processamento de pagamentos online. Seu comportamento referente a transição de estados varia de acordo com o tipo de problema que ocorreu.