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

Módulo de Pizza

Listar os tamanhos de Pizza disponíveis no cardápio de uma Loja

https://deliverydireto.com.br/admin-api/v1/pizzas/sizes

Busca informações sobre os tamanhos de pizza presentes no cardápio de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Criar um novo tamanho de Pizza

https://deliverydireto.com.br/admin-api/v1/pizzas/sizes

  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

Cria um novo tamanho de pizza no cardápio de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Editar informações de um tamanho de Pizza

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

  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

Edita as informações de um tamanho de pizza presente no cardápio de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Tamanhos de pizza podem incluir em si uma imagem para ilustrar do que se tratam. Para a inserção desta imagem, utilizar o endpoint de inserção de imagem para tamanhos de pizza.

Apagar um tamanho de Pizza do cardápio de uma Loja

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

  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

Apaga um tamanho de pizza do cardápio de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Inserir imagem para um tamanho de Pizza

https://deliverydireto.com.br/admin-api/v1/pizzas/sizes/{id}/image

  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

Realiza o upload de um imagem para ser associada a um determinado tamanho de pizza do cardápio de uma loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Listar horários de disponibilidade de um tamanho de Pizza

https://deliverydireto.com.br/admin-api/v1/pizzas/sizes/{sizesId}/availabilities

  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

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

Caso o tamanho de pizza 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 horários de disponibilidade para um tamanho de Pizza

https://deliverydireto.com.br/admin-api/v1/pizzas/sizes/{sizesId}/availabilities/batch

  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

Cria os horário de disponibilidade de um tamanho de pizza presente no cardápio de 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 tamanho de Pizza

https://deliverydireto.com.br/admin-api/v1/pizzas/sizes/{sizesId}/availabilities/{id}

  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

Edita um horário de disponibilidade de um tamanho de pizza presente no cardápio de 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 tamanho de Pizza

https://deliverydireto.com.br/admin-api/v1/pizzas/sizes/{sizesId}/availabilities/{id}

  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

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

Listar os sabores de Pizza associados a um tamanho de Pizza

https://deliverydireto.com.br/admin-api/v1/pizzas/sizes/{id}/flavors

  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

Lista todos os sabores de pizza que estão vinculadas a um determinado tamanho de pizza.

Apagar a associação entre um sabor de Pizza e um tamanho de Pizza

https://deliverydireto.com.br/admin-api/v1/pizzas/sizes/{sizeId}/flavors/{flavorId}

  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

Apaga a associação entre um sabor de pizza e um tamanho de pizza do cardápio da loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Listar os sabores de Pizza disponíveis no cardápio de uma Loja

https://deliverydireto.com.br/admin-api/v1/pizzas/flavors

  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

Busca informações sobre os sabores de pizza presentes no cardápio de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Criar um novo sabor de Pizza

https://deliverydireto.com.br/admin-api/v1/pizzas/flavors

  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

Cria um novo sabor de pizza no cardápio de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Editar informações de um sabor de Pizza

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

  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

Edita as informações de um sabor de pizza presente no cardápio de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Sabores de pizza podem incluir em si uma imagem para ilustrar do que se tratam. Para a inserção desta imagem, utilizar o endpoint de inserção de imagem para sabores de pizza.

Apagar um sabor de Pizza

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

  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

Apaga um sabor de pizza do cardápio de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Inserir imagem para um sabor de Pizza

https://deliverydireto.com.br/admin-api/v1/pizzas/flavors/{id}/image

  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

Realiza o upload de um imagem para ser associada a um determinado sabor de pizza do cardápio de uma loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Listar os tamanhos de Pizza associados a um sabor de Pizza

https://deliverydireto.com.br/admin-api/v1/pizzas/flavors/{id}/sizes

  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

Lista todos os tamanhos de pizza que estão vinculadas a um determinado sabor de pizza.

Associar um ou mais tamanhos de Pizza a um sabor de Pizza

https://deliverydireto.com.br/admin-api/v1/pizzas/flavors/{id}/sizes/batch

  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

Associa um sabor de pizza a um ou mais tamanhos de pizza do cardápio da loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Editar um ou mais tamanhos de Pizza associados a um sabor de Pizza

https://deliverydireto.com.br/admin-api/v1/pizzas/flavors/{id}/sizes/batch

  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

Edita um ou mais tamanhos de pizza associados a um sabor de pizza presente no cardápio de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Listar horários de disponibilidade de um sabor de Pizza

https://deliverydireto.com.br/admin-api/v1/pizzas/flavors/{flavorId}/availabilities

  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

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

Caso o sabor de pizza 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 horários de disponibilidade para um sabor de Pizza

https://deliverydireto.com.br/admin-api/v1/pizzas/flavors/{flavorId}/availabilities/batch

  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

Cria os horário de disponibilidade de um sabor de pizza presente no cardápio de 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 sabor de Pizza

https://deliverydireto.com.br/admin-api/v1/pizzas/flavors/{flavorId}/availabilities/{id}

  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

Edita um horário de disponibilidade de um sabor de pizza presente no cardápio de 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 sabor de Pizza

https://deliverydireto.com.br/admin-api/v1/pizzas/flavors/{flavorId}/availabilities/{id}

  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

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

Listar os tipos de adicionais de Pizza disponíveis no cardápio de uma Loja

https://deliverydireto.com.br/admin-api/v1/pizzas/properties

  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

Busca informações sobre os tipos de adicionais de pizza presentes no cardápio de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Criar um novo tipo de adicional de Pizza

https://deliverydireto.com.br/admin-api/v1/pizzas/properties

  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

Cria um novo tipo de adicional de pizza no cardápio de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Editar informações de um tipo de adicional de Pizza

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

  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

Edita as informações de um tipo de adicional de pizza presente no cardápio de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Apagar um tipo de adicional de Pizza

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

  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

Apaga um tipo de adicional de pizza do cardápio de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Listar as opções de um tipo de adicional de Pizza

https://deliverydireto.com.br/admin-api/v1/pizzas/properties/{id}/options

  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

Busca informações sobre as opções de um tipo de adicional de pizza presentes no cardápio de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Criar uma nova opção para um tipo de adicional de Pizza

https://deliverydireto.com.br/admin-api/v1/pizzas/properties/{id}/options

  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

Cria uma nova opção para um tipo de adicional de pizza no cardápio de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Editar informações de uma opção de um tipo de adicional de Pizza

https://deliverydireto.com.br/admin-api/v1/pizzas/properties/{propertyId}/options/{id}

  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

Edita as informações de uma opção de tipo de adicional de pizza presente no cardápio de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Apagar uma opção de uma opção de um tipo de adicional de Pizza

https://deliverydireto.com.br/admin-api/v1/pizzas/properties/{propertyId}/options/{id}

  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

Apaga uma opção de um tipo de adicional de pizza do cardápio de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Listar as opções de um tipo de adicional de Pizza associado a um determinado tamanho de Pizza

https://deliverydireto.com.br/admin-api/v1/pizzas/sizes/{sizesId}/properties/{propertiesId}/options

  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

Busca informações sobre as opções de um tipo de adicional associado a um determinado tamanho de pizza presente no cardápio de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Editar os preços dos tamanhos associados a uma determinada opção de um tipo de adicional de Pizza

https://deliverydireto.com.br/admin-api/v1/pizzas/properties/{propertiesId}/options/{id}/sizes/batch

  • Credenciais necessárias: administrador.

  • Entidades relacionadas: –

Edita o preço de um tamanho de pizza associado a uma determinada opção de um tipo de adicional de pizza presente no cardápio de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).