|
Interface Summary |
| AddressIf |
Used to contain the address of a customer. |
| AddToBasketOptionsIf |
An object used to contain options used when adding items to the basket. |
| AddToWishListOptionsIf |
An object used to contain options used when adding items to the basket. |
| BasketIf |
One basket object corresponds to an item in the shopping cart. |
| BookableProductIf |
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 |
| BookableProductOptionsIf |
The BookableProductOptions is used to define the behaviour of certain Bookable Product APIs |
| BookingIf |
The Booking class contains information about bookings made for the bookable product. |
| BookingsIf |
This is normally the object returned for API calls returning an array of Bookings. |
| CategoryIf |
Describes a category of products. |
| CountryIf |
Describes a country for use within KonaKart. |
| CouponIf |
The Coupon class contains information about the coupon which can be used to activate promotions
on an order. |
| CreateOrderOptionsIf |
An object used to contain options used when creating an order from an array of basket items. |
| CreditCardIf |
CreditCard Details |
| CurrencyIf |
Describes a currency for use within KonaKart. |
| CustomerEventIf |
A customer event is used to save customer related event information used mainly for statistical
purposes. |
| CustomerGroupIf |
Details of a KonaKart customer group. |
| CustomerIf |
Details of a KonaKart customer. |
| CustomerRegistrationIf |
Contains information required to register a customer. |
| CustomerSearchIf |
Contains information required to search for a customer. |
| CustomerTagIf |
A customer tag is used to save customer related information used mainly for marketing purposes. |
| DataDescriptorIf |
Contains information required to manage engine calls that return an array of data. |
| DbPortabilityIf |
For defining database-specific rules |
| DigitalDownloadIf |
The Digital Download class contains information about which customers are enabled to download
products. |
| EmailIf |
The interface of an object used to describe the content of an eMail. |
| EmailOptionsIf |
The interface of an object used to configure options used when sending eMails. |
| EngineConfigIf |
Used to configure the KonaKart engine when instantiated |
| ExportOrderOptionsIf |
The object used as an argument to the Order Export API calls |
| ExportOrderResponseIf |
The response from the exportOrder API call |
| ExpressionIf |
Describes an expression object |
| ExpressionVariableIf |
Describes an expression variable object |
| FetchProductOptionsIf |
An object used to define options used when reading one or more products from the database |
| GeoZoneIf |
Describes a tax zone. |
| IpnHistoryIf |
IPN stands for Instant Product Notification. |
| KKConfigurationIf |
Used to contain a configuration property. |
| KKCookieIf |
The KKCookie class is used to store and retrieve information from the KK_Cookie database table. |
| KKEngIf |
Describes all of the API calls to the KonaKart server engine. |
| KKFacetIf |
The KKFacet class is used to store the name and number of a facet as well as the values. |
| KkMsgIf |
Describes a KkMsg for use within KonaKart. |
| LanguageIf |
Describes a language for use within KonaKart |
| ManufacturerIf |
Describes a manufacturer of products in the KonaKart catalog. |
| MiscItemIf |
Describes a Miscellaneous item, an array of which may be attached to a Product and to a Category. |
| MqOptionsIf |
The object used as an argument to the MQ API calls |
| MqResponseIf |
The object used as a return object from the MQ API calls |
| NameNumberIf |
Generic class used to contain a name number pair. |
| NameValueIf |
Generic class used to contain a name value pair. |
| OptionIf |
A product contains an array of these option objects. |
| OrderIf |
Contains all data required to describe an order for use within KonaKart. |
| OrderProductIf |
Links an order to a product. |
| OrderSearchIf |
Contains information used to search for orders |
| OrdersIf |
This is normally the object returned for API calls returning an array of orders. |
| OrderStatusHistoryIf |
An order may have an array of these OrderStatusHistory objects to log the life cycle of the
order. |
| OrderStatusIf |
Contains text in different languages to describe the state of an order. |
| OrderTotalIf |
An order may have an array of OrderTotal objects. |
| PaymentDetailsIf |
An order may have a PaymentDetails object to describe the payment method. |
| PaymentOptionsIf |
Payment options which is passed to the admin payment module. |
| PaymentScheduleIf |
Defines the details of a payment schedule for recurring billing. |
| PdfOptionsIf |
Options when producing a PDF document. |
| PdfResultIf |
The result of an API call to get a PDF document. |
| ProdCustAttrIf |
A Custom product attribute object stores the name and value of the attribute together with some
metadata describing it. |
| ProductIf |
Describes a product object for use within KonaKart. |
| ProductQuantityIf |
Product Quantity object which contains the quantity of a product for different option value
combinations. |
| ProductSearchIf |
Contains information used to search the catalog for a product. |
| ProductsIf |
This is normally the object returned for API calls returning an array of Products. |
| PromotionIf |
The Promotion object contains information about the promotion. |
| PromotionOptionsIf |
The PromotionOptions is passed to the getPromotionsPerProducts() API call to configure the
behavior of the call. |
| PromotionProductIf |
An object used to define a product down to the level of an option and the value of the option. |
| PromotionResultIf |
Promotion Result Object. |
| ReviewIf |
Describes a review for use within KonaKart. |
| ReviewsIf |
This is normally the object returned for API calls returning an array of Reviews. |
| RewardPointIf |
Describes a reward points object for use within KonaKart. |
| RewardPointsIf |
This is normally the object returned for API calls returning an array of RewardPoint objects. |
| ShippingQuoteIf |
An order may have a ShippingQuote object to describe the shipping. |
| SnippetOptionsIf |
Used to configure snippets which are text fragments returned by the search engine surrounding the
search text. |
| SSOTokenIf |
The SSOToken class contains information to facilitate the transfer of session information when
accessing a KonaKart application from multiple sources. |
| StoreIf |
A KonaKart Store definition |
| SubscriptionIf |
Defines a recurring billing subscription. |
| SuggestedSearchItemIf |
SuggestedSearchItem interface |
| SuggestedSearchOptionsIf |
Used to configure the suggested search API call |
| TagGroupIf |
An object used to group tags. |
| TagIf |
An object that represents a tag used as metadata for products so that product searches can be
refined. |
| TaxClassIf |
The tax class associated with a product. |
| TaxRateIf |
Describes a tax rate. |
| TierPriceIf |
Tier Price object that contains the price for different quantities |
| WishListIf |
A Wish List object which may contain an array of wish list items. |
| WishListItemIf |
A Wish List Item. |
| WishListItemsIf |
This is normally the object returned for API calls returning an array of wish list items. |
| WishListsIf |
This is the object returned for API calls returning an array of WishLists. |
| ZoneIf |
Describes a physical zone. |
| ZoneSearchIf |
Contains information required to search for a zone. |