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

Categoria

Listar Categorias do cardápio de uma Loja

https://deliverydireto.com.br/admin-api/v1/catalog/categories
Busca informações sobre categorias presentes no cardápio de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Criar uma nova Categoria no cardápio de uma Loja

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

  • Entidades relacionadas: –

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

 

Categorias 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 de categoria.

Editar informações de uma Categoria

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

  • Entidades relacionadas: –

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

Categorias 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 de categoria.

Apagar uma Categoria do cardápio de uma Loja

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

  • Entidades relacionadas: –

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

Inserir imagem para uma Categoria

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

  • Entidades relacionadas: –

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

Alterar ordem de exibição das Categorias do cardápio de uma Loja

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

  • Entidades relacionadas: –

Ordena as categorias presentes no cardápio de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

 

A ordernação é feita de forma automática, pela seguinte regra: orderna-se primeiramente pelo parâmetro viewOrder de cada categoria, e em seguida pela ordem alfabética do nome (parâmetro name) de cada categoria.

Listar os horários de disponibilidade de uma Categoria

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

  • Entidades relacionadas: –

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

Caso a categoria 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 um novo horário de disponibilidade para uma Categoria

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

  • Entidades relacionadas: –

Cria um novo horário de disponibilidade de uma categoria 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“.

Criar um conjunto de novos horários de disponibilidade para uma Categoria

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

  • Entidades relacionadas: –

Cria um conjunto de novos horário de disponibilidade de uma categoria 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“.

Apaga um horário de disponibilidade de uma Categoria

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

  • Entidades relacionadas: –

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