Kentico CMS 6.0 E-commerce Guide

API classes

API classes

Previous topic Next topic Mail us feedback on this topic!  

API classes

Previous topic Next topic JavaScript is required for the print function Mail us feedback on this topic!  

If you are not familiar with the database table data management by Info and Provider classes, we strongly recommend that you first refer to the Database table API topic in the API programming and Kentico CMS internals section of the Developer's Guide.

 

 

 

Please note

 

The E-commerce module classes use the CMS.Ecommerce namespace.

 

 

Customers

Products

Orders

Shopping cart

Currencies

Shipping and payment

Discounts

Taxes

 

Customers

 

COM_Customer table API:

 

CustomerInfo - represents one customer.

CustomerInfoProvider - provides management of customers.

 

CMS_User table API:

 

UserInfo - represents one registered user.

UserInfoProvider - provides management of registered users.

 

CMS_UserSite table API:

 

UserSiteInfo - represents a relationship between one user and one site; a given user is assigned to a given site.

UserSiteInfoProvider - provides management of relationships between users and sites.

 

COM_Address table API:

 

AddressInfo - represents one customer address.

AddressInfoProvider - provides management of customer addresses.

 

CMS_CustomerCreditHistory table API:

 

CreditEventInfo - represents one customer credit history.

CreditEventInfoProvider - provides management of customer credit histories.

 

Products

 

COM_OptionCategory table API:

 

OptionCategoryInfo - represents one product option category.

OptionCategoryInfoProvider - provides management of product option categories.

 

COM_SKU table API:

 

SKUInfo - represents one product (SKU).

SKUInfoProvider - provides management of products (SKUs).

 

COM_SKUOptionCategory table API:

 

SKUOptionCategoryInfo - represents a relationship between one product option category and one SKU, expressing that a particular product option category is available for a particular SKU.

SKUOptionCategoryInfoProvider - provides management of relationships between product option categories and SKUs.

 

COM_Bundle table API:

 

BundleInfo - represents a relationship between one product of the bundle product type and one other product, expressing that this product is within this bundle.

BundleInfoProvider - represents management of relationships between products of the bundle product type and other products.

 

COM_SKUFile table API:

 

SKUFileInfo - represents one e-product file.

SKUFileInfoProvider - provides management of e-product files.

 

COM_Manufacturer table API:

 

ManufacturerInfo - represents one manufacturer.

ManufacturerInfoProvider - provides management of manufacturers.

 

COM_Supplier table API:

 

SupplierInfo - represents one supplier.

SupplierInfoProvider - provides management of suppliers.

 

COM_Department table API:

 

DepartmentInfo - represents one department.

DepartmentInfoProvider - provides management of departments.

 

COM_UserDepartment table API:

 

UserDepartmentInfo - represents a relationship between one user and one department, expressing that a particular user can manage products of a particular department..

UserDepartmentInfoProvider - provides management of relationships between users and departments.

 

COM_InternalStatus table API

 

InternalStatusInfo - represents one product internal status.

InternalStatusInfoProvider - provides management of product internal statuses.

 

COM_PublicStatus table API

 

PublicStatusInfo - represents one product public status.

PublicStatusInfoProvider - provides management of product public statuses.

 

Orders

 

COM_Order table API:

 

OrderInfo - represents one order.

OrderInfoProvider - provides management of orders.

 

COM_OrderItem table API:

 

OrderItemInfo - represents one order item.

OrderItemInfoProvider - provides management of order items.

 

COM_OrderItemSKUFile table API:

 

OrderItemSKUFileInfo - represents a relationships between one order item and one e-product file, expressing that a particular order item comes with a particular e-product file. This relationship is created when an order containing an e-product is paid.

OrderItemSKUFileInfoProvider - provides management of order items and e-product files.

 

COM_OrderStatus table API:

 

OrderStatusInfo - represents one order status.

OrderStatusInfoProvider - provides management of order statuses.

 

COM_OrderStatusUser table API:

 

OrderStatusUserInfo - represents a relationship between one order status and one user, expressing order status changes, i.e. order status history.

OrderStatusUserInfoProvider - provides management of relationships between order statuses and users.

 

Shopping cart

 

COM_ShoppingCart table API:

 

ShoppingCartInfo - represents one shopping cart.

ShoppingCartInfoProvider - provides management of shopping carts.

 

COM_ShoppingCartSKU table API:

 

ShoppingCartItemInfo - represents a relationship between one SKU and one shopping cart expressing that a particular SKU is placed in a particular shopping cart.

ShoppingCartItemInfoProvider - provides management of relationships between SKUs and shopping carts.

 

COM_Wishlist table API:

 

WishlistItemInfo - represents one item (product) in the wishlist.

WishlistItemInfoProvider - represents management of items in the wishlists.

 

Currencies

 

COM_Currency table API:

 

CurrencyInfo - represents one currency.

CurrencyInfoProvider - provides management of currencies.

 

COM_ExchangeTable table API:

 

ExchangeTableInfo - represents one exchange table.

ExchangeTableInfoProvider - provides management of exchange tables.

 

COM_CurrencyExchangeRate table API:

 

ExchangeRateInfo - represents one exchange rate.

ExchangeRateInfoProvider - provides management of exchange rates.

 

Shipping and payment

 

COM_PaymentOption table API:

 

PaymentOptionInfo - represents one payment option.

PaymentOptionInfoProvider - provides management of payment options.

 

COM_PaymentShipping table API:

 

PaymentShippingInfo - represents a relationship between one payment method and one shipping, expressing that a given payment method is allowed for a given shipping.

PaymentShippingInfoProvider - provides management of relationships payment methods and shipping.

 

COM_ShippingOption table API:

 

ShippingOptionInfo - represents one shipping option.

ShippingOptionInfoProvider - provides management of shipping options.

 

COM_ShippingCost table API:

 

ShippingCostInfo - represents one shipping cost.

ShippingCostInfoProvider - provides management of shipping costs.

 

Discounts

 

COM_VolumeDiscount table API:

 

VolumeDiscountInfo - represents one volume discount.

VolumeDiscountInfoProvider - provides management of volume discounts.

 

COM_DiscountCoupon table API:

 

DiscountCouponInfo - represents one discount coupon.

DiscountCouponInfoProvider - provides management of discount coupons.

 

COM_SKUDiscountCoupon table API:

 

SKUDiscountCouponInfo - represents a relationship between one discount coupon and one SKU expressing that a particular discount coupon can be applied to a particular SKU.

SKUDiscountCouponInfoProvider - provides management of relationships between discount coupons and SKUs.

 

COM_DiscountLevel table API:

 

DiscountLevelInfo - represents one discount level.

DiscountLevelInfoProvider - provides management of discount levels.

 

COM_DiscountLevelDepartment table API:

 

DiscountLevelDepartmentInfo - represents a relationship between one discount level and one department expressing that a particular discount level is available for a particular department.

DiscountLevelDepartmentInfoProvider - provides management of relationships between discount levels and departments.

 

Taxes

 

COM_TaxClass table API:

 

TaxClassInfo - represents one tax class.

TaxClassInfoProvider - provides management of tax classes.

 

COM_TaxClassCountry table API:

 

TaxClassCountryInfo - represents a relationship between one tax class and one country, expressing the value of a particular tax in a particular country.

TaxClassCountryInfoProvider - provides management of relationships between tax classes and countries.

 

COM_TaxClassState table API:

 

TaxClassStateInfo - represents a relationship between one tax class and one state, expressing the value of a particular tax in a particular state.

TaxClassStateInfoProvider - provides management of relationships between tax classes and states.

 

COM_SKUTaxClasses table API:

 

SKUTaxClassInfo - represents a relationship between one tax class and one SKU, expressing that a particular tax class is assigned to a particular SKU.

SKUTaxClassInfoProvider - provides management of relationships between tax classes and SKUs.

 

COM_DepartmentTaxClass table API:

 

DepartmentTaxClassInfo - represents a relationship between one department and one tax class, expressing that all new products in a particular department will have automatically assigned a particular tax.

DepartmentTaxClassInfoProvider - provides management of relationships between departments and tax classes.

 

COM_ShippingOptionTaxClass table API:

 

ShippingOptionTaxClassInfo - represents a relationship between one shipping option and one tax class, expressing that a particular tax is assigned to a particular shipping.

ShippingOptionTaxClassInfoProvider - provides management of relationships between shipping options and tax classes.