VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API legada/Referência completa/Exceções de opções

Listar exceções de opções

Retorna todas as exceções de opções de um produto.

Este endpoint retorna todas as exceções de opções de um produto específico. As exceções definem combinações inválidas de opções de produto. Por exemplo, se uma camiseta vem em várias cores e tamanhos, mas o tamanho "Pequeno" não está disponível na cor "Vermelho", você criaria uma exceção para essa combinação.

GET/api/exceptionsAdmin

Listar as exceções de opções de um produto

Parâmetros de consulta

product_idintegerobrigatório
O identificador único do produto.

Exemplo de requisição

bash
curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/exceptions/?product_id=12"

Resposta

200Exceções do produto
json
[
  {
    "exception_id": "1",
    "product_id": "12",
    "combination": {
      "3": "12",
      "4": "17",
      "17": "-1"
    }
  },
  {
    "exception_id": "4",
    "product_id": "12",
    "combination": {
      "3": "13",
      "4": "17",
      "17": "-2"
    }
  },
  {
    "exception_id": "5",
    "product_id": "12",
    "combination": {
      "3": "16",
      "4": "-1",
      "17": "-2"
    }
  }
]

Campos da resposta

exception_idstring
Identificador único da exceção.
product_idstring
ID do produto ao qual esta exceção pertence.
combinationobject

Objeto que representa a combinação inválida de opções do produto. As chaves são IDs de opção e os valores são IDs de variante ou valores especiais.

-1string
Qualquer variante desta opção.
-2string
Nenhuma variante desta opção.
Dica

Para entender o significado dos IDs de opção e de variante no objeto combination, primeiro consulte as opções do produto com GET /api/options/?product_id={id}. Veja Opções do produto.

Entendendo os valores da combinação

No objeto combination, cada chave é um ID de opção (por exemplo, "3" pode representar a opção "Tamanho"). Cada valor é:

  • Um ID de variante (por exemplo, "12" pode representar a variante de tamanho "Pequeno").
  • -1: representa "qualquer variante" desta opção.
  • -2: representa "nenhuma variante" desta opção.

Veja Valores negativos para a explicação completa.

Exemplo de interpretação

Vamos interpretar a primeira exceção da resposta de exemplo:

json
{
  "3": "12",
  "4": "17",
  "17": "-1"
}

Isso pode significar: "O tamanho Pequeno (variante 12 da opção 3) não está disponível na cor Preto/Branco (variante 17 da opção 4) com qualquer variante da opção 17 (que poderia ser uma opção de material)."

Veja também

  • Obter uma exceção específica
  • Valores negativos
Anterior
Exceções de opções
Próxima
Obter uma exceção de opções
Nesta página
  • Exemplo de requisição
  • Resposta
  • Entendendo os valores da combinação
  • Exemplo de interpretação
  • Veja também