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

Detalhes da exceção de opções

Referência dos campos de uma exceção de opções e dos endpoints product_option_exceptions.

Esta página descreve os campos que representam os detalhes de uma exceção de opções de produto. As exceções permitem definir preços especiais ou disponibilidade para combinações específicas de opções do produto.

Referência de campos

Campos da exceção

exception_idinteger

Um identificador único da exceção.

product_idinteger

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

combinationobject

As opções e as variantes delas que formam a exceção.

Exemplo de objeto de exceção

json

{
  "exception_id": 42,
  "product_id": 123,
  "combination": {
    "option_1": "variant_a",
    "option_2": "variant_b"
  }
}

Trabalhando com combinações de exceção

O objeto combination representa o conjunto específico de opções do produto que aciona esta exceção. Cada chave do objeto corresponde a um ID de opção, e o valor dela corresponde ao ID da variante.

Usando exceções nas requisições

Obter uma exceção

GET/api/product_option_exceptions/{id}Admin

Obter uma exceção de opções específica pelo ID

Parâmetros de caminho

idintegerobrigatório

O ID da exceção.

200Exemplo de resposta

json

{
  "exception_id": 42,
  "product_id": 123,
  "combination": {
    "color": "red",
    "size": "large"
  },
  "price": 29.99,
  "in_stock": true,
  "amount": 15
}

Criar uma exceção

POST/api/product_option_exceptionsAdmin

Criar uma nova exceção de opções

Corpo da requisição

product_idinteger

O produto ao qual a exceção está associada.

combinationobject

As opções e as variantes delas que formam a exceção.

price_modifiernumber

Valor somado ao preço base do produto, como mostra o exemplo original.

modifier_typestring

Tipo do modificador de preço. O exemplo original usa A.

Exemplo de requisição

json

{
  "product_id": 123,
  "combination": {
    "color": "blue",
    "size": "medium"
  },
  "price_modifier": 5.00,
  "modifier_type": "A"
}

Veja também

Detalhes da exceção de opções

Referência dos campos de uma exceção de opções e dos endpoints product_option_exceptions.

Referência de campos

Campos da exceção

exception_idinteger

Um identificador único da exceção.

product_idinteger

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

combinationobject

As opções e as variantes delas que formam a exceção.

Exemplo de objeto de exceção

json

{
  "exception_id": 42,
  "product_id": 123,
  "combination": {
    "option_1": "variant_a",
    "option_2": "variant_b"
  }
}

Trabalhando com combinações de exceção

Usando exceções nas requisições

Obter uma exceção

GET/api/product_option_exceptions/{id}Admin

Obter uma exceção de opções específica pelo ID

Parâmetros de caminho

idintegerobrigatório

O ID da exceção.

200Exemplo de resposta

json

{
  "exception_id": 42,
  "product_id": 123,
  "combination": {
    "color": "red",
    "size": "large"
  },
  "price": 29.99,
  "in_stock": true,
  "amount": 15
}

Criar uma exceção

POST/api/product_option_exceptionsAdmin

Criar uma nova exceção de opções

Corpo da requisição

product_idinteger

O produto ao qual a exceção está associada.

combinationobject

As opções e as variantes delas que formam a exceção.

price_modifiernumber

Valor somado ao preço base do produto, como mostra o exemplo original.

modifier_typestring

Tipo do modificador de preço. O exemplo original usa A.

Exemplo de requisição

json

{
  "product_id": 123,
  "combination": {
    "color": "blue",
    "size": "medium"
  },
  "price_modifier": 5.00,
  "modifier_type": "A"
}