INTEGRAÇÃO
Operações
HISTÓRICO DE ATUALIZAÇÕES
Introdução
Estruturas do Delivery Direto
Marca
Cada cliente do Delivery Direto pode possuir uma ou mais lojas. Para clientes que possuem múltiplas lojas de uma mesma franquia, realizamos o agrupamento de suas lojas sob uma mesma marca.
Loja
A loja de cada cliente é onde fica contida a maior parte das operações do Delivery Direto. O cliente configura sua loja de forma a deixá-la apropriada para sua operação, e então passa a receber pedidos por ela.
Primeiramente, vamos detalhar cada parte da configuração de uma loja, para então tratarmos da operação do lojista e do recebimento de pedidos.
Cardápio
O cardápio de um cliente é o conjunto de todos os itens que o mesmo oferece para venda pela plataforma do Delivery Direto. O seguinte diagrama resume a hierarquia das estruturas que foram abordadas até o momento:
A seguir, vamos detalhar cada uma das estruturas que compõem o cardápio do restaurante de um cliente.
Categoria
Categorias são formas de agrupar itens em uma loja. Categorias são criadas sem itens, mas são apenas exibidas para clientes da loja uma vez que passam a conter um ou mais itens.
Item, Variação e Opção
Itens no Delivery Direto representam os itens oferecidos por um lojista em sua venda. Eles seguem a estrutura expressa visualmente acima: um item pode (ou não) conter em si uma ou mais variações, e estas devem conter no mínimo uma opção para cada.
É possível pensar nas variações como grupos de opções:
-
Elas geralmente possuem um título que representam genericamente as opções contidas em si;
-
Elas possuem o método de cálculo que será utilizado para determinar o valor total das opções selecionadas;
-
Elas determinam limites para quantas opções podem ser selecionadas, e se é obrigatório ou não selecionar uma determinada quantidade de opções;
Opções, por sua vez, são utilizadas para expressar todas as possíveis formas/complementos que um item pode tomar/ter. Veja os seguintes exemplos de itens:
Como podemos ver, a estrura de itens no Delivery Direto permite grande liberdade na estruturação do cardápio de cada cliente, mas deve seguir necessariamente as regras expressas anteriormente.
Cada variação possui um tipo de cálculo que é utilizado para determinar o valor total das opções selecionadas naquela variação. Os tipos de cálculo possíveis são:
-
Soma: os valores de todas as opções selecionadas são somados.
-
Média: os valores de todas as opções selecionadas são somados, e o resultado é então dividido pelo número total de opções selecionadas.
-
Maior: o valor final é equivalente ao valor da opção de maior valor selecionada.
-
Menor: o valor final é equivalente ao valor da opção de menor valor selecionada.
Para auxiliar em sua integração, o sistema do Delivery Direto conta com um campo de código para cada item e opção. Este campo pode ser preenchido com qualquer valor alfanumérico, para que sejam feitas equivalências entre os itens e opções do Delivery Direto com elementos do seu próprio sistema.
Módulo de Pizza
O Módulo de Pizza é uma extensão gratuita do Delivery Direto, utilizado por restaurantes que buscam maior facilidade em representar os diversos tipos de pizza que eles podem servir para seus clientes.
As pizzas criadas por este módulo comportam-se de forma análoga aos itens regulares, mas diferem destes tanto na terminologia utilizada para definir sua estrutura, quanto nas relações entre cada parte de sua estrutura. Observe o seguinte diagrama:
As diferenças ocorrem principalmente no comportamento entre as entidades:
-
O valor-base de um item de pizza não é definido pelo seu tamanho, e sim pela relação entre cada tamanho e um sabor.
-
Todos os tamanhos podem ter acesso a todos os sabores, mas é possível configurar para que certos sabores apareçam apenas para certos tamanhos.
-
Todos os adicionais ficam disponíveis para todos os tamanhos, mas seus valores podem variar dependendo do tamanho da pizza.
Administradores e Cliente
Existem dois tipos de usuários do sistema do Delivery Direto: administradores e clientes.
Os usuários administradores representam os donos das lojas e seus operadores. Administradores possuem níveis de acesso diferentes (Administrador e Operador), os quais influenciam a gama de operações para as quais o usuário possui acesso.
Os usuários clientes representam os clientes de cada uma das lojas do Delivery Direto. Cada cliente precisa de uma conta criada no Delivery Direto para a realização de pedidos, e cada conta de cliente é associada a uma determinada marca. A entidade de cliente contém informações pertinentes para a criação de pedidos no Delivery Direto: dados da pessoa física, endereços e dados de pagamento são alguns exemplos.
Pedido
Cada loja no Delivery Direto recebe pedidos, os quais contém itens. Cada item pode conter variações, as quais podem conter dentro de si opções. As relações entre lojas, pedidos e itens estão representadas no seguinte fluxograma:
Um pedido no Delivery Direto contém uma lista de itens que devem ser produzidos para um determinado cliente, mas ele não se limita somente a isso. Segue a lista completa de informações que estão associadas a um pedido:
-
Dados do pedido (valores, datas, observações);
-
Dados do usuário (nome, email, telefone);
-
Dados do endereço de entrega;
-
Dados sobre a forma de pagamento;
Pedidos no Delivery Direto também podem ser agendados, fazendo com que a sua produção não seja imediata, e sim próxima à data agendada pelo cliente da loja. Pedidos agendados são exibidos separadamente dos demais pedidos no Delivery Direto, e tornam-se um pedido normal quando a data atual aproxima-se da data agendada.
Pedidos podem ser do tipo:
- DELIVERY: pedidos feitos para entrega.
- TAKEOUT: pedidos feitos para retirada na loja.
- TABLE: pedidos feitos na mesa para serem consumidos no próprio estabelecimento.
Existem dois métodos de pagamento para os pedidos:
- Pagamento Offline, ou seja, pagos no momento da entrega/retirada.
- Pagamento Online, pago no site/aplicativo no momento em que o pedido foi realizado.
Para habilitar o Pagamento Online, o lojista deve se utilizar da seção de “Pagamento online” no nosso painel de administrador.
Configurações da Loja
Uma loja no Delivery Direto deve ser configurada para acomodar a operação do lojista da melhor forma possível. Grande parte das configurações do Delivery Direto são feitas de forma única (exemplo: nome da loja, endereço, logo), então são omitidas da nossa API, e devem ser feitas via o nosso painel do administrador. No entanto, algumas configurações devem ser alteradas mais frequentemente, e são portanto cobertas pelos endpoints da nossa API.
Área de Entrega
As áreas de entrega são as áreas em que uma loja no Delivery Direto realiza o serviço de entrega. Áreas de entrega podem ser representadas por polígonos, raios (círculos) ou endereços específicos (CEPs).
Além disso, cada área de entrega conta com um tempo mínimo e máximo de espera, que será exibido para o cliente do restaurante quando ele realizar um pedido de um endereço contido em uma determinada área de entrega.
Cada área de entrega conta com seu determinado valor de entrega, que fica ao critério do estabelecimento definir. Este preço pode variar dinâmicamente com o horário do dia, se a área de entrega for configurada de acordo. Caso contrário, o preço será fixo para aquela área de entrega.
Por fim, áreas de entrega podem ser inativadas por um determinado horário, caso o lojista as configure apropriadamente. Um uso comum para a inativação de áreas de entrega é criar endereços específicos (CEPs) para os quais a loja não deseja prestar atendimento. Isto é feito programando a inativação da área de entrega com início às 00:00 e término às 00:00h.
Formas de Pagamento
Uma loja também pode definir quais formas de pagamento ela aceita para os pedidos pagos na entrega/retirada. Esta configuração permite que, por exemplo, o lojista decida por aceitar ou não o pagamento em dinheiro, ou que ele defina quais bandeiras de cartão de débito/crédito ele aceita para pagamento.
Divulgação da Loja
O Delivery Direto conta com diversas modalidades de programas de divulgação, utilizados para criar engajamento entre um estabelecimento e seus clientes.
Cupom de Desconto
O lojista pode criar uma série de cupons de desconto para garantir benefícios para seus clientes. Esses benefícios podem incluir descontos no valor do pedido (seja em valor fixo ou em porcentagem), taxa de entrega grátis ou algum outro tipo de benefício (que virá representado por escrito na observação do pedido).
Cupons podem ser configurados extensivamente, para criar condições específicas tanto para sua utilização (exemplo: horário específico de uso, número máximo de usos, etc.), quanto para sua aplicação (apenas para categorias específicas do cardápio).
Cupons são utilizados pelos clientes via um código específico que é gerado na criação do mesmo, e deve ser aplicado nas etapas finais da criação de um pedido pelo cliente.
Programa de Fidelidade
Programas de fidelidade são utilizados para gerar fidelização de clientes em uma determinada loja, incentivando compras recorrentes na loja por meio de recompensas.
Programas de fidelidade podem ser de dois tipos: tradicionais ou progressivos.
Programas de fidelidade tradicionais garantem recompensas para clientes que realizam compras recorrentes, concedendo um prêmio fixo dependendo do número de compras que o cliente realiza, ou quando o cliente atinge um determinado valor total gasto na loja.
Programas de fidelidade progressivos são análogos a vários programas de fidelidade tradicionais sequenciais. O cliente de uma loja números de pedidos até uma determinada marca, na qual ele obtém um prêmio. Após atingir essa marca, ele segue com os pedidos acumulados até atingir a próxima marca, na qual um prêmio independente do primeiro é concedido.
Os prêmios concedidos são análogos aos benefícios dos cupons: descontos no valor do pedido (seja em valor fixo ou em porcentagem), taxa de entrega grátis ou algum outro tipo de benefício (que virá representado por escrito na observação do pedido).
Indique um Amigo (Member Get Members)
O programa de Member Get Members (a partir de então referido por MGM) é uma forma de incentivar a divulgação interpessoal entre clientes de uma loja do Delivery Direto e outros indivíduos que ainda não são clientes dessa mesma loja.
Uma vez ativado, cada cliente recebe um código único, o qual ele pode divulgar entre seus conhecidos, para que eles tenham determinados benefícios ao realizar seu primeiro pedido na loja do Delivery Direto. Uma vez que o indicado finaliza o seu primeiro pedido com sucesso, o cliente que realizou a indicação recebe o mesmo beneficio que o indicado recebeu para sua próxima compra.
Os prêmios concedidos são análogos aos benefícios dos cupons: descontos no valor do pedido (seja em valor fixo ou em porcentagem), taxa de entrega grátis ou algum outro tipo de benefício (que virá representado por escrito na observação do pedido).
Esta seção é destinada a desenvolvedores parceiros que não tem grande familiaridade com o sistema do Delivery Direto. Nela, detalhamos as principais entidades envolvidas nos endpoints de nossa API, e como elas se relacionam entre si na estrutura do nosso sistema.
Vale ressaltar que existem operações no Delivery Direto que envolvem mais de uma entidade. Entender as estruturas e relações entre entidades permite uma maior clareza no funcionamento das operações do nosso sistema, facilitando o uso correto dos nossos endpoints em sua integração.