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

V1 – Português (Brasil)
V2 – Português – (Brasil)

Introdução

INTEGRAÇÃO

Visão Geral
Primeiros Passos
Entidades e Processos
Autenticação

Operações

Administrador
Área de Entrega
Cartão de Crédito
Categoria
Cliente
Cupom
Endereço de Entrega
Horário de Funcionamento
Item
Local
Loja
Marca
Member Get Member (MGM)
Módulo de Pizza
Opção
Pagamento
Pedido
Programa de Fidelidade
Taxa de Entrega
Variação
Webhooks

Dúvidas Frequentes

HISTÓRICO DE ATUALIZAÇÕES

Histórico de Atualizações

Programa de Fidelidade

Listar os Programas de Fidelidade de uma Loja

https://deliverydireto.com.br/admin-api/v1/loyaltyprograms

  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

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

Criar um novo Programa de Fidelidade em uma Loja

https://deliverydireto.com.br/admin-api/v1/loyaltyprograms

  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

Cria um novo programa de fidelidade em uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Editar informações de um Programa de Fidelidade

https://deliverydireto.com.br/admin-api/v1/loyaltyprograms/{id}

  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

Edita as informações de um programa de fidelidade de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Apagar um Programa de Fidelidade

https://deliverydireto.com.br/admin-api/v1/loyaltyprograms/{id}

  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

Apaga um programa de fidelidade de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Listar os passos de um Programa de Fidelidade progressivo

https://deliverydireto.com.br/admin-api/v1/loyaltyprograms/{id}/steps

  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

Lista os passos de um programa de fidelidade de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Criar novos passos para um Programa de Fidelidade progressivo

https://deliverydireto.com.br/admin-api/v1/loyaltyprograms/{id}/steps/batch

  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

Cria um ou mais novos passos para um programa de fidelidade de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Apagar um passo de um Programa de Fidelidade progressivo

https://deliverydireto.com.br/admin-api/v1/loyaltyprograms/{loyaltyprogramsId}/steps/{id}

  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

Apaga um passo de um programa de fidelidade de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Listar os participantes de um Programa de Fidelidade

https://deliverydireto.com.br/admin-api/v1/loyaltyprograms/{id}/participants

  • Credenciais necessárias: administrador.

  • Entidades relacionadas: Cliente.

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

Um cliente é considerado “participante” de um programa de fidelidade a partir do primeiro pedido finalizado com sucesso na loja após a criação/ativação do programa de fidelidade.

É possível encontrar informações sobre o progresso de cada cliente no programa de fidelidade atual da loja, incluindo se o cliente possui prêmios disponíveis para resgate.

Buscar o Programa de Fidelidade ativo na Loja

https://deliverydireto.com.br/store-api/v1/stores/active-loyaltyprogram

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

Buscar informações do Programa de Fidelidade do Cliente atualmente autenticado

https://deliverydireto.com.br/store-api/v1/customers/me/active-loyaltyprogram-info

  • Credenciais necessárias: cliente.

  • Entidades relacionadas: Cliente.

Busca informações sobre a participação do cliente atualmente autenticado no programa de fidelidade ativo em uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).