Dynamicweb 8 Documentation
Product Class Members
Fields  Properties  Methods 


Dynamicweb.eCommerce.Products Namespace : Product Class

The following tables list the members exposed by Product.

Public Constructors
 NameDescription
Public ConstructorProduct ConstructorOverloaded.   
Top
Public Fields
 NameDescription
Public Fieldstatic (Shared in Visual Basic)FormatOperatorPlus or Minus.  
Top
Public Properties
 NameDescription
Public PropertyActiveGets or sets the value that indicates if the product is active or not.  
Public PropertyCostGets or sets the default cost.  
Public PropertyCreatedGets or sets the date when the product was created.  
Public PropertyDefaultPriceGets or sets the default price. This price is a basis for calculating the final price that is displayed in the frontend.  
Public PropertyDefaultShopIDGets or sets the default shop ID.  
Public PropertyDefaultUnitGets the default unit.  
Public PropertyDefaultUnitIDGets or sets the default ID of the unit.  
Public PropertyDefaultVariantComboIDGets or sets the default VariantComboID.  
Public PropertyDetailsOverloaded. Gets the detail collection.  
Public PropertyDiscountsGets the product discounts collection.  
Public PropertyFormattedMarkupGets the markup as a formatted string, like: "10.25%".  
Public PropertyFormattedPriceGets the price string in currency format.  
Public PropertyGroupsGets or sets the collection of groups that own the product.  
Public PropertyIDGets or sets the ID of the product.  
Public PropertyIDUrlEncodedGets the ID URL encoded.  
Public PropertyImageLargeGets or sets a large image.  
Public PropertyImageMediumGets or sets a medium image.  
Public PropertyImageSmallGets or sets a small image.  
Public PropertyIndexingOptionsGets or sets the indexing options.  
Public PropertyIsActiveGets the value that indicates if the product is active or not and if the period of the product is active or not.  
Public PropertyIsActiveImgGets the image that indicates whether the product is active or not.  
Public PropertyIsVariantMasterGets the value that indicates if the variant is a master.  
Public PropertyItemsGets or sets the collection of product items for composite products.  
Public PropertyLanguageGets the product language. To change the language of this Product use the LanguageID property.  
Public PropertyLanguageIDGets or sets the product language ID.  
Public PropertyLink1Gets or sets the Link1.  
Public PropertyLink2Gets or sets the Link2.  
Public PropertyLongDescriptionGets or sets the detailed description of the product.  
Public PropertyManufacturerGets the product manufacturer. To set the Manufacturer use the ManufacturerID property.  
Public PropertyManufacturerIDGets or sets the ID of the product manufacturer.  
Public PropertyMarkupGets the markup. This value is calculated from DefaultPrice and Cost and is represented as a percentage.  
Public PropertyMetaGets or sets meta data. Meta information is used by search engines to index searches by means of keywords.  
Public PropertyNameGets or sets product name. Product name is used in the frontend product catalog.  
Public PropertyNumberGets or sets the product number.  
Public PropertyNumberAndActiveStatusGets the product image with its status e.g. active or not, and the product number.  
Public PropertyOptimizedForGets or sets the keyword or phrase for which this product's meta data is optimized for.  
Public PropertyOrderLineFieldsGets the order line fields.  
Public PropertyPeriodGets or sets the period.  
Public PropertyPeriodIDGets or sets the ID of the period.  
Public PropertyPeriodsGets or sets the periods.  
Public PropertyPriceGets the price. This is the final calculated price for the product.  
Public PropertyPriceCountGets or sets the price counting.  
Public PropertyPriceMatrixMultiplePricesGets or sets PriceMatrixMultiplePrices.  
Public PropertyPriceMatrixPeriodGets or sets PriceMatrixPeriod.  
Public PropertyPriceMatrixQuantitySpecificationGets or sets PriceMatrixQuantitySpecification.  
Public PropertyPriceMatrixUnitGets or sets PriceMatrixUnit.  
Public PropertyPriceMatrixVariantGets or sets PriceMatrixVariant.  
Public PropertyPricesGets or sets the collection of prices. Product prices are ranged according to variety of criteria e.g. Bulk prices, Campaigns, Units and Variant.  
Public PropertyPriceTypeGets or sets the type of the price e.g. calculated, fixed, fixed plus changes. Price type is only available if the product type is Parts List.  
Public PropertyPrimaryGroupIDGet ID of primary group  
Public PropertyProductFieldValuesGets or sets the collection of custom product field values. Administrator can create custom product fields in the Management Center -> eCommerce settings -> Product catalog -> Product fields.  
Public PropertyProductPriceStringGets or sets the product price string.  
Public PropertyPropertyProductValuesGets or sets the collection of product properties.  
Public PropertyPropertyRelationsGets or sets the property relations.  
Public PropertyRatingGets or sets the rating of the product.  
Public PropertyRelatedCountGets the RelatedProducts counting.  
Public PropertyRelatedGroupsOverloaded. Gets or sets the collection of related groups. The products can be placed in a different product group and then they will appear in more than one product category.  
Public PropertyRelatedGroupsWithoutProductsGets or sets the related groups without products.  
Public PropertyRelationSortingGets or sets RelationSorting.  
Public PropertyShopGets or sets shop the product belongs to.  
Public PropertyShortDescriptionGets or sets the short(teaser) description of the product.  
Public PropertySoldItemsGets or sets the number of sold items.  
Public PropertyStockGets or sets the product stock.  
Public PropertyStockGroupGets or sets the stock group.  
Public PropertyStockGroupIDGets or sets StockGroupID.  
Public PropertyStockStatusGets the stock status.  
Public PropertyTaxCollectionGets the tax collection.  
Public PropertyTypeGets or sets the type of the product (stock item, service or parts list).  
Public PropertyUnformattedPriceGets the price value. This is the final calculated price for the product.  
Public PropertyUnitCountGets or sets the unit counting.  
Public PropertyUnitListGets or sets VariantOptionCollection object.  
Public PropertyUnitsGets or sets the collection of stock units.  
Public PropertyUnitStockGets the stock of units.  
Public PropertyUnitsUniqueGets or sets the collection of stock units.  
Public PropertyUpdatedGets or sets the date when the product was updated.  
Public PropertyVariantCombinationsGets or sets VariantCombinationCollection object.  
Public PropertyVariantCombinationsWithStockCheckGets or sets VariantCombinationCollection object.  
Public PropertyVariantCountGets or sets the variant counting.  
Public PropertyVariantGroupCountGets or sets the VariantGroup counting.  
Public PropertyVariantGroupsGets or sets the collection of VariantGroup objects. The same product can be available in different variants, e.g. shoes of different sizes and colors. Administrator can create variants in Management Center -> eCommerce settings -> Product catalog -> Variants  
Public PropertyVariantIDGets or sets VariantID.  
Public PropertyVariantProductCountGets or sets the VariantProduct counting.  
Public PropertyVatGroupGets or sets VatGroup object. VAT groups are managed in the Management Center -> eCommerce settings -> Internationalization -> VAT groups.  
Public PropertyVatGroupIDGets or sets VatGroupID. VAT groups are managed in the Management Center -> eCommerce settings -> Internationalization -> VAT groups.  
Public PropertyVirtualVariantIDGets or sets VirtualVariantID.  
Public PropertyVolumeGets or sets the product volume.  
Public PropertyWeightGets or sets the product weight.  
Top
Public Methods
 NameDescription
Public MethodAddGroupAdds the group to the products Groups collection. Also creates the ProductGroupRelation in the database if it does not already exist and group.ID is exists.  
Public MethodAddRelatedProductAdds a related product to this product and saves it to the database.  
Public MethodAddVariantGroupAdds the variant group.  
Public MethodCloneClones this instance.  
Public MethodCopyCopies this instance and saves it in the DB. This method like Clone method, but generates new ID and sets empty VariantID.  
Public MethodCopyAsVariantCopies this instance and saves it in the DB.  
Public MethodDeleteDeletes this Product. If this instance is a Variant or a specific language version, then only this instance is deleted. Requires the product to be in the Database or exception is thrown.  
Public MethodFillFills the properties from DataReader.  
Public Methodstatic (Shared in Visual Basic)GetActiveProductsOverloaded. Gets the active products. Context.LanguageID is used.  
Public Methodstatic (Shared in Visual Basic)GetAllProductsOverloaded. Gets all products. Context.LanguageID is used.  
Public Methodstatic (Shared in Visual Basic)GetAllProductsByShopIDGets all products from shop. No language filter is applied meaning all language version of all products in the shop are returned.  
Public Methodstatic (Shared in Visual Basic)GetAllProductsWithoutVariantsOverloaded. Gets all products without variants. Context.LanguageID is used.  
Public MethodGetCalculatedFieldValues  
Public MethodGetCategoriesGet the Dynamicweb.eCommerce.Products.Categories.Category objects for each of the Dynamicweb.eCommerce.Products.Group this belongs  
Public MethodGetCategoryValueOverloaded. Retrieves the value of the given category field.  
Public Methodstatic (Shared in Visual Basic)GetCommaSeparatedProductIDsReturns list of IDs.  
Public Methodstatic (Shared in Visual Basic)GetProductByIDOverloaded. Gets the product by ID.  
Public Methodstatic (Shared in Visual Basic)GetProductByNumberOverloaded. Gets the product by number.  
Public Methodstatic (Shared in Visual Basic)GetProductBySqlOverloaded. Gets the products by SQL.  
Public MethodGetProductFieldValueGets the product field value.  
Public Methodstatic (Shared in Visual Basic)GetProductsAndVariantsByProductGets the all products and variants with the same product ID and language ID as the given product.  
Public Methodstatic (Shared in Visual Basic)GetProductsByGroupOverloaded. Gets all language version of all products from the group.  
Public Methodstatic (Shared in Visual Basic)GetProductsByGroupIDOverloaded. Gets the product collection based on Group ID, containing active products only. Context.LanguageID is used.  
Public Methodstatic (Shared in Visual Basic)GetProductsByGroupsOverloaded. Gets the products from groups.  
Public Methodstatic (Shared in Visual Basic)GetProductsByNameAndLanguageGets the products collection by name and language.  
Public Methodstatic (Shared in Visual Basic)GetProductsByProductAndVariantIDGets the products.  
Public Methodstatic (Shared in Visual Basic)GetProductsByProductIDsOverloaded. Gets the products. Context.LanguageID is used.  
Public Methodstatic (Shared in Visual Basic)GetProductsByShopIDOverloaded. Gets products from shop. Context.LanguageID is used.  
Public Methodstatic (Shared in Visual Basic)GetProductsBySqlGets the ProductCollection object.  
Public Methodstatic (Shared in Visual Basic)GetProductsByVariantGroupGets the products.  
Public Methodstatic (Shared in Visual Basic)GetSqlConditionPartForIDsGets the condition part of a SQL statement.  
Public Methodstatic (Shared in Visual Basic)ProductVariantExistsIf variant exists return true.  
Public MethodRelatedCountFrontendGets the RelatedProducts counting.  
Public MethodRelatedProductsGets the related products. Related products are used to suggest a customer to buy complementary products to the products they want to buy, e.g. a shirt and a tie. Administrator can create relations in Management Center -> eCommerce settings -> Product catalog -> Related products.  
Public MethodRemoveGroupRemoves the group from the products Groups collection. Also deletes the ProductGroupRelation from the database if group.ID exists.  
Public MethodRemoveItemRemoves the item.  
Public MethodRemoveVariantGroupRemoves the variant group by object reference.  
Public MethodRemoveVariantGroupLoopRemoves the variant group by ID, LanguageID, Label and Name.  
Public MethodSaveOverloaded. Saves this instance.  
Public MethodSetCategoryValueOverloaded. Assigns category field value to the current product.  
Public MethodSetProductFieldValue  
Public Methodstatic (Shared in Visual Basic)UnitExistsDetermines whether unit exists.  
Public MethodUpdateCountersUpdates the variant and unit counters. Should be called after adding variants or units to a product through the API.  
Public Methodstatic (Shared in Visual Basic)UpdateDefaultVariantIDUpdates the default variant ID.  
Public Methodstatic (Shared in Visual Basic)UpdatePriceCountUpdates the price counter.  
Public Methodstatic (Shared in Visual Basic)UpdateStockOverloaded. Updates the stock.  
Public Methodstatic (Shared in Visual Basic)UpdateUnitCountUpdates the unit counter.  
Public Methodstatic (Shared in Visual Basic)UpdateVariantCountUpdates the variant counter.  
Top
See Also

Reference

Product Class
Dynamicweb.eCommerce.Products Namespace

Send Feedback