API legada/Referência completa/Opções do produto

GETConsultar uma opção

Retorna os detalhes de uma opção de produto específica pelo seu id.

Retorna as informações detalhadas de uma opção de produto específica, a partir do seu identificador único.

GET/api/options/{option_id}Admin

Consultar uma opção

Se a requisição der certo, você recebe HTTP/1.1 200 OK e uma resposta JSON com os detalhes da opção.

Parâmetros de caminho

option_idintegerobrigatório

O identificador único da opção.

Exemplo de requisição

bash

curl "$BASE_URL/api/options/3" \
  -u "$EMAIL:$API_KEY"

Resposta

200Opção retornada

json

{
  "option_id": "3",
  "product_id": "12",
  "company_id": "1",
  "option_type": "S",
  "option_name": "Size",
  "required": "Y",
  "position": 10,
  "status": "A",
  "variants": [
    {
      "variant_id": "12",
      "option_id": "3",
      "position": 0,
      "modifier": "",
      "modifier_type": "A",
      "variant_name": "Small",
      "point_modifier": "",
      "weight_modifier": "",
      "weight_modifier_type": "",
      "status": "A"
    },
    {
      "variant_id": "13",
      "option_id": "3",
      "position": 1,
      "modifier": "5.00",
      "modifier_type": "A",
      "variant_name": "Medium",
      "point_modifier": "",
      "weight_modifier": "",
      "weight_modifier_type": "",
      "status": "A"
    },
    {
      "variant_id": "14",
      "option_id": "3",
      "position": 2,
      "modifier": "10.00",
      "modifier_type": "A",
      "variant_name": "Large",
      "point_modifier": "",
      "weight_modifier": "",
      "weight_modifier_type": "",
      "status": "A"
    }
  ]
}

Campos da resposta

Campos da opção

Campo	Tipo	Descrição
`option_id`	string	O identificador único da opção
`product_id`	string	O ID do produto ao qual a opção pertence
`company_id`	string	O ID da empresa ou do vendedor
`option_type`	string	O tipo da opção: `S` (caixa de seleção), `R` (botão de opção), `C` (caixa de marcação), `I` (texto), `T` (área de texto), `F` (arquivo), `D` (data) etc.
`option_name`	string	O nome de exibição da opção
`required`	string	Indica se a opção é obrigatória: `Y` (sim) ou `N` (não)
`position`	number	A posição de ordenação desta opção
`status`	string	O status da opção: `A` (ativa) ou `D` (desativada)
`variants`	array	Uma lista com as variantes ou valores da opção

Campos da variante

Campo	Tipo	Descrição
`variant_id`	string	O identificador único da variante
`option_id`	string	O ID da opção pai
`position`	number	A posição de ordenação desta variante
`modifier`	string	O valor do modificador de preço
`modifier_type`	string	O tipo do modificador de preço: `A` (absoluto) ou `P` (percentual)
`variant_name`	string	O nome de exibição da variante
`status`	string	O status da variante: `A` (ativa) ou `D` (desativada)

Veja também