Class: module:models/Product

module:models/Product(id)

new module:models/Product(id)

Constructs a new Product. Document representing a product.

Parameters:
Name Type Description
id String

The id (SKU) of the product.
Source:

Members

(readonly) CBootTypeEnum :String

Allowed values for the cBootType property.

Type:
  • String
Source:

(readonly) CBottomTypeEnum :String

Allowed values for the cBottomType property.

Type:
  • String
Source:

(readonly) CDigitalCameraFeaturesEnum :String

Allowed values for the cDigitalCameraFeatures property.

Type:
  • String
Source:

(readonly) CGameGenreEnum :String

Allowed values for the cGameGenre property.

Type:
  • String
Source:

(readonly) CGpsFeaturesEnum :String

Allowed values for the cGpsFeatures property.

Type:
  • String
Source:

(readonly) CGpsTypeEnum :String

Allowed values for the cGpsType property.

Type:
  • String
Source:

(readonly) CKidsAgeEnum :String

Allowed values for the c_kidsAge property.

Type:
  • String
Source:

(readonly) CMaterialTestEnum :String

Allowed values for the cMaterialTest property.

Type:
  • String
Source:

(readonly) CMediaFormatEnum :String

Allowed values for the cMediaFormat property.

Type:
  • String
Source:

(readonly) CMemoryTypeEnum :String

Allowed values for the cMemoryType property.

Type:
  • String
Source:

(readonly) COuterwearTypeEnum :String

Allowed values for the c_outerwearType property.

Type:
  • String
Source:

(readonly) CPortableAudioTypeEnum :String

Allowed values for the cPortableAudioType property.

Type:
  • String
Source:

(readonly) CRefinementColorEnum :String

Allowed values for the c_refinementColor property.

Type:
  • String
Source:

(readonly) CSandalTypeEnum :String

Allowed values for the c_sandalType property.

Type:
  • String
Source:

(readonly) CSheetsEnum :String

Allowed values for the cSheets property.

Type:
  • String
Source:

(readonly) CShoeTypeEnum :String

Allowed values for the c_shoeType property.

Type:
  • String
Source:

(readonly) CSkinConcernEnum :String

Allowed values for the cSkinConcern property.

Type:
  • String
Source:

(readonly) CTvTypeEnum :String

Allowed values for the c_tvType property.

Type:
  • String
Source:

(inner, constant) 0010

value: "0010"

Source:

(inner, constant) 0010

value: "0010"

Source:

(inner, constant) 0010

value: "0010"

Source:

(inner, constant) 0010

value: "0010"

Source:

(inner, constant) 0010

value: "0010"

Source:

(inner, constant) 0010

value: "0010"

Source:

(inner, constant) 0010

value: "0010"

Source:

(inner, constant) 0010

value: "0010"

Source:

(inner, constant) 0010

value: "0010"

Source:

(inner, constant) 0010

value: "0010"

Source:

(inner, constant) 0010

value: "0010"

Source:

(inner, constant) 0010

value: "0010"

Source:

(inner, constant) 0010

value: "0010"

Source:

(inner, constant) 0020

value: "0020"

Source:

(inner, constant) 0020

value: "0020"

Source:

(inner, constant) 0020

value: "0020"

Source:

(inner, constant) 0020

value: "0020"

Source:

(inner, constant) 0020

value: "0020"

Source:

(inner, constant) 0020

value: "0020"

Source:

(inner, constant) 0020

value: "0020"

Source:

(inner, constant) 0020

value: "0020"

Source:

(inner, constant) 0020

value: "0020"

Source:

(inner, constant) 0020

value: "0020"

Source:

(inner, constant) 0020

value: "0020"

Source:

(inner, constant) 0020

value: "0020"

Source:

(inner, constant) 0020

value: "0020"

Source:

(inner, constant) 0030

value: "0030"

Source:

(inner, constant) 0030

value: "0030"

Source:

(inner, constant) 0030

value: "0030"

Source:

(inner, constant) 0030

value: "0030"

Source:

(inner, constant) 0030

value: "0030"

Source:

(inner, constant) 0030

value: "0030"

Source:

(inner, constant) 0030

value: "0030"

Source:

(inner, constant) 0030

value: "0030"

Source:

(inner, constant) 0030

value: "0030"

Source:

(inner, constant) 0030

value: "0030"

Source:

(inner, constant) 0030

value: "0030"

Source:

(inner, constant) 0030

value: "0030"

Source:

(inner, constant) 0030

value: "0030"

Source:

(inner, constant) 0040

value: "0040"

Source:

(inner, constant) 0040

value: "0040"

Source:

(inner, constant) 0040

value: "0040"

Source:

(inner, constant) 0040

value: "0040"

Source:

(inner, constant) 0040

value: "0040"

Source:

(inner, constant) 0040

value: "0040"

Source:

(inner, constant) 0040

value: "0040"

Source:

(inner, constant) 0040

value: "0040"

Source:

(inner, constant) 0040

value: "0040"

Source:

(inner, constant) 0040

value: "0040"

Source:

(inner, constant) 0040

value: "0040"

Source:

(inner, constant) 0050

value: "0050"

Source:

(inner, constant) 0050

value: "0050"

Source:

(inner, constant) 0050

value: "0050"

Source:

(inner, constant) 0050

value: "0050"

Source:

(inner, constant) 0050

value: "0050"

Source:

(inner, constant) 0050

value: "0050"

Source:

(inner, constant) 0050

value: "0050"

Source:

(inner, constant) 0050

value: "0050"

Source:

(inner, constant) 0050

value: "0050"

Source:

(inner, constant) 0060

value: "0060"

Source:

(inner, constant) 0060

value: "0060"

Source:

(inner, constant) 0060

value: "0060"

Source:

(inner, constant) 0060

value: "0060"

Source:

(inner, constant) 0060

value: "0060"

Source:

(inner, constant) 0060

value: "0060"

Source:

(inner, constant) 0060

value: "0060"

Source:

(inner, constant) 0060

value: "0060"

Source:

(inner, constant) 0060

value: "0060"

Source:

(inner, constant) 0070

value: "0070"

Source:

(inner, constant) 0070

value: "0070"

Source:

(inner, constant) 0070

value: "0070"

Source:

(inner, constant) 0070

value: "0070"

Source:

(inner, constant) 0070

value: "0070"

Source:

(inner, constant) 0070

value: "0070"

Source:

(inner, constant) 0070

value: "0070"

Source:

(inner, constant) 0070

value: "0070"

Source:

(inner, constant) 0070

value: "0070"

Source:

(inner, constant) 0080

value: "0080"

Source:

(inner, constant) 0080

value: "0080"

Source:

(inner, constant) 0080

value: "0080"

Source:

(inner, constant) 0080

value: "0080"

Source:

(inner, constant) 0080

value: "0080"

Source:

(inner, constant) 0080

value: "0080"

Source:

(inner, constant) 0080

value: "0080"

Source:

(inner, constant) 0090

value: "0090"

Source:

(inner, constant) 0090

value: "0090"

Source:

(inner, constant) 0090

value: "0090"

Source:

(inner, constant) 0090

value: "0090"

Source:

(inner, constant) 0090

value: "0090"

Source:

(inner, constant) 0100

value: "0100"

Source:

(inner, constant) 0100

value: "0100"

Source:

(inner, constant) 0100

value: "0100"

Source:

(inner, constant) 0100

value: "0100"

Source:

(inner, constant) 0110

value: "0110"

Source:

(inner, constant) 0110

value: "0110"

Source:

(inner, constant) 0110

value: "0110"

Source:

(inner, constant) 0120

value: "0120"

Source:

(inner, constant) 0120

value: "0120"

Source:

(inner, constant) 0130

value: "0130"

Source:

(inner, constant) 0130

value: "0130"

Source:

(inner, constant) 0140

value: "0140"

Source:

(inner, constant) 0140

value: "0140"

Source:

(inner, constant) 0150

value: "0150"

Source:

(inner, constant) 0150

value: "0150"

Source:

(inner, constant) 0160

value: "0160"

Source:

(inner, constant) 0160

value: "0160"

Source:

(inner, constant) 0170

value: "0170"

Source:

(inner, constant) 0170

value: "0170"

Source:

(inner, constant) 0180

value: "0180"

Source:

(inner, constant) 0180

value: "0180"

Source:

(inner, constant) 0190

value: "0190"

Source:

(inner, constant) 0190

value: "0190"

Source:

(inner, constant) 0200

value: "0200"

Source:

(inner, constant) 0200

value: "0200"

Source:

(inner, constant) 0210

value: "0210"

Source:

(inner, constant) 0210

value: "0210"

Source:

(inner, constant) 0220

value: "0220"

Source:

(inner, constant) 0230

value: "0230"

Source:

(inner, constant) 0230

value: "0230"

Source:

(inner, constant) 0240

value: "0240"

Source:

(inner, constant) 0250

value: "0250"

Source:

(inner, constant) 0260

value: "0260"

Source:

(inner, constant) 0270

value: "0270"

Source:

(inner, constant) 0280

value: "0280"

Source:

(inner, constant) "Role-Playing"

value: "Role-Playing"

Source:

(inner, constant) Action

value: "Action"

Source:

(inner, constant) beige

value: "beige"

Source:

(inner, constant) black

value: "black"

Source:

(inner, constant) blue

value: "blue"

Source:

(inner) brand :String

The product's brand.

Type:
  • String
Source:

(inner, constant) brown

value: "brown"

Source:

(inner) bundled_products :Array.<module:models/BundledProduct>

The array of all bundled products of this product.

Type:
Source:

(inner) c_availableForInStorePickup :Boolean

Signals if there are inventory lists for brick-and-mortar stores associated with this product.

Type:
  • Boolean
Source:

(inner) c_batteryLife :String

Type:
  • String
Source:

(inner) c_batteryType :String

Type:
  • String
Source:

(inner) c_bootType :Array.<module:models/Product.CBootTypeEnum>

Type of Boot for search refinement.

Type:
  • Array.<module:models/Product.CBootTypeEnum>
Source:

(inner) c_bottomType :Array.<module:models/Product.CBottomTypeEnum>

Bottom type for search refinement

Type:
  • Array.<module:models/Product.CBottomTypeEnum>
Source:

(inner) c_color :String

Product color used for variation attribute

Type:
  • String
Source:

(inner) c_consoleWarranty :String

Type:
  • String
Source:

(inner) c_customCSSFile :String

Use this attribute to apply custom styles for this product.

Type:
  • String
Source:

(inner) c_digitalCameraFeatures :Array.<module:models/Product.CDigitalCameraFeaturesEnum>

Type:
  • Array.<module:models/Product.CDigitalCameraFeaturesEnum>
Source:

(inner) c_digitalCameraPixels :String

Type:
  • String
Source:

(inner) c_digitalCameraType :String

Type:
  • String
Source:

(inner) c_digitalCameraWarranty :String

Type:
  • String
Source:

(inner) c_dimDepth :String

Type:
  • String
Source:

(inner) c_dimHeight :String

Type:
  • String
Source:

(inner) c_dimWeight :String

Type:
  • String
Source:

(inner) c_dimWidth :String

Type:
  • String
Source:

(inner) c_displaySize :String

Type:
  • String
Source:

(inner) c_gameGenre :Array.<module:models/Product.CGameGenreEnum>

Type:
  • Array.<module:models/Product.CGameGenreEnum>
Source:

(inner) c_gameRating :String

Type:
  • String
Source:

(inner) c_gameSystemType :String

Type:
  • String
Source:

(inner) c_gpsFeatures :Array.<module:models/Product.CGpsFeaturesEnum>

Type:
  • Array.<module:models/Product.CGpsFeaturesEnum>
Source:

(inner) c_gpsType :Array.<module:models/Product.CGpsTypeEnum>

Type:
  • Array.<module:models/Product.CGpsTypeEnum>
Source:

(inner) c_gpsWarranty :String

Type:
  • String
Source:

(inner) c_imageAspectRatio :String

Type:
  • String
Source:

(inner) c_isNew :Boolean

Type:
  • Boolean
Source:

(inner) c_isNewtest :Boolean

This indiciates if the product is a new arrival.

Type:
  • Boolean
Source:

(inner) c_isSale :Boolean

This is the help text. It is used for sorting rules.

Type:
  • Boolean
Source:

(inner) c_kidsAge :module:models/Product.CKidsAgeEnum

Kids Age used for search refinements

Type:
  • module:models/Product.CKidsAgeEnum
Source:

(inner) c_length :String

This attribute is used for mens and womens pants lengths.

Type:
  • String
Source:

(inner) c_lensAperture :String

Type:
  • String
Source:

(inner) c_materialTest :Array.<module:models/Product.CMaterialTestEnum>

Type:
  • Array.<module:models/Product.CMaterialTestEnum>
Source:

(inner) c_mediaFormat :Array.<module:models/Product.CMediaFormatEnum>

Media Format

Type:
  • Array.<module:models/Product.CMediaFormatEnum>
Source:

(inner) c_memorySize :String

Memory Size

Type:
  • String
Source:

(inner) c_memoryType :Array.<module:models/Product.CMemoryTypeEnum>

Type:
  • Array.<module:models/Product.CMemoryTypeEnum>
Source:

(inner) c_musicStorage :String

Type:
  • String
Source:

(inner) c_opticalZoom :String

Type:
  • String
Source:

(inner) c_outerwearType :module:models/Product.COuterwearTypeEnum

Type of Outerwear for search refinement

Type:
  • module:models/Product.COuterwearTypeEnum
Source:

(inner) c_portableAudioType :Array.<module:models/Product.CPortableAudioTypeEnum>

Type:
  • Array.<module:models/Product.CPortableAudioTypeEnum>
Source:

(inner) c_refinementColor :module:models/Product.CRefinementColorEnum

Type:
  • module:models/Product.CRefinementColorEnum
Source:

(inner) c_resolution :String

Type:
  • String
Source:

(inner) c_sandalType :module:models/Product.CSandalTypeEnum

Type of Sandal for search refinement

Type:
  • module:models/Product.CSandalTypeEnum
Source:

(inner) c_sheets :Array.<module:models/Product.CSheetsEnum>

test attribute

Type:
  • Array.<module:models/Product.CSheetsEnum>
Source:

(inner) c_shoeType :module:models/Product.CShoeTypeEnum

Type of Shoe for search refinements

Type:
  • module:models/Product.CShoeTypeEnum
Source:

(inner) c_size :String

This attribute is used for all footwear, apparel and accessory sizing for men, women and kids products.

Type:
  • String
Source:

(inner) c_skinConcern :Array.<module:models/Product.CSkinConcernEnum>

Type:
  • Array.<module:models/Product.CSkinConcernEnum>
Source:

(inner) c_styleNumber :String

Type:
  • String
Source:

(inner) c_tabDescription :String

Type:
  • String
Source:

(inner) c_tabDetails :String

Type:
  • String
Source:

(inner) c_test :String

Type:
  • String
Source:

(inner) c_topType :String

Type of tops in clothing

Type:
  • String
Source:

(inner) c_tvSignalFormat :String

Type:
  • String
Source:

(inner) c_tvSize :String

Type:
  • String
Source:

(inner) c_tvType :module:models/Product.CTvTypeEnum

Type:
  • module:models/Product.CTvTypeEnum
Source:

(inner) c_tvWarranty :String

Type:
  • String
Source:

(inner) c_videoStorage :String

Type:
  • String
Source:

(inner) c_waist :String

Attribute used for apparel waist sizing.

Type:
  • String
Source:

(inner) c_width :String

This attribute is used for shoe widths for mens, womens and kids.

Type:
  • String
Source:

(inner, constant) comprehensive

value: "comprehensive"

Source:

(inner, constant) cotton

value: "cotton"

Source:

(inner) currency :String

The ISO 4217 mnemonic code of the currency.

Type:
  • String
Source:

(inner, constant) dryTight

value: "dryTight"

Source:

(inner) ean :String

The European Article Number.

Type:
  • String
Source:

(inner, constant) Educational

value: "Educational"

Source:

(inner) fetch_date :Number

Type:
  • Number
Source:

(inner, constant) green

value: "green"

Source:

(inner, constant) grey

value: "grey"

Source:

(inner) id :String

The id (SKU) of the product.

Type:
  • String
Source:

(inner) image_groups :Array.<module:models/ImageGroup>

The array of product image groups.

Type:
Source:

(inner) inventories :Array.<module:models/Inventory>

The array of product inventories explicitly requested via 'inventory_ids' query parameter. This property is only returned in context of the 'availability' expansion.

Type:
Source:

(inner) inventory :module:models/Inventory

The site default inventory information. This property is only returned in context of the 'availability' expansion.

Type:
Source:

(inner, constant) Kids

value: "Kids"

Source:

(inner, constant) liftingLossFirm

value: "liftingLossFirm"

Source:

(inner) long_description :String

The localized product long description.

Type:
  • String
Source:

(inner) manufacturer_name :String

The products manufacturer name.

Type:
  • String
Source:

(inner) manufacturer_sku :String

The products manufacturer sku.

Type:
  • String
Source:

(inner) master :module:models/Master

The master product information. Only for types master, variation group and variant.

Type:
Source:

(inner) min_order_quantity :Number

The minimum order quantity for this product.

Type:
  • Number
Source:

(inner, constant) miscellaneous

value: "miscellaneous"

Source:

(inner) name :String

The localized product name.

Type:
  • String
Source:

(inner, constant) navy

value: "navy"

Source:

(inner) options :Array.<module:models/Option>

The array of product options. This array can be empty. Only for type option.

Type:
Source:

(inner, constant) orange

value: "orange"

Source:

(inner) page_description :String

The localized products page description.

Type:
  • String
Source:

(inner) page_keywords :String

The localized products page description.

Type:
  • String
Source:

(inner) page_title :String

The localized products page title.

Type:
  • String
Source:

(inner, constant) pink

value: "pink"

Source:

(inner, constant) polyester

value: "polyester"

Source:

(inner) price :Number

The sales price of the product. In case of complex products like master or set this is the minimum price of related child products.

Type:
  • Number
Source:

(inner) price_max :Number

The maximum sales of related child products in case of complex products like master or set.

Type:
  • Number
Source:

(inner) prices :Object.<String, Number>

The prices map with price book ids and their values.

Type:
  • Object.<String, Number>
Source:

(inner) primary_category_id :String

The id of the products primary category.

Type:
  • String
Source:

The array of source and target products links information.

Type:
Source:

(inner) product_promotions :Array.<module:models/ProductPromotion>

The array of active customer product promotions for this product. This array can be empty. Coupon promotions are not returned in this array.

Type:
Source:

(inner, constant) purple

value: "purple"

Source:

(inner, constant) Racing

value: "Racing"

Source:

(inner) recommendations :Array.<module:models/Recommendation>

Returns a list of recommendations.

Type:
Source:

(inner, constant) red

value: "red"

Source:

(inner) set_products :Array.<module:models/Product>

The array of set products of this product.

Type:
Source:

(inner) short_description :String

The localized product short description.

Type:
  • String
Source:

(inner, constant) Sports

value: "Sports"

Source:

(inner) step_quantity :Number

The steps in which the order amount of the product can be increased.

Type:
  • Number
Source:

(inner, constant) Strategy

value: "Strategy"

Source:

(inner) type :module:models/ProductType

The product type information. Can be one or multiple of the following values: item,master,variation_group,variant,bundle,set.

Type:
Source:

(inner) unit :String

The sales unit of the product.

Type:
  • String
Source:

(inner) upc :String

The Universal Product Code.

Type:
  • String
Source:

(inner) valid_from :Date

The time when product is valid from.

Type:
  • Date
Source:

(inner) valid_to :Date

The time when product is valid to.

Type:
  • Date
Source:

(inner, constant) value1

value: "value1"

Source:

(inner, constant) value2

value: "value2"

Source:

(inner, constant) value3

value: "value3"

Source:

(inner) variants :Array.<module:models/Variant>

The array of actual variants. This array can be empty. Only for types master, variation group and variant.

Type:
Source:

(inner) variation_attributes :Array.<module:models/VariationAttribute>

Sorted array of variation attributes information. This array can be empty. Only for types master, variation group and variant.

Type:
Source:

(inner) variation_groups :Array.<module:models/VariationGroup>

The array of actual variation groups. This array can be empty. Only for types master, variation group and variant.

Type:
Source:

(inner) variation_values :Object.<String, String>

The actual variation attribute id - value pairs. Only for type variant and variation group.

Type:
  • Object.<String, String>
Source:

(inner, constant) white

value: "white"

Source:

(inner, constant) wool

value: "wool"

Source:

(inner, constant) yellow

value: "yellow"

Source:

Methods

(static) constructFromObject(data, obj) → {module:models/Product}

Constructs a Product from a plain JavaScript object, optionally creating a new instance. Copies all relevant properties from data to obj if supplied or a new instance if not.

Parameters:
Name Type Description
data Object

The plain JavaScript object bearing properties of interest.
obj module:models/Product

Optional instance to populate.
Source:
Returns:

The populated Product instance.

Type
module:models/Product