| Class | Description |
|---|---|
| Address |
Address
|
| AddrValidationResult |
An object returned by address verification.
|
| 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.
|
| BankTransferConfigData |
Data used to configure Bank Transfer
|
| 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
|
| CaptchaInput |
An object passed to recaptcha module in order to perform a validation
|
| CaptchaResult |
An object returned by address verification.
|
| Catalog |
Catalog object for App
|
| Category |
Category class
|
| CategoryTreeOptions |
An object used to contain options used when retrieving Category Trees
|
| ConfigData |
ConfigData Class
|
| Content |
Content class
|
| ContentDescription |
ContentDescription class
|
| ContentSearch |
ContentSearch object
|
| ContentSearchResult |
Content Search Result object
|
| ContentType |
ContentType class
|
| ContentTypeDescription |
ContentTypeDescription class
|
| Country |
The Country object
|
| Coupon |
The Coupon class contains information about the coupon which can be used to activate promotions
on an order.
|
| CouponOptions |
The CouponOptions is passed to the getCoupon() API call to configure the behavior of the call.
|
| CreateOrderOptions |
An object used to contain options used when creating an order from an array of basket items.
|
| CreditCard |
CreditCard Details
|
| CreditCardOptions |
The CreditCardOptions is used to define the behaviour of certain Credit Card related APIs
|
| Currency |
Currency Object
|
| 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 |
CustomerSearch Object
|
| CustomerTag |
A customer tag is used to save customer related information used mainly for marketing purposes.
|
| DataDescConstants |
Constants used to define sort order
|
| DataDescriptor |
General Data Descriptor object
|
| DigitalDownload |
The Digital Download class contains information about which users have products to download.
|
| EditCustomerOptions |
Options available when editing a customer
|
|
An object used to describe the content of an eMail.
|
|
| EmailOptions |
An object used to configure options used when sending eMails.
|
| EmailTemplate |
An object used to hold email attributes typically that have been parsed from templates
|
| 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
|
| ExternalLoginInput |
An object passed to an external login module in order to perform a login
|
| ExternalLoginResult |
An object returned by an external login module such as FacebookLogin
|
| ExternalMailInput |
An object passed to an external mail module in order to send a mail
|
| ExternalMailResult |
An object returned by an external mail module
|
| FetchCustomerOptions |
Options available when fetching a customer
|
| FetchDigitalDownloadOptions |
An object used to define options used when reading a customer's digital downloads from the
database.
|
| FetchOrderOptions |
Options available when fetching orders
|
| FetchProductOptions |
An object used to define options used when reading one or more products from the database
|
| FetchPromotionOptions |
An object used to define options used when reading a promotion from the database
|
| FetchRewardPointOptions |
An object used to define options used when reading a customer's reward points from the database.
|
| FetchTagGroupOptions |
An object used to define options used when reading tag groups from the database
|
| GeoZone |
This is the GeoZone class - it has geo zoneId, geo name, geo description.
|
| IntAndTimePair |
This is the IntAndTimePair class - it holds an Integer and a Timestamp.
|
| IpnHistory |
Contains the data received from an instant product notification from a payment gateway.
|
| KKBeanCopier | |
| KKBeanEscaper | |
| KKConfiguration |
A KonaKart Configuration object
|
| KKCookie |
KKCookie
|
| KKEng |
The KonaKart Engine
|
| KKEvent |
Event Object
|
| KKEventSearch |
Event Search Object
|
| KKFacet |
The KKFacet class is used to store the name and number of a facet as well as the values.
|
| KkMsg |
KkMsg class
|
| KKPriceFacet |
The KKPriceFacet class is used to store the price facet information returned by a Solr search.
|
| Language |
Language class
|
| LanguageSearch |
To define searches for Languages
|
| LoginInput |
An object containing required data to perform a login
|
| LoginResult |
An object containing the result of a login
|
| Manufacturer |
Manufacturer
|
| ManufacturerSearch |
Manufacturer Search Object
|
| MiscItem |
MiscItem
|
| MiscPrice |
MiscPrice object
|
| 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
|
| NotificationOptions |
Object that contains data for setting newsletter and product notifications
|
| Option |
A product contains an array of these option objects.
|
| Order |
Order
|
| OrderProduct |
OrderProduct class
|
| Orders |
Orders
|
| OrderSearch |
OrderSearch object
|
| OrderShipment |
OrderShipment object
|
| OrderShipmentProduct |
OrderShipmentProduct object.
|
| OrderStatus |
Order Status Object
|
| OrderStatusHistory |
Order Status History
|
| OrderTotal |
Order Total Object
|
| OrderUpdate |
OrderUpdate 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
|
| PriceFacetOptions |
Used to configure the faceting of prices when using Solr.
|
| ProdCustAttr |
A Custom product attribute object stores the name and value of the attribute together with some
metadata describing it.
|
| Product |
Product class
|
| ProductImageCrc |
The Product Image CRC object
|
| ProductImages |
The ProductImages object
|
| ProductImagesOptions |
The ProductImagesOptions object
|
| ProductQuantity |
Product Quantity object which contains the quantity of a product for different option value
combinations
|
| ProductRelationship |
An object that contains relationship data for a relation between two products
|
| Products |
Products object
|
| 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() and getPromotionsPerCoupon API
calls to configure the behavior of the calls.
|
| PromotionProduct |
A class to define a product down to the level of an option and the value of the option.
|
| PromotionResult |
Promotion Result Object.
|
| PunchOutOptions |
This object contains attributes used to configure Punch Out API calls.
|
| PunchOutResult |
Object containing the PunchOut message
|
| Review |
Review object
|
| Reviews | |
| ReviewSearch |
Review Search Object
|
| RewardPoint |
A reward points object for use within KonaKart.
|
| RewardPoints |
RewardPoints
|
| SaveOrderOptions |
The object used to add options when saving an order
|
| 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.
|
| StockReservation |
A StockReservation object contains all of the information stored in the database when stock is
reserved
|
| StockReservationOptions |
An object containing options used when reserving product stock
|
| Store |
A KonaKart Store definition
|
| Subscription |
Defines a recurring billing subscription.
|
| Subscriptions |
Subscriptions Object
|
| SubscriptionSearch |
SubscriptionSearch object
|
| SuggestedSearchItem |
SuggestedSearchItem class
|
| SuggestedSearchOptions |
Used to configure the suggested search API call
|
| SuggestedSpellingItem |
SuggestedSpellingItem class
|
| SuggestedSpellingOptions |
Used to configure the suggested spelling API call
|
| Suggestion |
Suggestion class
|
| 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 |
Tax Rate
|
| TierPrice |
Tier Price object that contains the price for different quantities
|
| VariantPrice | |
| Vendor |
A KonaKart Vendor definition
|
| Vendors | |
| VendorSearch |
Review Search Object
|
| 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.
|
| Exception | Description |
|---|---|
| KKCustomerDisabledException |
Subclass of KKException thrown when the operation cannot be performed because a customer has been disabled
|
| KKInvalidZoneException |
Subclass of KKException thrown when a customer registration is attempted with an invalid zone.
|
| KKPasswordDoesntMatchException |
Subclass of KKException thrown when the password doesn't match the password in the database
|
| KKPasswordExpiredException |
Subclass of KKException thrown when the password has expired
|
| KKUserDoesntExistException |
Subclass of KKException thrown when a send new password is attempted but the user doesn't exist
|
| KKUserExistsException |
Subclass of KKException thrown when a customer registration is attempted but the user already
exists.
|
Copyright © 2018 DS Data Systems UK Ltd.