ESDRecordProduct Class |
Namespace: EcommerceStandardsDocuments
The ESDRecordProduct type exposes the following members.
Name | Description | |
---|---|---|
ESDRecordProduct | Initializes a new instance of the ESDRecordProduct class |
Name | Description | |
---|---|---|
averageCost | Monetary value that denotes the average cost to purchase a single product unit. | |
barcode | Barcode set for the product. A barcode is typically displayed on a product and requires a reader to decipher an image that turns it into a sequence of characters. | |
barcodeInner | Inner barcode set for the product. Multiple barcodes be assigned to a product, and the inner barcode could denote one of these barcodes, or it could be a portion of a single barcode. | |
brand | Branding of the product. | |
deliveryTimeInStock | Label of the amount of time that it would typically take for the product to be delivered when it is in stock | |
deliveryTimeNoStock | Label of the amount of time that it would typically take for the product to be delivered when it is out of stock | |
depth | Depth dimension of a single product unit. | |
depthUnitMeasureCode | Code of the product's depth measurement to define the unit of measurement. Set it to a constant prefixed with UNIT_MEASURE_LENGTH_ in the ESDocumentConstants class | |
description1 | First description of the product. May contain any text used to describe the product. | |
description2 | Second description of the product. May contain any text used to describe the product. | |
description3 | Third description of the product. May contain any text used to describe the product. | |
description4 | Fourth description of the product. May contain any text used to describe the product. | |
drop | Data Record OPeration. Denotes an operation that may need to be performed on the record when it is being processed.
Set null, or set it to one of the ESD_RECORD_OPERATION constants in the ESDocumentConstants class to allow the record to be inserted, updated, deleted, or ignored. | |
height | Height dimension of a single product unit. | |
heightUnitMeasureCode | Code of the product's height measurement to define the unit of measurement. Set it to a constant prefixed with UNIT_MEASURE_LENGTH_ in the ESDocumentConstants class | |
internalID | Stores an identifier that is relevant only to the system referencing and storing the record for its own needs. | |
isKitted | Either 'N'-No or
'Y'-Yes
If 'Y' then indicates product is a kit, and is representative of a number of individual products bundled together. | |
isPriceTaxInclusive | Either 'N'-No or
'Y'-Yes
If 'Y' then indicates that any pricing set for the product is inclusive of tax applied to the price, based the rate of taxcode assigned to the product. | |
keyProductID | Key that allows the product record to be uniquely identified and linked to. | |
keySellUnitID | Key of the sell unit record that denotes the default unit that the product is sold in. | |
keyTaxcodeID | Key of the Taxcode record that the product is assigned to. The taxcode may control the amount of tax applied to the product. | |
kitProductsSetPrice | Either 'N'-No or
'Y'-Yes
If 'N' then indicated that if the product is marked as a kit then when its pricing is calculated, that the price of the product should be calculated by combining the price of all the component products assignd to the kit.
| |
metaDescription | Meta description the product. This would typically be used in the meta data of a web page or user interface that may be hidden from being viewed, but contains a paragraph of text describing the details of a product that may be used to index, or display in search listings. The data in this field is typically targeted for online search engines. | |
metaKeywords | A list of words that describe the product. This would typically be used in the meta data of a web page or user interface that may be hidden from being viewed, but contains a space delimited list of keywords used by systems to index and allow for searching on the product. The data in this field is typically targeted for online search engines. | |
metaTitle | Meta title of the product. This would typically be used in the meta data of a web page or user interface that may be hidden from being viewed, but contains a label of the product that systems could utilise or be displayed in an application's header. The data in this field is typically targeted for online search engines. | |
name | Name of the product | |
ordering | Number to order the product by. This may be used to order a number of products within a list. | |
packQuantity | Quantity of units that allow the product to bought as a pack. This is deprecated in favour of using sell units. | |
packUnit | Label of the pack that the product may be bought as. This is deprecated in favour of using sell units. | |
productClass | Class of the product. A class may contain any text that can be set for multiple products as a classifier of the type of product. | |
productCode | Code of the product. May or may not be a unqiue identifier. | |
productSearchCode | Code that allows the product to searched on. This search code may or may not be unique, and would typically contain key words that allows the product to found. | |
sellUnits | Stores a list of sell units that denote different quantities the the product can be sold in | |
stockAvailableSinceDate | Date time that indicates when the product's stock units has been available or in-stock since. If the product currently has no stock available then ignore setting. Date is in the form of a number in milliseconds since the 01-01-1970 12:00am Epoch in UTC time-zone | |
stockLowQuantity | The amount of base product units that indicate when the product is low in stock. | |
stockNoneQuantity | The amount of base product units that indicate when the product is no longer in stock. | |
stockQuantity | The amount of base product units that are in stock and available for purchase. | |
supplier | Label of the supplier that the product is purchased from. | |
unit | Label of the default unit that the product is sold individually as. | |
UNSPSC | United Nations Standard Products and Service Code. Stores a standard code defined by the United Nations classifying objects. | |
warehouse | Label of the warehouse location that the product is assigned to. | |
weight | Weight of a single product unit. | |
weightUnitMeasureCode | Code of the product's weight measurement to define the unit of measurement. Set it to a constant prefixed with UNIT_MEASURE_MASS_ in the ESDocumentConstants class | |
width | Width dimension of a single product unit. | |
widthUnitMeasureCode | Code of the product's width measurement to define the unit of measurement. Set it to a constant prefixed with UNIT_MEASURE_LENGTH_ in the ESDocumentConstants class |