Home > @poq/sdk-sfcc > Product
Document representing a product.
Signature:
export declare class Product extends BaseModel<Product>
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(params) | Constructs a new instance of the Product class |
| Property | Modifiers | Type | Description |
|---|---|---|---|
| brand? | string | (Optional) The product’s brand. | |
| bundledProducts? | Array<BundledProduct> | (Optional) The array of all bundled products of this product. | |
| cAvailableForInStorePickup? | boolean | (Optional) Signals if there are inventory lists for brick-and-mortar stores associated with this product. | |
| cBatteryLife? | string | (Optional) | |
| cBatteryType? | string | (Optional) | |
| cBootType? | Array<ProductCBootTypeEnum> | (Optional) Type of Boot for search refinement. | |
| cBottomType? | Array<ProductCBottomTypeEnum> | (Optional) Bottom type for search refinement | |
| cColor? | string | (Optional) Product color used for variation attribute | |
| cConsoleWarranty? | string | (Optional) | |
| cCustomCSSFile? | string | (Optional) Use this attribute to apply custom styles for this product. | |
| cDigitalCameraFeatures? | Array<ProductCDigitalCameraFeaturesEnum> | (Optional) | |
| cDigitalCameraPixels? | string | (Optional) | |
| cDigitalCameraType? | string | (Optional) | |
| cDigitalCameraWarranty? | string | (Optional) | |
| cDimDepth? | string | (Optional) | |
| cDimHeight? | string | (Optional) | |
| cDimWeight? | string | (Optional) | |
| cDimWidth? | string | (Optional) | |
| cDisplaySize? | string | (Optional) | |
| cGameGenre? | Array<ProductCGameGenreEnum> | (Optional) | |
| cGameRating? | string | (Optional) | |
| cGameSystemType? | string | (Optional) | |
| cGpsFeatures? | Array<ProductCGpsFeaturesEnum> | (Optional) | |
| cGpsType? | Array<ProductCGpsTypeEnum> | (Optional) | |
| cGpsWarranty? | string | (Optional) | |
| cImageAspectRatio? | string | (Optional) | |
| cIsNew? | boolean | (Optional) | |
| cIsNewtest? | boolean | (Optional) This indiciates if the product is a new arrival. | |
| cIsSale? | boolean | (Optional) This is the help text. It is used for sorting rules. | |
| cKidsAge? | ProductCKidsAgeEnum | (Optional) Kids Age used for search refinements | |
| cLength? | string | (Optional) This attribute is used for mens and womens pants lengths. | |
| cLensAperture? | string | (Optional) | |
| cMaterialTest? | Array<ProductCMaterialTestEnum> | (Optional) | |
| cMediaFormat? | Array<ProductCMediaFormatEnum> | (Optional) Media Format | |
| cMemorySize? | string | (Optional) Memory Size | |
| cMemoryType? | Array<ProductCMemoryTypeEnum> | (Optional) | |
| cMusicStorage? | string | (Optional) | |
| cOpticalZoom? | string | (Optional) | |
| cOuterwearType? | ProductCOuterwearTypeEnum | (Optional) Type of Outerwear for search refinement | |
| cPortableAudioType? | Array<ProductCPortableAudioTypeEnum> | (Optional) | |
| cRefinementColor? | ProductCRefinementColorEnum | (Optional) | |
| cResolution? | string | (Optional) | |
| cSandalType? | ProductCSandalTypeEnum | (Optional) Type of Sandal for search refinement | |
| cSheets? | Array<ProductCSheetsEnum> | (Optional) test attribute | |
| cShoeType? | ProductCShoeTypeEnum | (Optional) Type of Shoe for search refinements | |
| cSize? | string | (Optional) This attribute is used for all footwear, apparel and accessory sizing for men, women and kids products. | |
| cSkinConcern? | Array<ProductCSkinConcernEnum> | (Optional) | |
| cStyleNumber? | string | (Optional) | |
| cTabDescription? | string | (Optional) | |
| cTabDetails? | string | (Optional) | |
| cTopType? | string | (Optional) Type of tops in clothing | |
| cTvSignalFormat? | string | (Optional) | |
| cTvSize? | string | (Optional) | |
| cTvType? | ProductCTvTypeEnum | (Optional) | |
| cTvWarranty? | string | (Optional) | |
| currency? | string | (Optional) The ISO 4217 mnemonic code of the currency. | |
| cVideoStorage? | string | (Optional) | |
| cWaist? | string | (Optional) Attribute used for apparel waist sizing. | |
| cWidth? | string | (Optional) This attribute is used for shoe widths for mens, womens and kids. | |
| ean? | string | (Optional) The European Article Number. | |
| fetchDate? | number | (Optional) | |
| id | string | The id (SKU) of the product. | |
| imageGroups? | Array<ImageGroup> | (Optional) The array of product image groups. | |
| inventories? | Array<Inventory> | (Optional) The array of product inventories explicitly requested via ‘inventory_ids’ query parameter. This property is only returned in context of the ‘availability’ expansion. | |
| inventory? | Inventory | (Optional) | |
| longDescription? | string | (Optional) The localized product long description. | |
| manufacturerName? | string | (Optional) The products manufacturer name. | |
| manufacturerSku? | string | (Optional) The products manufacturer sku. | |
| master? | Master | (Optional) | |
| minOrderQuantity? | number | (Optional) The minimum order quantity for this product. | |
| name? | string | (Optional) The localized product name. | |
| options? | Array<Option> | (Optional) The array of product options. This array can be empty. Only for type option. | |
| pageDescription? | string | (Optional) The localized products page description. | |
| pageKeywords? | string | (Optional) The localized products page description. | |
| pageTitle? | string | (Optional) The localized products page title. | |
| price? | number | (Optional) The sales price of the product. In case of complex products like master or set this is the minimum price of related child products. | |
| priceMax? | number | (Optional) The maximum sales of related child products in case of complex products like master or set. | |
| pricePerUnit? | number | (Optional) The sales price per unit of the product. In case of complex products like master or set this is the minimum price per unit of related child products. | |
| pricePerUnitMax? | number | (Optional) The maximum sales price per unit of related child products in case of complex products like master or set. | |
| prices? | { [key: string]: number; } | (Optional) The prices map with price book ids and their values. | |
| primaryCategoryId? | string | (Optional) The id of the products primary category. | |
| productLinks? | Array<ProductLink> | (Optional) The array of source and target products links information. | |
| productPromotions? | Array<ProductPromotion> | (Optional) The array of active customer product promotions for this product. This array can be empty. Coupon promotions are not returned in this array. | |
| recommendations? | Array<Recommendation> | (Optional) Returns a list of recommendations. | |
| setProducts? | Array<Product> | (Optional) The array of set products of this product. | |
| shortDescription? | string | (Optional) The localized product short description. | |
| stepQuantity? | number | (Optional) The steps in which the order amount of the product can be increased. | |
| type? | ProductType | (Optional) | |
| unit? | string | (Optional) The sales unit of the product. | |
| unitMeasure? | string | (Optional) The unitMeasure of the product. | |
| unitQuantity? | number | (Optional) | |
| upc? | string | (Optional) The Universal Product Code. | |
| validFrom? | string | (Optional) The time when product is valid from. | |
| validTo? | string | (Optional) The time when product is valid to. | |
| variants? | Array<Variant> | (Optional) The array of actual variants. This array can be empty. Only for types master, variation group and variant. | |
| variationAttributes? | Array<VariationAttribute> | (Optional) Sorted array of variation attributes information. This array can be empty. Only for types master, variation group and variant. | |
| variationGroups? | Array<VariationGroup> | (Optional) The array of actual variation groups. This array can be empty. Only for types master, variation group and variant. | |
| variationValues? | { [key: string]: string; } | (Optional) The actual variation attribute id - value pairs. Only for type variant and variation group. |