API legada/Referência completa/Características do produto

Campos das características

A referência completa dos campos de uma característica do produto e de suas variantes, com dois exemplos.

As características do produto permitem definir atributos específicos dos produtos, como tamanho, cor, material ou qualquer outro. Esta página lista todos os campos aceitos em um objeto de característica do produto.

Campos da característica do produto

A tabela a seguir lista todos os campos disponíveis nos objetos de característica do produto.

Campo	Descrição	Valor padrão	Valores aceitos
`company_id`*	Loja ou vendedor a que a característica pertence	ID da empresa padrão	ID de empresa válido
`description`*	Nome da característica	`''`	string
`feature_type`*	Tipo da característica	nenhum	`C`: Caixa de seleção: única `M`: Caixa de seleção: múltipla `S`: Lista suspensa: texto `N`: Lista suspensa: número `E`: Lista suspensa: marca ou fabricante `T`: Outros: texto `O`: Outros: número `D`: Outros: data `G`: Grupo de características
`purpose`	Define para que a característica será usada. Em geral é deduzido de `feature_type`	Depende de `feature_type`	`find_products`: ajuda os clientes a encontrar produtos por filtros `group_catalog_item`: variações como produtos separados `group_variation_catalog_item`: variações como um só produto `organize_catalog`: marca, autor etc. `describe_product`: informação adicional que não serve de filtro
`feature_style`	Define a aparência da característica na vitrine. Em geral é deduzido de `feature_type`	Depende de `feature_type`	`text`, `checkbox`, `multiple_checkbox`, `dropdown` (para variações), `dropdown_images` (para variações), `dropdown_labels` (para variações), `brand` (para marcas)
`filter_style`	Define a aparência de um filtro por esta característica e quais valores ela aceita. Em geral é deduzido de `feature_type`	Depende de `feature_type`	`checkbox`, `date`, `color`, `slider` (números)
`categories_path`	Categorias às quais a característica pode ser aplicada	`''`	Texto com IDs de categoria separados por vírgula
`comparison`	Define se a característica aparece na página de comparação de produtos	`N`	`Y`: sim `N`: não
`display_on_catalog`	Define se a característica aparece no catálogo de produtos	`N`	`Y`: sim `N`: não
`display_on_product`	Define se a característica aparece na página de detalhes do produto	`N`	`Y`: sim `N`: não
`display_on_header`	Define se a característica aparece abaixo do cabeçalho do produto	`N`	`Y`: sim `N`: não
`feature_id`	O ID único da característica	Definido automaticamente	integer
`full_description`	Descrição da característica	`''`	string
`group_position`	Posição no grupo	0	integer
`parent_id`	ID do grupo pai (0 se não houver grupo pai)	0	integer
`position`	A posição desta característica na lista de características	0	integer
`prefix`	O prefixo do nome da característica	`''`	string
`status`	Status	`A`	`A`: ativa `D`: desativada `H`: oculta
`suffix`	O sufixo do nome da característica	`''`	string
`value`	Valor da característica	nenhum	Valor que depende do tipo da característica
`value_int`	Valor inteiro da característica	nenhum	integer
`variant_id`	ID da variante selecionada (somente para tipos com variantes)	nenhum	integer
`variants`	Variantes de valor disponíveis da característica (somente para tipos com variantes)	nenhum	Objeto com o ID da variante como chave e os dados da variante como valor

Campos das variantes da característica

Nas características com variantes, cada variante contém os campos a seguir.

Campo	Descrição	Valor padrão	Valores aceitos
`description`	Descrição da variante	`''`	string
`feature_id`	ID da característica à qual a variante pertence	nenhum	integer
`feature_type`	Tipo da característica à qual a variante pertence	nenhum	Tipo de característica válido (veja acima)
`image_pair`	Somente para marca ou fabricante: imagens	NULL	Par de imagens válido
`lang_code`	Código do idioma	Código do idioma padrão	Código de idioma válido
`meta_description`	Somente para marca ou fabricante: meta descrição	`''`	string
`color`	Somente para `"filter_style": "color"`: o código hexadecimal da cor	`''`	string
`meta_keywords`	Somente para marca ou fabricante: palavras-chave (meta)	`''`	string
`page_title`	Somente para marca ou fabricante: título da página	`''`	string
`position`	Posição da variante	0	integer
`selected`	ID da variante selecionada	Definido automaticamente	integer
`url`	Somente para marca ou fabricante: URL	`''`	string
`variant`	Nome da variante	nenhum	string
`variant_id`	ID da variante	Definido automaticamente	integer

Exemplo de requisição de característica

json

{
  "company_id": 1,
  "description": "Size",
  "feature_type": "S",
  "purpose": "find_products",
  "feature_style": "dropdown",
  "filter_style": "checkbox",
  "categories_path": "10,15,23",
  "status": "A",
  "display_on_product": "Y",
  "display_on_catalog": "Y",
  "comparison": "Y",
  "position": 10,
  "variants": {
    "1": {
      "variant": "Small",
      "position": 10
    },
    "2": {
      "variant": "Medium",
      "position": 20
    },
    "3": {
      "variant": "Large",
      "position": 30
    }
  }
}

Exemplo de requisição de característica de cor

json

{
  "company_id": 1,
  "description": "Color",
  "feature_type": "S",
  "purpose": "find_products",
  "feature_style": "dropdown",
  "filter_style": "color",
  "categories_path": "10,15,23",
  "status": "A",
  "display_on_product": "Y",
  "display_on_catalog": "Y",
  "comparison": "Y",
  "position": 20,
  "variants": {
    "1": {
      "variant": "Red",
      "color": "#FF0000",
      "position": 10
    },
    "2": {
      "variant": "Blue",
      "color": "#0000FF",
      "position": 20
    },
    "3": {
      "variant": "Green",
      "color": "#00FF00",
      "position": 30
    }
  }
}

Veja também

Campos das características

A referência completa dos campos de uma característica do produto e de suas variantes, com dois exemplos.

Campos da característica do produto

A tabela a seguir lista todos os campos disponíveis nos objetos de característica do produto.

Campo	Descrição	Valor padrão	Valores aceitos
`company_id`*	Loja ou vendedor a que a característica pertence	ID da empresa padrão	ID de empresa válido
`description`*	Nome da característica	`''`	string
`feature_type`*	Tipo da característica	nenhum	`C`: Caixa de seleção: única `M`: Caixa de seleção: múltipla `S`: Lista suspensa: texto `N`: Lista suspensa: número `E`: Lista suspensa: marca ou fabricante `T`: Outros: texto `O`: Outros: número `D`: Outros: data `G`: Grupo de características
`purpose`	Define para que a característica será usada. Em geral é deduzido de `feature_type`	Depende de `feature_type`	`find_products`: ajuda os clientes a encontrar produtos por filtros `group_catalog_item`: variações como produtos separados `group_variation_catalog_item`: variações como um só produto `organize_catalog`: marca, autor etc. `describe_product`: informação adicional que não serve de filtro
`feature_style`	Define a aparência da característica na vitrine. Em geral é deduzido de `feature_type`	Depende de `feature_type`	`text`, `checkbox`, `multiple_checkbox`, `dropdown` (para variações), `dropdown_images` (para variações), `dropdown_labels` (para variações), `brand` (para marcas)
`filter_style`	Define a aparência de um filtro por esta característica e quais valores ela aceita. Em geral é deduzido de `feature_type`	Depende de `feature_type`	`checkbox`, `date`, `color`, `slider` (números)
`categories_path`	Categorias às quais a característica pode ser aplicada	`''`	Texto com IDs de categoria separados por vírgula
`comparison`	Define se a característica aparece na página de comparação de produtos	`N`	`Y`: sim `N`: não
`display_on_catalog`	Define se a característica aparece no catálogo de produtos	`N`	`Y`: sim `N`: não
`display_on_product`	Define se a característica aparece na página de detalhes do produto	`N`	`Y`: sim `N`: não
`display_on_header`	Define se a característica aparece abaixo do cabeçalho do produto	`N`	`Y`: sim `N`: não
`feature_id`	O ID único da característica	Definido automaticamente	integer
`full_description`	Descrição da característica	`''`	string
`group_position`	Posição no grupo	0	integer
`parent_id`	ID do grupo pai (0 se não houver grupo pai)	0	integer
`position`	A posição desta característica na lista de características	0	integer
`prefix`	O prefixo do nome da característica	`''`	string
`status`	Status	`A`	`A`: ativa `D`: desativada `H`: oculta
`suffix`	O sufixo do nome da característica	`''`	string
`value`	Valor da característica	nenhum	Valor que depende do tipo da característica
`value_int`	Valor inteiro da característica	nenhum	integer
`variant_id`	ID da variante selecionada (somente para tipos com variantes)	nenhum	integer
`variants`	Variantes de valor disponíveis da característica (somente para tipos com variantes)	nenhum	Objeto com o ID da variante como chave e os dados da variante como valor

Campos das variantes da característica

Nas características com variantes, cada variante contém os campos a seguir.

Campo	Descrição	Valor padrão	Valores aceitos
`description`	Descrição da variante	`''`	string
`feature_id`	ID da característica à qual a variante pertence	nenhum	integer
`feature_type`	Tipo da característica à qual a variante pertence	nenhum	Tipo de característica válido (veja acima)
`image_pair`	Somente para marca ou fabricante: imagens	NULL	Par de imagens válido
`lang_code`	Código do idioma	Código do idioma padrão	Código de idioma válido
`meta_description`	Somente para marca ou fabricante: meta descrição	`''`	string
`color`	Somente para `"filter_style": "color"`: o código hexadecimal da cor	`''`	string
`meta_keywords`	Somente para marca ou fabricante: palavras-chave (meta)	`''`	string
`page_title`	Somente para marca ou fabricante: título da página	`''`	string
`position`	Posição da variante	0	integer
`selected`	ID da variante selecionada	Definido automaticamente	integer
`url`	Somente para marca ou fabricante: URL	`''`	string
`variant`	Nome da variante	nenhum	string
`variant_id`	ID da variante	Definido automaticamente	integer

Exemplo de requisição de característica

json

{
  "company_id": 1,
  "description": "Size",
  "feature_type": "S",
  "purpose": "find_products",
  "feature_style": "dropdown",
  "filter_style": "checkbox",
  "categories_path": "10,15,23",
  "status": "A",
  "display_on_product": "Y",
  "display_on_catalog": "Y",
  "comparison": "Y",
  "position": 10,
  "variants": {
    "1": {
      "variant": "Small",
      "position": 10
    },
    "2": {
      "variant": "Medium",
      "position": 20
    },
    "3": {
      "variant": "Large",
      "position": 30
    }
  }
}

Exemplo de requisição de característica de cor

json

{
  "company_id": 1,
  "description": "Color",
  "feature_type": "S",
  "purpose": "find_products",
  "feature_style": "dropdown",
  "filter_style": "color",
  "categories_path": "10,15,23",
  "status": "A",
  "display_on_product": "Y",
  "display_on_catalog": "Y",
  "comparison": "Y",
  "position": 20,
  "variants": {
    "1": {
      "variant": "Red",
      "color": "#FF0000",
      "position": 10
    },
    "2": {
      "variant": "Blue",
      "color": "#0000FF",
      "position": 20
    },
    "3": {
      "variant": "Green",
      "color": "#00FF00",
      "position": 30
    }
  }
}