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

Opção

Listar Opções presentes no cardápio de uma Loja

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

  • Entidades relacionadas: –

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

Vale ressaltar que podem existir opções sem vínculo a variações. Para que opções sejam exibidas no cardápio da loja do Delivery Direto, estas devem estar vinculadas a variações, estas por sua vez tendo de estar vinculadas a algum produto.

Criar uma nova Opção no cardápio de uma Loja

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

  • Entidades relacionadas: –

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

Vale ressaltar que opções criadas por este endpoint não possuem vínculo a nenhuma variação. Para que opções sejam exibidas no cardápio da loja do Delivery Direto, estas devem estar vinculadas a variações, estas por sua vez tendo de estar vinculadas a algum produto.

Editar informações de uma Opção

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

  • Entidades relacionadas: –

Edita as informações de uma opção 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 do cardápio de uma Loja

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

  • Entidades relacionadas: –

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

Associar uma Opção a uma Variação

https://deliverydireto.com.br/admin-api/v1/catalog/properties/{propertyId}/options/{optionId}/link
  • Credenciais necessárias: administrador.

  • Entidades relacionadas: Variação.

Associa uma opção a uma determinada variação do cardápio da loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Dissociar uma Opção de uma Variação

https://deliverydireto.com.br/admin-api/v1/catalog/properties/{propertyId}/options/{optionId}/link
  • Credenciais necessárias: administrador.

  • Entidades relacionadas: Variação.

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

Listar todas as Variações que possuem uma determinada Opção

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

  • Entidades relacionadas: Variação.

Lista todas as variações presentes no cardápio de uma loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição) que possuem uma determinada opção.

Listar todas as Opções que estão associadas a uma determinada Variação

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

  • Entidades relacionadas: Variação.

Lista todas as opções que estão vinculadas a uma determinada variação.

Ordenar as Opções de uma Variação

https://deliverydireto.com.br/admin-api/v1/catalog/properties/{propertyId}/options/autosort
  • Credenciais necessárias: administrador.

  • Entidades relacionadas: Variação.

Ordena as opções associadas a uma variação presente 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 baseViewOrder de cada opção, e em seguida pela ordem alfabética do nome (parâmetro name) de cada opção.

Editar uma Opção vinculada especificamente a uma Variação e Produto

https://deliverydireto.com.br/admin-api/v1/catalog/items/{itemId}/properties/{propertyId}/options/{id}
  • Credenciais necessárias: administrador.

  • Entidades relacionadas: Variação, Produto.

Edita as informações de uma opção vinculada a uma variação e produto presentes no cardápio de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Caso a edição seja feita a uma opção vinculada a múltiplas variações e produtos, esta edição se aplicará apenas para a combinação de variação e produto passada para o endpoint.

Apagar uma Opção vinculada especificamente a uma Variação e Produto

https://deliverydireto.com.br/admin-api/v1/catalog/items/{itemId}/properties/{propertyId}/options/{id}
  • Credenciais necessárias: administrador.

  • Entidades relacionadas: Variação, Produto.

Apaga uma opção vinculada a uma variação e produto presentes no cardápio de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).

Caso a deleção seja feita a uma opção vinculada a múltiplas variações e produtos, esta deleção se aplicará apenas para a combinação de variação e produto passada para o endpoint.