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

Área de Entrega

Listar Áreas de Entrega de uma Loja

https://deliverydireto.com.br/admin-api/v1/delivery-areas

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

A busca neste endpoint não inclui locais específicos, apenas raios e polígonos. Consulte o endpoint de busca de locais específicos para obter esta informação (necessário permissões de administrador ou de cliente).

O endpoint que requer permissões de administrador permite buscas com filtros para as áreas de entrega, enquanto o endpoint que requer permissões de cliente não aceita tais filtros.

Criar uma Área de Entrega em uma Loja

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

  • Entidades relacionadas: –

Cria uma área de entrega em uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

 

Para a criação de locais específicos, consultar o endpoint de criação de locais específicos.

Editar informações de uma Área de Entrega de uma Loja

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

  • Entidades relacionadas: –

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

Para a edição de locais específicos, consultar o endpoint de edição de locais específicos.

Editar informações de Áreas de Entrega em massa

https://deliverydireto.com.br/admin-api/v1/delivery-areas/settings/all
  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

Edita algumas configurações específicas de todas as áreas de entrega de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição). Esta requisição atualiza as informações de locais específicos também.

Os campos atualizados são minimumWaitingTime, maximumWaitingTime e price. Esta operação pode demorar.

Apagar uma Área de Entrega de uma Loja

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

  • Entidades relacionadas: –

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

Para apagar locais específicos, consultar o endpoint de apagar de locais específicos.

Listar endereços de um cliente disponíveis para entrega em uma determinada loja

https://api-beta.deliverydireto.com.br/store-api/v1/stores/customers/me/viable-addresses
  • Credenciais necessárias: cliente.

  • Entidades relacionadas: Cliente.

Determina quais endereços do cliente são elegíveis para entrega em uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição) são elegíveis para entrega.

Determinar se um endereço de entrega é elegível para entrega em uma determinada loja

https://deliverydireto.com.br/admin-api/v1/delivery-areas/address/check
  • Credenciais necessárias: administrador.

  • Entidades relacionadas: Endereço de Entrega.

Checa se um endereço de entrega é elegível para entrega em uma determinada loja.

O momento da consulta é levado em consideração para determinar se o endereço é elegível (ou seja, se a área de entrega na qual o endereço é contida estiver inativa temporáriamente, o endereço não é elegível para entrega naquele momento). Para consultar em um determinado momento do dia, utilizar o parâmetro scheduling.

Listar configurações gerais relacionadas a Áreas de Entrega

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

  • Entidades relacionadas: –

Lista configurações gerais envolvendo áreas de entrega de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

 

Segue a descrição de algumas das configurações disponíveis:

  • enablePostCheckoutEta: habilita/desabilita mostrar uma estimativa do tempo necessário para a entrega do pedido. Esta estimativa para o cliente da loja, logo após a realização do pedido.

  • freeDeliveryMinimumOrder: indica o valor mínimo que um pedido deve ter para que o cliente da loja possa obter frete grátis em sua entrega. Não é necessário que uma loja cadastre tal valor.

  • freeDeliveryTimeout: indica o horário em que expira uma campanha de frete grátis na entrega de uma determinada loja.

  • minimumOrder: indica o valor mínimo que um pedido deve ter para que o cliente possa realizar pedidos de delivery na loja. Não é necessário que uma loja cadastre tal valor.

  • takeoutMinimumOrder: análogo ao anterior, mas para pedidos retirados pelo cliente.

  • takeoutStatus: indica se pedidos de retirada estão habilitados para esta loja.

  • takeoutTime: indica o tempo (em minutos) necessário para o preparo de um pedido de retirada.

Editar configurações gerais relacionadas a Áreas de Entrega

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

  • Entidades relacionadas: –

Edita configurações gerais envolvendo áreas de entrega de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Segue a descrição de algumas das configurações disponíveis:

  • enablePostCheckoutEta: habilita/desabilita mostrar uma estimativa do tempo necessário para a entrega do pedido. Esta estimativa para o cliente da loja, logo após a realização do pedido.

  • freeDeliveryMinimumOrder: indica o valor mínimo que um pedido deve ter para que o cliente da loja possa obter frete grátis em sua entrega. Não é necessário que uma loja cadastre tal valor.

  • freeDeliveryTimeout: indica o horário em que expira uma campanha de frete grátis na entrega de uma determinada loja.

  • minimumOrder: indica o valor mínimo que um pedido deve ter para que o cliente possa realizar pedidos de delivery na loja. Não é necessário que uma loja cadastre tal valor.

  • takeoutMinimumOrder: análogo ao anterior, mas para pedidos retirados pelo cliente.

  • takeoutStatus: indica se pedidos de retirada estão habilitados para esta loja.

  • takeoutTime: indica o tempo (em minutos) necessário para o preparo de um pedido de retirada.