Name 

Description 

Classes 

The following table lists classes in this documentation. 

Structs, Records, Enums 

The following table lists structs, records, enums in this documentation. 

 

Name 

Description 

 

AddressData 

Gets or sets information about a specified address. For example, if you were creating an address data object for a fictional user, Ivan Tory, at Ektron's address, the code might look like this:  

 

AdjustedBasketItem 

Class used to represent basket item price adjustments.  

 

AppliedCouponData 

This is class Ektron.Cms.Commerce.AppliedCouponData. 

 

AppliedCouponDataCollection 

This is class Ektron.Cms.Commerce.AppliedCouponDataCollection. 

 

AppliedCouponEventArgs 

This is class Ektron.Cms.Commerce.AppliedCouponEventArgs. 

 

Basket 

This is class Ektron.Cms.Commerce.Basket. 

 

BasketCalculatorData 

This is class Ektron.Cms.Commerce.BasketCalculatorData. 

 

BasketData 

This is class Ektron.Cms.Commerce.BasketData. 

 

BasketItem 

Data class representing a basket line item.  

 

BasketItemCollection 

Collection class for BasketItems.  

 

BasketVariantData 

 

 

BundleData 

 

 

CatalogData 

 

 

ContractData 

This is class Ektron.Cms.Commerce.ContractData. 

 

CountryData 

Gets or sets information about a specified country.  

 

CountryTaxRateData 

This is class Ektron.Cms.Commerce.CountryTaxRateData. 

 

CouponData 

This is class Ektron.Cms.Commerce.CouponData. 

 

CouponEntryData 

This is class Ektron.Cms.Commerce.CouponEntryData. 

 

CurrencyData 

Data class representing currencies in system.  

 

CurrencyPricingData 

Represents Pricing Information for agiven currency.  

 

CustomerData 

Data class representing Customers in system.  

 

Dimensions 

Class used to define dimension information.  

 

EntryAttributeData 

This is class Ektron.Cms.Commerce.EntryAttributeData. 

 

EntryData 

Base class for catalog entry data classes.  

 

EntryGroupData 

Data class representing Catalog Entry Groups in system.  

 

EntryGroupItemData 

This is class Ektron.Cms.Commerce.EntryGroupItemData. 

 

ExchangeRateData 

This is class Ektron.Cms.Commerce.ExchangeRateData. 

 

ImageMediaData 

This is class Ektron.Cms.ImageMediaData. 

 

InventoryData 

The InventoryData class allows you to get and set various inventory information for a catalog entry (product).  

 

KitConfigData 

Invitation class used for sending friend requests.  

 

KitData 

 

 

MediaData 

This is class Ektron.Cms.MediaData. 

 

MediaGalleryData 

This is class Ektron.Cms.MediaGalleryData. 

 

OptionGroupData 

Data class representing Option groups for Entry Kits.  

 

OptionGroupItemCollection 

Collection class for OptionGroupItemData.  

 

OptionGroupItemData 

Data class representing option group items in the CMS. Option Group Items are option items for a particular Kit Grouping.  

 

OrderData 

 

 

OrderLineData 

 

 

OrderPartData 

data class representing order part sin the cms.  

 

PackageData 

Data class used for representing package sizes used for shipping items.  

 

PaymentAuthorization 

Data class representing payment authorization from gateway.  

 

PaymentMethod 

Base class used for representing payment methods for use by payment provider.  

 

PipelineStageData 

 

 

PostalCodeTaxRateData 

This is class Ektron.Cms.Commerce.PostalCodeTaxRateData. 

 

PricingData 

This is class Ektron.Cms.Commerce.PricingData. 

 

ProductData 

 

 

ProductTypeAttributeData 

This is class Ektron.Cms.Commerce.ProductTypeAttributeData. 

 

ProductTypeData 

Data class representing ecommerce product types.  

 

RecommendationItemData 

Data class representing entry reccomendations in ecommerce system.  

 

RegionData 

Gets or sets information about specified geographic regions within countries that your eCommerce site services. For example, in the United States of America, each state is a region. So, if you were adding New Hampshire as a region, the code might look like this.  

 

RegionTaxRateData 

This is class Ektron.Cms.Commerce.RegionTaxRateData. 

 

ShippingBaseData 

Base data class for representing shipping method information.  

 

ShippingOptionData 

Data class representing a quote for a particular shipping method.  

 

TaxClassData 

Data object representing tax class information.  

 

TaxRateData 

This is class Ektron.Cms.Commerce.TaxRateData. 

 

TaxTypeData 

Data class representing Tax Types.  

 

ThumbnailData 

This is class Ektron.Cms.ThumbnailData. 

 

ThumbnailDefaultData 

This is class Ektron.Cms.ThumbnailDefaultData. 

 

TierPriceData 

This is class Ektron.Cms.Commerce.TierPriceData. 

 

ProductCouponEntryData 

This is class Ektron.Cms.Commerce.ProductCouponEntryData. 

 

WarehouseData 

This is class Ektron.Cms.Commerce.WarehouseData. 

 

Weight 

Class used to define mesurement information.  

 

ShippingMethodData 

Data class used to represent shipping methods defined in the cms.  

 

Name 

Description 

 

AddressProperty 

Enumeration of Address properties used for sorting and filtering AddressData objects.  

 

CountryProperty 

Enumeration of CountryData properties used for sorting and filtering CountryData objects.  

 

CouponProperty 

Enumeration of Coupon properties used for sorting and filtering CouponData objects.  

 

CurrencyProperty 

Enumeration of CurrencyData properties used for sorting and filtering CurrencyData objects.  

 

CustomerProperty 

Enumeration of Customer properties used for sorting and filtering CustomerData objects.  

 

EntryAttributeProperty 

Enumeration of EntryAttributeProperty properties available for sorting and filtering.  

 

EntryGroupItemProperty 

Enumeration of Entry Group Item properties used for sorting and filtering EntryGroupItemData objects.  

 

EntryGroupProperty 

Enumeration of EntryGroup properties used for sorting and filtering EntryGroupData objects.  

 

EntryProperty 

Enumeration of EntryData columns available for sorting and filtering.  

 

ExchangeRateProperty 

Enumeration of ExchangeRate columns available for sorting and filtering.  

 

LinearUnit 

Enumeration of units for measuring length.  

 

OrderProperty 

Enumeration of order properties used for sorting and filtering OrderData objects.  

 

PackageProperty 

Enumeration representing properties of the packagedata class.  

 

ProductTypeAttributeProperty 

Enumeration of ProductTypeAttributeData properties available for sorting and filtering.  

 

ProductTypeProperty 

Enumeration of ProductType properties used for sorting and filtering CustomerData objects.  

 

RegionProperty 

Enumeration of Region properties used for sorting and filtering RegionData objects.  

 

ShippingMethodProperty 

Enumeration representing properties of the ShippingMethodData class.  

 

TaxClassProperty 

/ Enumeration of TaxClass columns available for sorting and filtering.  

 

TaxRateProperty 

Enumeration of possible values to order Lists of TaxRateData by.  

 

TaxRateType 

This Represents the default Tax rate Types supported by The CMS. Additonal tax Types may be supported by customers. 

 

TaxTypeProperty 

/ Enumeration of TaxType columns available for sorting and filtering.  

 

WarehouseProperty 

Enumeration of Warehouse properties used for sorting and filtering WarehouseData objects.  

 

WeightUnit 

Enumeration of units for measuring weight.