Product Features Fields

Product Features Fields Overview

Product features in the Venddor API allow you to define specific characteristics of your products, such as size, color, material, or any other attribute. This document provides a comprehensive list of all supported fields for product features.

Important: Mandatory fields are marked with a * symbol. Any field not listed in the tables below will be ignored if included in an API request.

Product Feature Fields

The following table lists all available fields for product feature objects:

Field Name	Description	Default Value	Supported Values
company_id*	Store or vendor to which the feature belongs	Default company ID	Valid company ID
description*	Feature name	''	string
feature_type*	Feature type	—	`C`—Check box: Single `M`—Check box: Multiple `S`—Select box: Text `N`—Select box: Number `E`—Select box: Brand/Manufacturer `T`—Others: Text `O`—Others: Number `D`—Others: Date `G`—Group of features
purpose	Determines what the feature will be used for. Usually inferred from feature_type	Depends on feature_type	`find_products`—help customers find products via filters `group_catalog_item`—variations as separate products `group_variation_catalog_item`—variations as one product `organize_catalog`—brand, author, etc. `describe_product`—additional non-filterable information
feature_style	Determines the appearance of this feature on the storefront. Usually inferred from feature_type	Depends on feature_type	`text` `checkbox` `multiple_checkbox` `dropdown` (for variations) `dropdown_images` (for variations) `dropdown_labels` (for variations) `brand` (for brands)
filter_style	Determines the appearance of a filter by this feature, and what values this feature accepts. Usually inferred from feature_type	Depends on feature_type	`checkbox` `date` `color` `slider` (numbers)
categories_path	Categories to which the feature can be applied	''	Comma-separated string of category IDs
comparison	Determines whether to show this feature on a product comparison page or not	`N`	`Y`—yes `N`—no
display_on_catalog	Determines whether to show this feature in the product catalog or not	`N`	`Y`—yes `N`—no
display_on_product	Determines whether to show this feature on a detailed product page or not	`N`	`Y`—yes `N`—no
display_on_header	Determines whether to show this feature under the product header or not	`N`	`Y`—yes `N`—no
feature_id	The unique ID of the feature	Set automatically	integer
full_description	Feature description	''	string
group_position	Position in group	0	integer
parent_id	ID of the parent group (0 if there is no parent group)	0	integer
position	The position of this feature in the feature list	0	integer
prefix	The prefix of the feature name	''	string
status	Status	`A`	`A`—active `D`—disabled `H`—hidden
suffix	The suffix of the feature name	''	string
value	Feature value	—	Value depending on the feature type
value_int	Feature integer value	—	integer
variant_id (only for types with variants)	ID of the selected variant	—	integer
variants (only for types with variants)	Available feature value variants	—	object with variant ID as key and variant data as value

Product Feature Variants Fields

For features with variants, each variant contains the following fields:

Field Name	Description	Default Value	Supported Values
description	Variant description	''	string
feature_id	ID of the feature the variant is assigned to	—	integer
feature_type	Type of the feature the variant is assigned to	—	Valid feature type (see above)
image_pair	For Brand/Manufacturer only: Images	NULL	Valid image pair
lang_code	Language code	Default language code	Valid language code
meta_description	For Brand/Manufacturer only: Meta description	''	string
color	For "filter_style": "color" only: the color hex code	''	string
meta_keywords	For Brand/Manufacturer only: Meta keywords	''	string
page_title	For Brand/Manufacturer only: Page title	''	string
position	Variant position	0	integer
selected	ID of the selected variant	Set automatically	integer
url	For Brand/Manufacturer only: URL	''	string
variant	Variant name	—	string
variant_id	Variant ID	Set automatically	integer

Example Product Feature Request

{
  "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
    }
  }
}

Tip: When creating product features, consider the purpose of the feature and choose the appropriate feature_type. For example, use Select box (S) for features with predefined values like sizes or colors, and use Text (T) for unique product descriptions.

Example Color Feature Request

{
  "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
    }
  }
}

Important: For features with the filter_style set to "color", make sure to provide valid hex color codes for each variant to properly display color swatches in the storefront.

Product Features Fields Reference