Product Fields

Product Fields Overview

A product in the Venddor API has various properties represented by fields. This document provides a comprehensive list of all supported fields, along with their descriptions, default values, and supported data types.

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.

The following table lists all available fields for product objects:

Field Name	Description	Default Value	Supported Values
product*	Product name	—	string
category_ids*	IDs of the categories to which the product belongs	—	Array of valid category IDs
main_category*	ID of the main category	—	Existing category ID
price*	Price	0	float
company_id*	ID of the store or vendor the product belongs to	Default company ID	integer
status*	Product status: `A` for Active `D` for Disabled `H` for Hidden	`A`	`A` `D` `H`
amount	Product amount in stock	1	integer
avail_since	Date from which the product is available	—	Date in UNIX format
box_height	Box height	0	integer
box_length	Box length	0	integer
box_width	Box width	0	integer
details_layout	Product details page layout	'default'	Valid product template name
edp_shipping	Only for downloadable products: Enable/disable shipping	`N`	`Y` `N`
exceptions_type	Exception type (`A`llow/`F`orbid products with certain option combinations)	`F`	`A` `F`
feature_comparison	Enable/disable adding the product to a feature comparison list	`N`	`Y` `N`
free_shipping	Allow free shipping	`N`	`Y` `N`
full_description	Full product description	''	string
image_pairs	Additional image pairs	empty array	object with image pair ID as key and image pair as value
is_edp	Downloadable or not	`N`	`Y` `N`
lang_code	Language code	Default language code	`en` `ru` etc.
list_price	Manufacturer suggested price	0	float
list_qty_count	Number of items in the quantity select box	0	integer
localization	String of comma-separated localization IDs	''	string
low_avail_limit	Minimal availability in stock value	0	integer
main_pair	Full image and thumbnail pair	empty array	Main pair object
max_items_in_box	Maximal number of items per box	0	integer
max_qty	Maximal order quantity	0	integer
meta_description	Meta description	''	string
meta_keywords	Meta keywords	''	string
min_items_in_box	Minimal number of items per box	0	integer
min_qty	Minimal order quantity	0	integer
options_type	Apply options simultaneously (`P`) or sequentially (`S`)	`P`	`S` `P`
out_of_stock_actions	Out of stock action: `N` for None `B` for Buy in advance `S` for Sign up for notification	`N`	`N` `B` `S`
page_title	Product page title	''	string
point_price	Price in reward points	0	float
popularity	Product popularity rating based on views, adding to cart, and purchases	3	integer
product_code	Product code	''	string
product_features	Product features	empty array	object that contains product features with feature ID as key and feature data as value
product_id	Product ID	Set automatically	integer
promo_text	Promo text	''	string
qty_step	Quantity step	0	integer
return_period	Return period in days	10	integer
sales_amount	Sales amount	0	integer
search_words	Search keywords for the product	''	string
seo_name	SEO name for the product page	''	string
shared_product	Shared or not	`N`	`Y` `N`
shipping_freight	Shipping freight	0	float
shipping_params	Aggregated shipping data	Auto-generated string based on the shipping data	string
short_description	Short description	''	string
tax_ids	Array of tax IDs	empty array	array
timestamp	Creation timestamp	Set automatically	Valid timestamp in UNIX format
tracking	Inventory tracking mode: `O` for Track with options `B` for Track without options `D` for Do not track	`B`	`O` `B` `D`
unlimited_download	For EDP products: allow or not unlimited downloads	`N`	`Y` `N`
updated_timestamp	Last update timestamp	Last update timestamp in seconds	Valid timestamp in UNIX format
usergroup_ids	User group IDs	'0'	String of comma-separated user group IDs
weight	Weight	0	float
zero_price_action	Zero price action: `R` for Do not allow customers to add product to cart `P` for Allow customers to add product to cart `A` for Ask customer to enter the price	`R`	`R` `P` `A`

Main Pair Fields

The main_pair object contains the following fields:

Field Name	Description	Default Value	Supported Values
detailed_id	ID of the full image	Set automatically	integer
image_id	ID of the thumbnail	0	integer
pair_id	ID of the image pair	Set automatically	integer
position	Position of the image pair among others	0	integer
icon	Thumbnail data	—	object (similar to detailed)
detailed	Full image data	—	object
absolute_path	Absolute filesystem path to the image	—	Valid filesystem path
alt	Alternative text (shown if the image fails to load)	''	string
http_image_path	HTTP path to the image	—	Valid HTTP URL pointing to the image
image_path	Actual image path (HTTP or HTTPS; may be the same as http_image_path)	—	Valid URL pointing to the image
image_x	Image width in pixels	—	integer
image_y	Image height	—	integer

Example Product Request

{
  "product": "Premium Bluetooth Headphones",
  "category_ids": [12, 45],
  "main_category": 12,
  "price": 99.99,
  "status": "A",
  "company_id": 5,
  "product_code": "BT-HEAD-001",
  "short_description": "Noise-cancelling premium headphones with 24-hour battery life",
  "full_description": "Experience premium sound quality with our noise-cancelling Bluetooth headphones. Featuring 24-hour battery life, comfortable ear cushions, and crystal-clear sound.",
  "amount": 50,
  "weight": 0.35,
  "free_shipping": "Y",
  "is_edp": "N",
  "tracking": "B",
  "popularity": 9
}

Tip: When creating or updating products, focus on providing all mandatory fields first. Additional fields can be added as needed to enhance product information.

Product Fields Reference

Product Fields Overview

Product Fields

Main Pair Fields

Example Product Request