Module: index

ERROR_UNKNOWN.
The index module provides access to constructors for all the classes which comprise the public API.

An AMD (recommended!) or CommonJS application will generally do something equivalent to the following: 

var ShopApi = require('index'); // See note below*.
var xxxSvc = new ShopApi.XxxApi(); // Allocate the API class we're going to use.
var yyyModel = new ShopApi.Yyy(); // Construct a model instance.
yyyModel.someProperty = 'someValue';
...
var zzz = xxxSvc.doSomething(yyyModel); // Invoke the service.
...
*NOTE: For a top-level AMD script, use require(['index'], function(){...}) and put the application logic within the callback function.

A non-AMD browser application (discouraged) might do something like this: 

var xxxSvc = new ShopApi.XxxApi(); // Allocate the API class we're going to use.
var yyy = new ShopApi.Yyy(); // Construct a model instance.
yyyModel.someProperty = 'someValue';
...
var zzz = xxxSvc.doSomething(yyyModel); // Invoke the service.
...

Version:
  • 20.4
Source:

Members

(static) AiApi

The AiApi service constructor.

Properties:
Type Description
module:api/AiApi
Source:

(static) ApiClient

The ApiClient constructor.

Properties:
Type Description
module:ApiClient
Source:

(static) ApproachingDiscount

The ApproachingDiscount model constructor.

Properties:
Type Description
module:models/ApproachingDiscount
Source:

(static) ApproachingDiscountResult

The ApproachingDiscountResult model constructor.

Properties:
Type Description
module:models/ApproachingDiscountResult
Source:

(static) AuthRequest

The AuthRequest model constructor.

Properties:
Type Description
module:models/AuthRequest
Source:

(static) Basket

The Basket model constructor.

Properties:
Type Description
module:models/Basket
Source:

(static) BasketPaymentInstrumentRequest

The BasketPaymentInstrumentRequest model constructor.

Properties:
Type Description
module:models/BasketPaymentInstrumentRequest
Source:

(static) BasketReference

The BasketReference model constructor.

Properties:
Type Description
module:models/BasketReference
Source:

(static) BasketsApi

The BasketsApi service constructor.

Properties:
Type Description
module:api/BasketsApi
Source:

(static) BasketsResult

The BasketsResult model constructor.

Properties:
Type Description
module:models/BasketsResult
Source:

(static) BonusDiscountLineItem

The BonusDiscountLineItem model constructor.

Properties:
Type Description
module:models/BonusDiscountLineItem
Source:

(static) BoolFilter

The BoolFilter model constructor.

Properties:
Type Description
module:models/BoolFilter
Source:

(static) BoolQuery

The BoolQuery model constructor.

Properties:
Type Description
module:models/BoolQuery
Source:

(static) BundledProduct

The BundledProduct model constructor.

Properties:
Type Description
module:models/BundledProduct
Source:

(static) CategoriesApi

The CategoriesApi service constructor.

Properties:
Type Description
module:api/CategoriesApi
Source:

(static) Category

The Category model constructor.

Properties:
Type Description
module:models/Category
Source:

(static) CategoryResult

The CategoryResult model constructor.

Properties:
Type Description
module:models/CategoryResult
Source:

(static) Content

The Content model constructor.

Properties:
Type Description
module:models/Content
Source:

(static) ContentApi

The ContentApi service constructor.

Properties:
Type Description
module:api/ContentApi
Source:

(static) ContentFolder

The ContentFolder model constructor.

Properties:
Type Description
module:models/ContentFolder
Source:

(static) ContentFolderResult

The ContentFolderResult model constructor.

Properties:
Type Description
module:models/ContentFolderResult
Source:

(static) ContentResult

The ContentResult model constructor.

Properties:
Type Description
module:models/ContentResult
Source:

(static) ContentSearchApi

The ContentSearchApi service constructor.

Properties:
Type Description
module:api/ContentSearchApi
Source:

(static) ContentSearchRefinement

The ContentSearchRefinement model constructor.

Properties:
Type Description
module:models/ContentSearchRefinement
Source:

(static) ContentSearchRefinementValue

The ContentSearchRefinementValue model constructor.

Properties:
Type Description
module:models/ContentSearchRefinementValue
Source:

(static) ContentSearchResult

The ContentSearchResult model constructor.

Properties:
Type Description
module:models/ContentSearchResult
Source:

(static) CouponItem

The CouponItem model constructor.

Properties:
Type Description
module:models/CouponItem
Source:

(static) Customer

The Customer model constructor.

Properties:
Type Description
module:models/Customer
Source:

(static) CustomerAddress

The CustomerAddress model constructor.

Properties:
Type Description
module:models/CustomerAddress
Source:

The CustomerAddressLink model constructor.

Properties:
Type Description
module:models/CustomerAddressLink
Source:

(static) CustomerAddressResult

The CustomerAddressResult model constructor.

Properties:
Type Description
module:models/CustomerAddressResult
Source:

(static) CustomerInfo

The CustomerInfo model constructor.

Properties:
Type Description
module:models/CustomerInfo
Source:

(static) CustomerOrderResult

The CustomerOrderResult model constructor.

Properties:
Type Description
module:models/CustomerOrderResult
Source:

(static) CustomerPaymentCardRequest

The CustomerPaymentCardRequest model constructor.

Properties:
Type Description
module:models/CustomerPaymentCardRequest
Source:

(static) CustomerPaymentInstrument

The CustomerPaymentInstrument model constructor.

Properties:
Type Description
module:models/CustomerPaymentInstrument
Source:

(static) CustomerPaymentInstrumentRequest

The CustomerPaymentInstrumentRequest model constructor.

Properties:
Type Description
module:models/CustomerPaymentInstrumentRequest
Source:

(static) CustomerPaymentInstrumentResult

The CustomerPaymentInstrumentResult model constructor.

Properties:
Type Description
module:models/CustomerPaymentInstrumentResult
Source:

(static) CustomerProductList

The CustomerProductList model constructor.

Properties:
Type Description
module:models/CustomerProductList
Source:

(static) CustomerProductListItem

The CustomerProductListItem model constructor.

Properties:
Type Description
module:models/CustomerProductListItem
Source:

The CustomerProductListItemLink model constructor.

Properties:
Type Description
module:models/CustomerProductListItemLink
Source:

(static) CustomerProductListItemPurchase

The CustomerProductListItemPurchase model constructor.

Properties:
Type Description
module:models/CustomerProductListItemPurchase
Source:

(static) CustomerProductListItemPurchaseResult

The CustomerProductListItemPurchaseResult model constructor.

Properties:
Type Description
module:models/CustomerProductListItemPurchaseResult
Source:

(static) CustomerProductListItemResult

The CustomerProductListItemResult model constructor.

Properties:
Type Description
module:models/CustomerProductListItemResult
Source:

(static) CustomerProductListRegistrant

The CustomerProductListRegistrant model constructor.

Properties:
Type Description
module:models/CustomerProductListRegistrant
Source:

(static) CustomerProductListResult

The CustomerProductListResult model constructor.

Properties:
Type Description
module:models/CustomerProductListResult
Source:

(static) CustomerRegistration

The CustomerRegistration model constructor.

Properties:
Type Description
module:models/CustomerRegistration
Source:

(static) CustomersApi

The CustomersApi service constructor.

Properties:
Type Description
module:api/CustomersApi
Source:

(static) CustomObject

The CustomObject model constructor.

Properties:
Type Description
module:models/CustomObject
Source:

(static) CustomObjectsApi

The CustomObjectsApi service constructor.

Properties:
Type Description
module:api/CustomObjectsApi
Source:

(static) Discount

The Discount model constructor.

Properties:
Type Description
module:models/Discount
Source:

(static) DiscountRequest

The DiscountRequest model constructor.

Properties:
Type Description
module:models/DiscountRequest
Source:

(static) Fault

The Fault model constructor.

Properties:
Type Description
module:models/FaultModel
Source:

(static) FilteredQuery

The FilteredQuery model constructor.

Properties:
Type Description
module:models/FilteredQuery
Source:

(static) FoldersApi

The FoldersApi service constructor.

Properties:
Type Description
module:api/FoldersApi
Source:

(static) GiftCertificate

The GiftCertificate model constructor.

Properties:
Type Description
module:models/GiftCertificate
Source:

(static) GiftCertificateApi

The GiftCertificateApi service constructor.

Properties:
Type Description
module:api/GiftCertificateApi
Source:

(static) GiftCertificateItem

The GiftCertificateItem model constructor.

Properties:
Type Description
module:models/GiftCertificateItem
Source:

(static) GiftCertificateRequest

The GiftCertificateRequest model constructor.

Properties:
Type Description
module:models/GiftCertificateRequest
Source:

(static) Image

The Image model constructor.

Properties:
Type Description
module:models/Image
Source:

(static) ImageGroup

The ImageGroup model constructor.

Properties:
Type Description
module:models/ImageGroup
Source:

(static) Inventory

The Inventory model constructor.

Properties:
Type Description
module:models/Inventory
Source:

(static) Locale

The Locale model constructor.

Properties:
Type Description
module:models/Locale
Source:

(static) Master

The Master model constructor.

Properties:
Type Description
module:models/Master
Source:

(static) NestedQuery

The NestedQuery model constructor.

Properties:
Type Description
module:models/NestedQuery
Source:

(static) Note

The Note model constructor.

Properties:
Type Description
module:models/Note
Source:

(static) NotesResult

The NotesResult model constructor.

Properties:
Type Description
module:models/NotesResult
Source:

(static) Option

The Option model constructor.

Properties:
Type Description
module:models/Option
Source:

(static) OptionItem

The OptionItem model constructor.

Properties:
Type Description
module:models/OptionItem
Source:

(static) OptionValue

The OptionValue model constructor.

Properties:
Type Description
module:models/OptionValue
Source:

(static) Order

The Order model constructor.

Properties:
Type Description
module:models/Order
Source:

(static) OrderAddress

The OrderAddress model constructor.

Properties:
Type Description
module:models/OrderAddress
Source:

(static) OrderPaymentCardRequest

The OrderPaymentCardRequest model constructor.

Properties:
Type Description
module:models/OrderPaymentCardRequest
Source:

(static) OrderPaymentInstrument

The OrderPaymentInstrument model constructor.

Properties:
Type Description
module:models/OrderPaymentInstrument
Source:

(static) OrderPaymentInstrumentRequest

The OrderPaymentInstrumentRequest model constructor.

Properties:
Type Description
module:models/OrderPaymentInstrumentRequest
Source:

(static) OrdersApi

The OrdersApi service constructor.

Properties:
Type Description
module:api/OrdersApi
Source:

(static) OrderSearchApi

The OrderSearchApi service constructor.

Properties:
Type Description
module:api/OrderSearchApi
Source:

(static) OrderSearchHit

The OrderSearchHit model constructor.

Properties:
Type Description
module:models/OrderSearchHit
Source:

(static) OrderSearchRequest

The OrderSearchRequest model constructor.

Properties:
Type Description
module:models/OrderSearchRequest
Source:

(static) OrderSearchResult

The OrderSearchResult model constructor.

Properties:
Type Description
module:models/OrderSearchResult
Source:

(static) PasswordChangeRequest

The PasswordChangeRequest model constructor.

Properties:
Type Description
module:models/PasswordChangeRequest
Source:

(static) PasswordReset

The PasswordReset model constructor.

Properties:
Type Description
module:models/PasswordReset
Source:

(static) PaymentBankAccount

The PaymentBankAccount model constructor.

Properties:
Type Description
module:models/PaymentBankAccount
Source:

(static) PaymentBankAccountRequest

The PaymentBankAccountRequest model constructor.

Properties:
Type Description
module:models/PaymentBankAccountRequest
Source:

(static) PaymentCard

The PaymentCard model constructor.

Properties:
Type Description
module:models/PaymentCard
Source:

(static) PaymentCardSpec

The PaymentCardSpec model constructor.

Properties:
Type Description
module:models/PaymentCardSpec
Source:

(static) PaymentMethod

The PaymentMethod model constructor.

Properties:
Type Description
module:models/PaymentMethod
Source:

(static) PaymentMethodResult

The PaymentMethodResult model constructor.

Properties:
Type Description
module:models/PaymentMethodResult
Source:

(static) PriceAdjustment

The PriceAdjustment model constructor.

Properties:
Type Description
module:models/PriceAdjustment
Source:

(static) PriceAdjustmentLimit

The PriceAdjustmentLimit model constructor.

Properties:
Type Description
module:models/PriceAdjustmentLimit
Source:

(static) PriceAdjustmentLimits

The PriceAdjustmentLimits model constructor.

Properties:
Type Description
module:models/PriceAdjustmentLimits
Source:

(static) PriceAdjustmentLimitsApi

The PriceAdjustmentLimitsApi service constructor.

Properties:
Type Description
module:api/PriceAdjustmentLimitsApi
Source:

(static) PriceAdjustmentRequest

The PriceAdjustmentRequest model constructor.

Properties:
Type Description
module:models/PriceAdjustmentRequest
Source:

(static) Product

The Product model constructor.

Properties:
Type Description
module:models/Product
Source:

The ProductDetailsLink model constructor.

Properties:
Type Description
module:models/ProductDetailsLink
Source:

(static) ProductItem

The ProductItem model constructor.

Properties:
Type Description
module:models/ProductItem
Source:

The ProductLink model constructor.

Properties:
Type Description
module:models/ProductLink
Source:

(static) ProductListEvent

The ProductListEvent model constructor.

Properties:
Type Description
module:models/ProductListEvent
Source:

(static) ProductListItemReference

The ProductListItemReference model constructor.

Properties:
Type Description
module:models/ProductListItemReference
Source:

The ProductListLink model constructor.

Properties:
Type Description
module:models/ProductListLink
Source:

(static) ProductListRegistrant

The ProductListRegistrant model constructor.

Properties:
Type Description
module:models/ProductListRegistrant
Source:

(static) ProductListsApi

The ProductListsApi service constructor.

Properties:
Type Description
module:api/ProductListsApi
Source:

(static) ProductListShippingAddress

The ProductListShippingAddress model constructor.

Properties:
Type Description
module:models/ProductListShippingAddress
Source:

(static) ProductPromotion

The ProductPromotion model constructor.

Properties:
Type Description
module:models/ProductPromotion
Source:

(static) ProductRecommendationsResult

The ProductRecommendationsResult model constructor.

Properties:
Type Description
module:models/ProductRecommendationsResult
Source:

(static) ProductRef

The ProductRef model constructor.

Properties:
Type Description
module:models/ProductRef
Source:

(static) ProductResult

The ProductResult model constructor.

Properties:
Type Description
module:models/ProductResult
Source:

(static) ProductsApi

The ProductsApi service constructor.

Properties:
Type Description
module:api/ProductsApi
Source:

(static) ProductSearchApi

The ProductSearchApi service constructor.

Properties:
Type Description
module:api/ProductSearchApi
Source:

(static) ProductSearchHit

The ProductSearchHit model constructor.

Properties:
Type Description
module:models/ProductSearchHit
Source:

(static) ProductSearchRefinement

The ProductSearchRefinement model constructor.

Properties:
Type Description
module:models/ProductSearchRefinement
Source:

(static) ProductSearchRefinementValue

The ProductSearchRefinementValue model constructor.

Properties:
Type Description
module:models/ProductSearchRefinementValue
Source:

(static) ProductSearchResult

The ProductSearchResult model constructor.

Properties:
Type Description
module:models/ProductSearchResult
Source:

(static) ProductSearchSortingOption

The ProductSearchSortingOption model constructor.

Properties:
Type Description
module:models/ProductSearchSortingOption
Source:

The ProductSimpleLink model constructor.

Properties:
Type Description
module:models/ProductSimpleLink
Source:

(static) ProductType

The ProductType model constructor.

Properties:
Type Description
module:models/ProductType
Source:

(static) Promotion

The Promotion model constructor.

Properties:
Type Description
module:models/Promotion
Source:

The PromotionLink model constructor.

Properties:
Type Description
module:models/PromotionLink
Source:

(static) PromotionResult

The PromotionResult model constructor.

Properties:
Type Description
module:models/PromotionResult
Source:

(static) PromotionsApi

The PromotionsApi service constructor.

Properties:
Type Description
module:api/PromotionsApi
Source:

(static) PublicProductList

The PublicProductList model constructor.

Properties:
Type Description
module:models/PublicProductList
Source:

(static) PublicProductListItem

The PublicProductListItem model constructor.

Properties:
Type Description
module:models/PublicProductListItem
Source:

(static) PublicProductListItemResult

The PublicProductListItemResult model constructor.

Properties:
Type Description
module:models/PublicProductListItemResult
Source:

The PublicProductListLink model constructor.

Properties:
Type Description
module:models/PublicProductListLink
Source:

(static) PublicProductListResult

The PublicProductListResult model constructor.

Properties:
Type Description
module:models/PublicProductListResult
Source:

(static) QueryFilter

The QueryFilter model constructor.

Properties:
Type Description
module:models/QueryFilter
Source:

(static) Range2Filter

The Range2Filter model constructor.

Properties:
Type Description
module:models/Range2Filter
Source:

(static) RangeFilter

The RangeFilter model constructor.

Properties:
Type Description
module:models/RangeFilter
Source:

(static) Recommendation

The Recommendation model constructor.

Properties:
Type Description
module:models/Recommendation
Source:

(static) RecommendationType

The RecommendationType model constructor.

Properties:
Type Description
module:models/RecommendationType
Source:

(static) ResetPasswordRequest

The ResetPasswordRequest model constructor.

Properties:
Type Description
module:models/ResetPasswordRequest
Source:

(static) ResetPasswordTokenRequest

The ResetPasswordTokenRequest model constructor.

Properties:
Type Description
module:models/ResetPasswordTokenRequest
Source:

(static) ResetPasswordTokenResult

The ResetPasswordTokenResult model constructor.

Properties:
Type Description
module:models/ResetPasswordTokenResult
Source:

(static) ResultPage

The ResultPage model constructor.

Properties:
Type Description
module:models/ResultPage
Source:

(static) SearchSuggestionApi

The SearchSuggestionApi service constructor.

Properties:
Type Description
module:api/SearchSuggestionApi
Source:

(static) SessionsApi

The SessionsApi service constructor.

Properties:
Type Description
module:api/SessionsApi
Source:

(static) Shipment

The Shipment model constructor.

Properties:
Type Description
module:models/Shipment
Source:

(static) ShippingItem

The ShippingItem model constructor.

Properties:
Type Description
module:models/ShippingItem
Source:

(static) ShippingMethod

The ShippingMethod model constructor.

Properties:
Type Description
module:models/ShippingMethod
Source:

(static) ShippingMethodResult

The ShippingMethodResult model constructor.

Properties:
Type Description
module:models/ShippingMethodResult
Source:

(static) ShippingPromotion

The ShippingPromotion model constructor.

Properties:
Type Description
module:models/ShippingPromotion
Source:

The SimpleLink model constructor.

Properties:
Type Description
module:models/SimpleLink
Source:

(static) Site

The Site model constructor.

Properties:
Type Description
module:models/Site
Source:

(static) SiteApi

The SiteApi service constructor.

Properties:
Type Description
module:api/SiteApi
Source:

(static) Sort

The Sort model constructor.

Properties:
Type Description
module:models/Sort
Source:

(static) Status

The Status model constructor.

Properties:
Type Description
module:models/Status
Source:

(static) Store

The Store model constructor.

Properties:
Type Description
module:models/Store
Source:

(static) StoreResult

The StoreResult model constructor.

Properties:
Type Description
module:models/StoreResult
Source:

(static) StoresApi

The StoresApi service constructor.

Properties:
Type Description
module:api/StoresApi
Source:

(static) SuggestedCategory

The SuggestedCategory model constructor.

Properties:
Type Description
module:models/SuggestedCategory
Source:

(static) SuggestedContent

The SuggestedContent model constructor.

Properties:
Type Description
module:models/SuggestedContent
Source:

(static) SuggestedPhrase

The SuggestedPhrase model constructor.

Properties:
Type Description
module:models/SuggestedPhrase
Source:

(static) SuggestedProduct

The SuggestedProduct model constructor.

Properties:
Type Description
module:models/SuggestedProduct
Source:

(static) SuggestedTerm

The SuggestedTerm model constructor.

Properties:
Type Description
module:models/SuggestedTerm
Source:

(static) SuggestedTerms

The SuggestedTerms model constructor.

Properties:
Type Description
module:models/SuggestedTerms
Source:

(static) Suggestion

The Suggestion model constructor.

Properties:
Type Description
module:models/Suggestion
Source:

(static) SuggestionResult

The SuggestionResult model constructor.

Properties:
Type Description
module:models/SuggestionResult
Source:

(static) TermFilter

The TermFilter model constructor.

Properties:
Type Description
module:models/TermFilter
Source:

(static) TermQuery

The TermQuery model constructor.

Properties:
Type Description
module:models/TermQuery
Source:

(static) TextQuery

The TextQuery model constructor.

Properties:
Type Description
module:models/TextQuery
Source:

(static) TrustedSystemAuthRequest

The TrustedSystemAuthRequest model constructor.

Properties:
Type Description
module:models/TrustedSystemAuthRequest
Source:

(static) Variant

The Variant model constructor.

Properties:
Type Description
module:models/Variant
Source:

(static) VariationAttribute

The VariationAttribute model constructor.

Properties:
Type Description
module:models/VariationAttribute
Source:

(static) VariationAttributeValue

The VariationAttributeValue model constructor.

Properties:
Type Description
module:models/VariationAttributeValue
Source:

(static) VariationGroup

The VariationGroup model constructor.

Properties:
Type Description
module:models/VariationGroup
Source: