|
Class Summary |
| Address |
Address |
| AddToBasketOptions |
An object used to contain options used when adding items to the basket. |
| AddToWishListOptions |
An object used to contain options used when adding items to the wish list. |
| Basket |
Basket class |
| BookableProduct |
A bookable product is an extension for a product containing attributes relevant to a bookable
product such as start and end dates and time slots for days of the week |
| BookableProductOptions |
The BookableProductOptions is used to define the behaviour of certain Bookable Product APIs |
| Booking |
The Booking class contains information about bookings made for the bookable product. |
| Bookings |
Used to return a number of bookings |
| Category |
Category class |
| Country |
The Country object |
| Coupon |
The Coupon class contains information about the coupon which can be used to activate promotions
on an order. |
| CreateOrderOptions |
An object used to contain options used when creating an order from an array of basket items. |
| CreditCard |
CreditCard Details |
| Currency |
|
| Customer |
Customer |
| CustomerEvent |
A customer event is used to save customer related event information used mainly for statistical
purposes. |
| CustomerGroup |
Object defining a customer group which is used to aggregate a number of customers normally to
apply promotions or to send communications. |
| CustomerRegistration |
CustomerRegistration |
| CustomerSearch |
|
| CustomerTag |
A customer tag is used to save customer related information used mainly for marketing purposes. |
| DataDescConstants |
|
| DataDescriptor |
|
| DbPortabilityDB2 |
Standard rules for DB2 |
| DbPortabilityImpl |
Superclass for DBPortability implementations |
| DbPortabilityMSSql |
Standard rules for MS SQL Server |
| DbPortabilityOracle |
Standard rules for Oracle |
| DbPortabilityPostgreSql |
Standard rules for PostgreSQL |
| DigitalDownload |
The Digital Download class contains information about which users have products to download. |
| Email |
An object used to describe the content of an eMail. |
| EmailOptions |
An object used to configure options used when sending eMails. |
| EngineConfig |
Used to configure the KonaKart engine when instantiated |
| ExportOrderOptions |
The object used as an argument to the Order Export API calls |
| ExportOrderResponse |
The response from the exportOrder API call |
| Expression |
An expression is used to group combinations of expression variables |
| ExpressionVariable |
An expression variable is part of an expression |
| FetchProductOptions |
An object used to define options used when reading one or more products from the database |
| GeoZone |
This is the GeoZone class - it has geo zoneId, geo name, geo description. |
| IpnHistory |
Contains the data received from an instant product notification from a payment gateway. |
| KKConfiguration |
A KonaKart Configuration object |
| KKCookie |
KKCookie |
| KKDbMapMgr |
This is a manager for manipulating the Torque dbMaps |
| KKEng |
The KonaKart Engine |
| KKFacet |
The KKFacet class is used to store the name and number of a facet as well as the values. |
| KkMsg |
KkMsg class |
| KKTorque |
This is a class for setting up Torque for KonaKart |
| KKWSEng |
The KonaKart Web Services Engine - Generated by createKKWSEng |
| Language |
Language class |
| Manufacturer |
|
| MiscItem |
MiscItem |
| MqOptions |
The object used as an argument to the MQ API calls |
| MqResponse |
The object used as a return object from the MQ API calls |
| NameNumber |
Generic class used to contain a name number pair. |
| NameValue |
Used to contain a name value pair |
| Option |
A product contains an array of these option objects. |
| Order |
Order |
| OrderProduct |
OrderProduct class |
| Orders |
|
| OrderSearch |
OrderSearch object |
| OrderStatus |
|
| OrderStatusHistory |
|
| OrderTotal |
Order Total Object |
| PaymentDetails |
The PaymentDetails for the Payment Modules |
| PaymentOptions |
Payment options which is passed to the admin payment module. |
| PaymentSchedule |
Defines the details of a payment schedule for recurring billing. |
| PdfOptions |
PdfOptions object for the creation of PDF documents |
| PdfResult |
PDF Results object for the Admin App |
| ProdCustAttr |
A Custom product attribute object stores the name and value of the attribute together with some
metadata describing it. |
| Product |
Product class |
| ProductQuantity |
Product Quantity object which contains the quantity of a product for different option value
combinations |
| Products |
|
| ProductSearch |
ProductSearch object |
| Promotion |
This is the Promotion class - it contains information about the promotion; links it to the Order
Total module that is used to calculate the promotion, and identifies to what products and
customers the promotion applies. |
| PromotionOptions |
The PromotionOptions is passed to the getPromotionsPerProducts() API call to configure the
behavior of the call. |
| PromotionProduct |
A class to define a product down to the level of an option and the value of the option. |
| PromotionResult |
Promotion Result Object. |
| Review |
|
| Reviews |
|
| RewardPoint |
A reward points object for use within KonaKart. |
| RewardPoints |
RewardPoints |
| ShippingQuote |
The object used by the engine to receive information from the modules |
| SnippetOptions |
Used to configure snippets which are text fragments returned by the search engine surrounding the
search text. |
| SolrProducts |
Used to return the search result from Solr |
| SSOToken |
The SSOToken class contains information to facilitate the transfer of session information when
accessing a KonaKart application from multiple sources. |
| Store |
A KonaKart Store definition |
| Subscription |
Defines a recurring billing subscription. |
| SuggestedSearchItem |
SuggestedSearchItem class |
| SuggestedSearchOptions |
Used to configure the suggested search API call |
| Tag |
An object that represents a tag used as metadata for products |
| TagGroup |
An object used to group tags. |
| TaxClass |
Tax Class - holds objects such as "Taxable Goods" (which is the only row by default)
No multi-language support is provided for this in osCommerce |
| TaxRate |
|
| TierPrice |
Tier Price object that contains the price for different quantities |
| WishList |
WishList class |
| WishListItem |
WishListItem class |
| WishListItems |
This is normally the object returned for API calls returning an array of wish list items. |
| WishLists |
This is the object returned for API calls returning an array of WishLists. |
| Zone |
This is the Zone class - it has zoneId, countryId, code and name. |
| ZoneSearch |
Contains information required to search for a zone. |