ProductDTO Class Properties

<< Click to Display Table of Contents >>

Navigation:  CXS.Retail.DTO Assembly > Namespaces > CXS.Retail.DTO Namespace > Classes > ProductDTO >

ProductDTO Class Properties

iVend Retail 6.6 - Web API Help

ProductDTO Class Properties

Collapse All Expand All Members Options: Show All Members Options: Filtered

[TCheckBoxFormControlObj] Include Inherited Members

[TCheckBoxFormControlObj] Include Protected Members

CXS.Retail.DTO Namespace : ProductDTO Class

For a list of all members of this type, see ProductDTO members.

Public Properties

 

Name

Description

Public Property

AllowFractionalQuantity

Gets or sets a value indicating whether transaction is allowed in the fractional quantity for the product. By default the value is set to False  

Public Property

AllowZeroPrice

Gets or sets the Allow Zero Price for the product  

Public Property

AlternateUPCValues

Get and Set Alternate UPC Codes  

Public Property

AttributeList

Gets or sets the attribute list.(Set attribute list if you want to create matrix or matrix child item.)  

Public Property

Attributes

Gets or sets the Products Attributes.  

Public Property

AutoGenerateChildItemDefinition

Gets or sets the AutoGenerateChildItemDefinition.  

Public Property

AutoSelectSerialBatchType

Gets or sets the type of the auto select serial batch.  

Public Property

BarCodeMaskId

Gets or sets the Barcode Mask Id.

Length: 20 characters.

 

Public Property

BarcodeMaskKey

 

Public Property

BasePrice

Gets or sets the base price.  

Public Property

CanLayaway

Gets or sets a value indicating whether the item can be put on layaway at the POS.  

Public Property

CanOrder

Gets or sets a value indicating whether the sales order can be accepted for this product at the POS.  

Public Property

CanRefundExpiredItem

Gets or sets a value indicating whether the cashier is allowed to refund the expired item from customers.

This setting would only work if the item is batch or serial contolled and the expiry dates of either has been specified.

 

Public Property

CanSellExpiredItem

Gets or sets a value indicating whether this instance can sell expired item.

This setting would only work if the item is batch or serial contolled and the expiry dates of either has been specified.

 

Public Property

Comment

Gets or sets the comment.  

Public Property

Cost

Specify the standard cost of the product. Incase the product's costing method is Standard Cost and SubMethod is PerProduct Applicable only for iVend Unplugged version  

Public Property

CostingMethod

Gets or sets the costing method.  

Public Property

CostingSubMethod

Gets or sets the costing sub method.  

Public Property

DefaultQuantity

Gets or sets the default quantity.

If the default quantity is set to other than 0 then on scanning the barcode of an item the default quanity is populated in the transactionn.

 

Public Property

Description

Mandatory

Gets or sets the product description.

Length: 100 characters.

 

Public Property

Description2

Gets or sets the description2 of the product.

Length: 100 characters.

 

Public Property

Description3

Gets or sets the description3 of the product.

Length: 200 characters.

 

Public Property

DiscountsAllowed

Gets or sets a value indicating whether any discounts are allowed on the product.  

Public Property

EnterpriseName

Gets the name of the enterprise. (Inherited from CXS.Retail.DTO.BaseDTO)

Public Property

ExternalLink

Gets or sets the external link.  

Public Property

FulfillmentPlanLayawayKey

Gets or sets the fulfillment plan Id for layaway transaction item.  

Public Property

FulfillmentPlanSaleKey

Gets or sets the fulfillment plan Id for sale transaction item.  

Public Property

FulfillmentPlanSOKey

Gets or sets the fulfillment plan Id for SO transaction item.  

Public Property

GenerateIntegrationEvent

Generated the integration event for the ERP. (Inherited from CXS.Retail.DTO.BaseDTO)

Public Property

GiftCertificateType

Gets or sets the type of the gift certificate.  

Public Property

HasAlternateProducts

Gets Has Alternate Products.  

Public Property

HasPackageGroup

Gets or sets the package group.

Length: 20 characters.

 

Public Property

HasUpsells

Gets Has upsell.  

Public Property

HSNCode

Gets of Sets the HSN Code on the Product. Applicable only for the India Localization.  

Public Property

Id

Mandatory

Gets or sets the product id.

Length: 20 characters.

 

Public Property

IgnoreDiscountItemsForSaleDiscount

Gets or sets the maximum open price for an item.

This setting would specify if the sale discounts are to be disallowed in case when the line discount is already given on the item.

 

Public Property

ImageLocation

Gets or sets the image location.  

Public Property

InventoryCountingUOMKey

 

Public Property

InventoryLocationList

Gets the location for the product. The purpose of this property is only to get the location  

Public Property

InventoryUOMId

Gets or sets the InventoryUOMId for the product.  

Public Property

IsAssembly

Gets a value indicating whether this instance is assembly.  

Public Property

IsBatchTracked

Gets or sets a value indicating whether this product is batch tracked.  

Public Property

IsDynamicAssembly

Gets or sets the is Dynamic Assembly property of the product.  

Public Property

IsEBTItem

Get and Set EBT Item  

Public Property

IsExchangable

Gets or sets a value indicating whether once soled the customer can exchange this product.  

Public Property

IsGiftCertificate

Gets or sets the is gift certificate.  

Public Property

IsInclusiveTaxed

Gets or sets a value indicating whether this instance is inclusively taxed.

If the item is taxed inclusively then the taxes are built into the price of the product.

 

Public Property

IsKit

Gets a value indicating whether this instance is kit.  

Public Property

IsMatrixChildItem

Gets or sets the is matrix child item. (Set True if you want to create matrix child Item)  

Public Property

IsMatrixItem

Get and Set Matrix Item  

Public Property

IsNonStock

Gets or sets a value indicating whether this product is a non stock item.

If the item is either batch or serial controlled then the item cannot be marked as the non stock item.

 

Public Property

IsOnHold

Gets or sets a value indicating whether this product is on hold.  

Public Property

IsOpenDescription

Gets or sets a value indicating whether this instance is open description.

Select this option to allow the user at POS to specify the description of the product during a sale. When this option is selected for a product, on adding this product to the sale, the system would ask the cashier to can change the description of the product before adding to transaction.

 

Public Property

IsOpenPrice

Gets or sets a value indicating whether this instance is open price.

Select this option to allow the user at POS to specify the price of the product during a sale. When this option is selected for a product, on adding this product to the sale, the system would ask the cashier to can change the price of the product before adding to transaction.

 

Public Property

IsPurchasable

Gets or sets a value indicating whether this instance is purchasable.  

Public Property

IsRefundable

Gets or sets a value indicating whether this instance is refundable.  

Public Property

IsSaleable

Gets or sets a value indicating whether this instance is saleable.  

Public Property

IsSerialTracked

Gets or sets a value indicating whether this instance is serial tracked.  

Public Property

IsStoreCredit

Gets or sets the InventoryUOMId for the product.  

Public Property

IsTaxExempt

Gets or sets a value indicating whether this product is tax exempt.  

Public Property

IsTaxOnly

Gets or sets the is tax only property of an item. If the item is marked as Tax Only then only the tax calculated on the item is added to the transaction totals.  

Public Property

IsTwoDimensionalMatrixItem

Get and Set IsTwoDimensionalMatrixItem  

Public Property

IsValid

Gets or sets a value indicating whether this product is valid.  

Public Property

IsWeighed

Gets or sets a value indicating if the product is weighed and sold at the POS.  

Public Property

IsZeroValue

Gets or sets a value indicating whether this instance is zero value.

If the item is marked for Zero Values then irrespecitive of any price list the product will always be sold at 0 price.

 

Public Property

Key

Gets the key (Internal unique key of every objects). (Inherited from CXS.Retail.DTO.BaseDTO)

Public Property

LeadTime

Gets or sets the lead time for delivering the product.  

Public Property

LoyaltyPointsRedeemable

Gets or sets a value indicating whether loyalty points can be redeemed against this product.  

Public Property

ManufacturerId

Gets or sets the manufacturer id.

Length: 20 characters.

 

Public Property

ManufacturerKey

 

Public Property

MaxDiscountAmount

Gets or sets the Max Discount in Amount for the product  

Public Property

MaxDiscountPercentage

Gets or sets the Max Discount in Percentage for the product  

Public Property

MaximumOpenPrice

Gets or sets the maximum open price for an item.

This setting would only work if the item is defined as an Open Priced Item.

 

Public Property

MaxQuantityPerTransaction

Gets or sets the Max Quantity Per Transaction for the product  

Public Property

MerchandiseHierarchyDetailKey

Gets or sets the Merchandise Hierarchy Detail Key.  

Public Property

Message

Returns error message in case of Integration failure. (Inherited from CXS.Retail.DTO.BaseDTO)

Public Property

MinAge

Gets or sets the min age that is required for buying this product.  

Public Property

PackageGroupId

Gets or sets the package group id.

Length: 20 characters.

 

Public Property

ParentProductId

Gets or sets the parent product Id. (Set Parent product Id if IsMatrixChildItem is marked as true.)  

Public Property

PreferedVendorId

Gets or sets the prefered vendor id from whom this product is purchased.

Length: 20 characters.

 

Public Property

PriceOverrideAllowed

Gets or sets a value indicating whether the cashier is allowed to override the price for this product at POS.  

Public Property

ProductAssemblyComponents

Gets or sets the product assembly components.  

Public Property

ProductClassId

Gets or sets the product class id.

Length: 20 characters.

 

Public Property

ProductDiscountGroupId

 

Public Property

ProductGroupId

Mandatory

Gets or sets the product group id.

Length: 20 characters.

 

Public Property

ProductGroupKey

 

Public Property

ProductInventory

Gets or sets the product inventory item.  

Public Property

ProductKitComponents

Gets or sets the product kit components.  

Public Property

ProductMatrixDetails

 

Public Property

ProductMerchandiseHierarchyDetailList

Gets or sets the Product Merchandise Hierarchy Detail list.  

Public Property

PublishedToAllStores

 

Public Property

PurchaseTaxCodeId

Gets or sets the purchase tax code id then the specified tax code will be defaulted for the product while creating the purchase order from the system.

Length: 20 characters.

 

Public Property

PurchaseTaxCodeKey

 

Public Property

PurchaseUOMKey

 

Public Property

PurchaseUOMPackageKey

 

Public Property

RequireAgeVerification

Gets or sets a value indicating whether any age proof is required from customer for buying this product.  

Public Property

ReturnDays

Gets or sets the return days of the product if product is refundable.  

Public Property

SaleDiscountsAllowed

Gets or sets the Sale discounts allowed for an item.

This setting would specify if the sale level discounts can be applied to this item.

 

Public Property

SalesTaxCodeId

Gets or sets the sales tax code id.

If the default tax code id is defined then the specified tax code will be defaulted for the product at the POS.

Length: 20 characters.

 

Public Property

SalesTaxCodeKey

 

Public Property

SaleUOMKey

 

Public Property

SaleUOMPackageKey

 

Public Property

SubsidiaryIds

Gets or sets SubsidiaryIds.  

Public Property

SubsidiaryItemList

Gets the Subsidiary Item List for the product. The purpose of this property is only to get the SubsidiaryItemList  

Public Property

UOMGroupId

Mandatory

Gets or sets the UOM group id.

Length: 20 characters.

 

Public Property

UOMGroupKey

 

Public Property

UPC

Gets or sets the UPC.

Length: 100 characters.

 

Public Property

UserFields

Gets or sets the user defined fields. (Inherited from CXS.Retail.DTO.BaseDTO)

Public Property

VariantCode

Gets or sets the VariantCode for the product.  

Top

See Also

Reference

ProductDTO Class

CXS.Retail.DTO Namespace

Send Feedback