API legada/Referência completa/Exceções de opções

Criar uma exceção de opções

Cria uma nova exceção de opções para um produto e devolve o ID dela.

As exceções de opções permitem definir combinações de opções que não devem estar disponíveis juntas. Este endpoint cria uma nova exceção para um produto específico e devolve o exception_id dela.

POST/api/exceptionsAdmin

Criar uma nova exceção de opções para um produto

Envie os parâmetros no corpo da requisição HTTP, de acordo com o Content-Type que você informar.

Corpo da requisição

product_idintegerobrigatório

O identificador único do produto ao qual a exceção está associada.

combinationobject

As opções e variantes que formam a exceção. As chaves do objeto são IDs de opção e os valores são IDs de variante.

Exemplo de requisição

bash

curl -X POST -u "$EMAIL:$API_KEY" "$BASE_URL/api/exceptions/" \
  -H "Content-Type: application/json" \
  -d '{
  "product_id": "12",
  "combination": {
    "3": "-1",
    "4": "19",
    "17": "61"
  }
}'

Esta requisição cria uma nova exceção para o produto com product_id=12. Essa exceção descreve a seguinte combinação de variantes que não devem estar disponíveis juntas: qualquer variante da opção 3, a variante 19 da opção 4 e a variante 61 da opção 17.

Resposta

201Criada

json

{
  "exception_id": "10"
}

Erros

Status	Quando
400 Bad Request	A exceção não pôde ser criada por parâmetros inválidos ou outros problemas.

Notas de implementação

As exceções de opções são úteis para definir regras sobre quais combinações de opções não devem estar disponíveis juntas. Isso ajuda quando:

Certas combinações de opções são fisicamente incompatíveis.
Você quer impedir que o cliente selecione combinações que não podem ser atendidas.
Algumas combinações de opções não fazem sentido para o seu produto.

Cenários comuns em que as exceções são úteis:

Roupas em que certas combinações de cor e tamanho não estão disponíveis.
Eletrônicos em que alguns recursos são incompatíveis com outras configurações.
Produtos personalizáveis em que certas opções de personalização não podem ser combinadas.
Alimentos em que certos ingredientes não podem ser misturados por sabor ou preparo.

Veja também