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 |
|
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 a downloadable product: Enable/disable shipping |
N |
|
exceptions_type |
Exception type (A llow/ F orbid products with certain option combinations) |
F |
|
feature_comparison |
Enable/disable adding the product to a feature comparison list |
N |
|
free_shipping |
Allow free shipping |
N |
|
full_description |
Full product description |
‘’ |
string |
image_pairs |
Additional image pairs |
empty array |
array with image pair ID as key and image pair as value (see below) |
is_edp |
Downloadable or not |
N |
|
lang_code |
Language code |
Default language code |
|
list_price |
Manufactorer 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 array (see below) |
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 ) of sequentially (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 |
|
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 |
array of 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 |
|
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 |
|
unlimited_download |
For EDP products: allow or not unlimited downloads |
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 |
|