Skip to main content

Product

A product represents an individual item for sale in a Zoho Commerce store.

AttributesDescription
product_idlong: Unique identifier of the product.
namestring: Name of the product.
urlstring: URL of the product.
short_descriptionstring: Concise description of the product.
descriptionstring: Detailed description of the product.
category_namestring: Name of the category to which the product belongs.
category_idlong: The unique category ID of the product.
is_out_of_stockboolean: Denotes whether the product is out of stock.
tagsarray: List of tags for the product.
brandstring: Brand name for the product.
is_returnableboolean: Denotes whether the product can be returned.
on_saleboolean: Denotes whether product is on sale.
seo 
titlestring: Title for SEO
keywordstring: SEO keywords for the product.
descriptionstring: SEO description for the product.
specification_grouparray: List of specifications configured.
review_idlong: Denotes the review ID of the product.
is_product_custom_fields_enabledboolean: Denotes whether custom fields are enabled.
has_variant_priceboolean: Denotes whether product has a variant pricing.
has_variantsboolean: Denotes whether the product has variants.
handlestring: Denotes the URL of the product
is_product_review_enabledboolean: Denotes whether the product has reviews enabled.
is_social_share_enabledboolean: Denotes whether the product has social share enabled.
social_share_optionsarray: List of social share options for the product.
attributesarray: List of attributes available for the product.
namestring: Name of the attribute.
optionsarray: List of options for the attribule (ID, value).
idlong: Unique ID of the attribute.
typestring: Type of the attribute.
variantsarray: List of all the variants available for a product.
variant_idlong: Unique ID generated by the server for the variant.
selling_pricedouble: Selling price of the variant.
skustring: SKU for the variant.
eanstring: EAN for the variant.
upcstring: UPC for the variant.
isbnstring: ISBN for the variant
label_pricedouble: Retail price of the variant.
is_returnableboolean: Denotes whether the variant can be returned.
custom_fieldsarray: List of custom field values for the variant.
imagesarray: List of images for the variant.
optionsarray: List of attribute options for the variant.
custom_fieldsarray: Set of custom field values for the variant
customfield_idlong: Unique custom field ID.
display_valuestring: The value to be displayed if edit_on_store is false.
labelstring: Label of the custom field.
is_mandatoryboolean: Is the field mandatory.
edit_on_storeboolean: Denotes whether the field is editable on the store.
field_typeboolean: Type of the custom field.
valueboolean: The default value of the custom field.
values[]string: The default selected values for a multi-select custom field.
options[]string: Options for a multi-select and drop-down custom field.
imagesarray: List of all the images mapped for the product.
alternate_textstring: Alternate text for the SEO purpose of the image.
is_placeholder_imageboolean: Denotes whether the image is used as a placeholder.
idlong: Unique ID of the image.
titlestring: Name of the image.
urlstring: URL of the image.
is_featuredboolean: This denotes whether the image is featured
orderint: This denotes the chronological order of the image.
optionsarray: List of all attributes of a variant.
namestring: Name of the attribute.
idlong: Unique ID of the attribute.
valuestring: Value of the attribute.
documentsarray: List of all the images mapped for the product.
document_idlong: Unique ID generated by the server for the image.
namestring: Name of the image
attachment_order int: This denotes the chronological order of the image.
is_featuredboolean: This denotes whether the image is featured.
alter_textstring: Alter text for the SEO purpose of the image.