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

Loja

Listar informações da Loja

https://deliverydireto.com.br/store-api/v1/stores
  • Credenciais necessárias: cliente.

  • Entidades relacionadas: –

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

As informações listadas incluem informações genéricas sobre a loja (como seu nome e logo), mas tambem informações de configurações mais específicas (como horários de funcionamento, tempos de espera mínimo e máximo, entre outros).

Listar informações de um pedido do cliente atualmente autenticado

https://deliverydireto.com.br/store-api/v1/customers/me/orders/{id}
  • Credenciais necessárias: cliente.

  • Entidades relacionadas: –

Busca informações sobre um pedido do cliente autenticado em uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Criar um novo Pedido em uma Loja

https://deliverydireto.com.br/store-api/v1/stores/orders
  • Credenciais necessárias: cliente ou autenticação padrão (veja nossa seção de “Autenticação” para mais informações).

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

Realiza a criação de um pedido para um determinado cliente, em uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Caso não seja passado nenhum valor para o parâmetro que representa o cliente (customer), o cliente atualmente autenticado é utilizado por padrão. Caso não utilize a autenticação do cliente para acesso a este endpoint, é necessário preencher o campo em questão.

É recomendado realizar as validações dos dados do pedido (dos produtos e de endereço e valor) antes de realizar a criação do pedido.

Validar dados de Produtos de um Pedido

https://deliverydireto.com.br/store-api/v1/stores/orders/validate-cart
  • Credenciais necessárias: cliente ou autenticação padrão (veja nossa seção de “Autenticação” para mais informações)..

  • Entidades relacionadas: Pedido, Produto, Variação, Opção.

Realiza a validação dos dados dos produtos presentes em um pedido.

Validar dados de endereço e valor de um Pedido

https://deliverydireto.com.br/store-api/v1/stores/orders/validate-fulfillment
  • Credenciais necessárias: cliente ou autenticação padrão (veja nossa seção de “Autenticação” para mais informações).

  • Entidades relacionadas: Pedido.

Realiza a validação dos dados referentes a endereço e valor presentes em um pedido.

Os dados validados neste endpoint incluem endereço, agendamento e valor do pedido.

Calcular a taxa de entrega esperada para um Endereço de Entrega

https://deliverydireto.com.br/store-api/v1/stores/delivery-fees/{addressId}/calculate
  • Credenciais necessárias: cliente ou autenticação padrão (veja nossa seção de “Autenticação” para mais informações).

  • Entidades relacionadas: Endereço de Entrega.

Calcula o valor da taxa de entrega para um determinado momento para uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Listar as formas de pagamento aceitas pela Loja

https://deliverydireto.com.br/store-api/v1/stores/payment-forms
  • Credenciais necessárias: cliente ou autenticação padrão (veja nossa seção de “Autenticação” para mais informações).

  • Entidades relacionadas: Pagamento.

Busca informações das formas de pagamentos disponíveis uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Listar os horários de agendamento disponíveis para entrega em uma Loja

https://deliverydireto.com.br/store-api/v1/stores/scheduling-hours/delivery
  • Credenciais necessárias: cliente ou autenticação padrão (veja nossa seção de “Autenticação” para mais informações).

  • Entidades relacionadas: –

Busca sobre os horários de agendamento disponíveis para pedidos do tipo “entrega” em uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Listar os horários de agendamento disponíveis para retirada em uma Loja

https://deliverydireto.com.br/store-api/v1/stores/scheduling-hours/takeout
  • Credenciais necessárias: cliente ou autenticação padrão (veja nossa seção de “Autenticação” para mais informações).

  • Entidades relacionadas: –

Busca sobre os horários de agendamento disponíveis para pedidos do tipo “retirada” em uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Listar os contatos gerais de uma Loja

https://deliverydireto.com.br/store-api/v1/stores/contacts/general
  • Credenciais necessárias: cliente ou autenticação padrão (veja nossa seção de “Autenticação” para mais informações).

  • Entidades relacionadas: –

Busca informações sobre os contatos gerais presentes em uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Listar os contatos de suporte de uma Loja

https://deliverydireto.com.br/store-api/v1/stores/contacts/support
  • Credenciais necessárias: cliente ou autenticação padrão (veja nossa seção de “Autenticação” para mais informações).

  • Entidades relacionadas: –

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

Buscar uma página customizada da Loja

https://deliverydireto.com.br/store-api/v1/stores/pages/{page}
  • Credenciais necessárias: cliente ou autenticação padrão (veja nossa seção de “Autenticação” para mais informações).

  • Entidades relacionadas: –

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

As páginas customizadas são páginas as quais podem ter seus conteúdos editados diretamente pelo lojista. Atualmente, é possível apenas buscar pela página “Sobre Nós”, utilizando-se do valor “about” como parâmetro do endpoint.

Listar as Notificações de uma Loja

https://deliverydireto.com.br/store-api/v1/stores/notifications
  • Credenciais necessárias: cliente.

  • Entidades relacionadas: –

Busca informações das notificações criadas por uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

É necessária a autenticação do cliente, para determinar se a notificação foi lida por este mesmo cliente.

Listar os textos customizados de uma Loja

https://deliverydireto.com.br/store-api/v1/stores/texts
  • Credenciais necessárias: cliente ou autenticação padrão (veja nossa seção de “Autenticação” para mais informações).

  • Entidades relacionadas: –

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

Os textos retornados são configurados pelo lojista, e substituídos pelos textos originais nas partes correspondentes da loja.