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

Cupom

Listar os Cupons de uma Loja

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

  • Entidades relacionadas: –

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

Criar um novo Cupom em uma Loja

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

  • Entidades relacionadas: –

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

Editar informações de um Cupom

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

  • Entidades relacionadas: –

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

Apagar um Cupom

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

  • Entidades relacionadas: –

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

Listar os Clientes que se utilizaram de um determinado Cupom

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

  • Entidades relacionadas: Cliente.

Busca informações sobre os clientes que se utilizaram de um determinado cupom de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Verificar usabilidade de um Cupom

https://deliverydireto.com.br/store-api/v1/vouchers/{code}
  • Credenciais necessárias: cliente.

  • Entidades relacionadas: –

Verifica se um cupom é atualmente utilizável pelo cliente atualmente autenticado.

Para verificar a usabilidade, são checados vários parâmetros relacionados ao cupom, como se ele encontra-se ativo, e as demais regras descritas no começo desta página.

Listar Categorias associadas a um Cupom

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

  • Entidades relacionadas: Categoria.

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

Associar novas Categorias a um Cupom

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

  • Entidades relacionadas: –

Associa novas categorias a um cupom de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Dissociar Categorias de um Cupom

https://deliverydireto.com.br/admin-api/v1/vouchers/{id}/categories/batch/remove
  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

Dissocia categorias de cupom de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Listar horários de disponibilidade de um Cupom

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

  • Entidades relacionadas: –

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

Caso o cupom não possua nenhum horário específico de disponibilidade configurado, nada será retornado. Para mais informações sobre o formato de retorno dos campos de data, confira nossa página de “Primeiros Passos“.

Criar novo horário de disponibilidade para um Cupom

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

  • Entidades relacionadas: –

Cria um novo horário de disponibilidade para um cupom presente em uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Para mais informações sobre o formato de retorno dos campos de data, confira nossa página de “Primeiros Passos“.

Editar um horário de disponibilidade de um Cupom

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

  • Entidades relacionadas: –

Edita um horário de disponibilidade de uma cupom presente em uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Para mais informações sobre o formato de retorno dos campos de data, confira nossa página de “Primeiros Passos“.

Apagar um horário de disponibilidade de um Cupom

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

  • Entidades relacionadas: –

Apaga um horário de disponibilidade de um cupom presente em uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).