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 Occ = require('index'); // See note below. var xxxSvc = new Occ.XxxApi(); // Allocate the API class we're going to use. var yyy = new Occ.Yyy(); // Construct a model instance. yyy.someProperty = 'someValue'; ... var zzz = xxxSvc.doSomething(yyy); // 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 Occ.XxxApi(); // Allocate the API class we're going to use. var yyy = new Occ.Yyy(); // Construct a model instance. yyy.someProperty = 'someValue'; ... var zzz = xxxSvc.doSomething(yyy); // Invoke the service. ...
Members
(static) Address
The Address model constructor.
Properties:
Type | Description |
---|---|
module:models/Address |
(static) AddressList
The AddressList model constructor.
Properties:
Type | Description |
---|---|
module:models/AddressList |
(static) AddressOCC
The AddressOCC model constructor.
Properties:
Type | Description |
---|---|
module:models/AddressOCC |
(static) ApiClient
The ApiClient constructor.
Properties:
Type | Description |
---|---|
module:ApiClient |
(static) BaseOption
The BaseOption model constructor.
Properties:
Type | Description |
---|---|
module:models/BaseOption |
(static) BillingAddress
The BillingAddress model constructor.
Properties:
Type | Description |
---|---|
module:models/BillingAddress |
(static) Breadcrumb
The Breadcrumb model constructor.
Properties:
Type | Description |
---|---|
module:models/Breadcrumb |
(static) CardType
The CardType model constructor.
Properties:
Type | Description |
---|---|
module:models/CardType |
(static) CardTypeList
The CardTypeList model constructor.
Properties:
Type | Description |
---|---|
module:models/CardTypeList |
(static) CardtypesApi
The CardtypesApi service constructor.
Properties:
Type | Description |
---|---|
module:api/CardtypesApi |
(static) Cart
The Cart model constructor.
Properties:
Type | Description |
---|---|
module:models/Cart |
(static) CartList
The CartList model constructor.
Properties:
Type | Description |
---|---|
module:models/CartList |
(static) Catalog
The Catalog model constructor.
Properties:
Type | Description |
---|---|
module:models/Catalog |
(static) CatalogList
The CatalogList model constructor.
Properties:
Type | Description |
---|---|
module:models/CatalogList |
(static) CatalogsApi
The CatalogsApi service constructor.
Properties:
Type | Description |
---|---|
module:api/CatalogsApi |
(static) CatalogVersion
The CatalogVersion model constructor.
Properties:
Type | Description |
---|---|
module:models/CatalogVersion |
(static) Category
The Category model constructor.
Properties:
Type | Description |
---|---|
module:models/Category |
(static) CategoryHierarchy
The CategoryHierarchy model constructor.
Properties:
Type | Description |
---|---|
module:models/CategoryHierarchy |
(static) Classification
The Classification model constructor.
Properties:
Type | Description |
---|---|
module:models/Classification |
(static) Consignment
The Consignment model constructor.
Properties:
Type | Description |
---|---|
module:models/Consignment |
(static) ConsignmentEntry
The ConsignmentEntry model constructor.
Properties:
Type | Description |
---|---|
module:models/ConsignmentEntry |
(static) Country
The Country model constructor.
Properties:
Type | Description |
---|---|
module:models/Country |
(static) CountryList
The CountryList model constructor.
Properties:
Type | Description |
---|---|
module:models/CountryList |
(static) CountryOCC
The CountryOCC model constructor.
Properties:
Type | Description |
---|---|
module:models/CountryOCC |
(static) CurrenciesApi
The CurrenciesApi service constructor.
Properties:
Type | Description |
---|---|
module:api/CurrenciesApi |
(static) Currency
The Currency model constructor.
Properties:
Type | Description |
---|---|
module:models/Currency |
(static) CurrencyList
The CurrencyList model constructor.
Properties:
Type | Description |
---|---|
module:models/CurrencyList |
(static) CurrencyOCC
The CurrencyOCC model constructor.
Properties:
Type | Description |
---|---|
module:models/CurrencyOCC |
(static) CustomergroupsApi
The CustomergroupsApi service constructor.
Properties:
Type | Description |
---|---|
module:api/CustomergroupsApi |
(static) DeliverycountriesApi
The DeliverycountriesApi service constructor.
Properties:
Type | Description |
---|---|
module:api/DeliverycountriesApi |
(static) DeliveryMode
The DeliveryMode model constructor.
Properties:
Type | Description |
---|---|
module:models/DeliveryMode |
(static) DeliveryModeList
The DeliveryModeList model constructor.
Properties:
Type | Description |
---|---|
module:models/DeliveryModeList |
(static) DeliveryOrderEntryGroup
The DeliveryOrderEntryGroup model constructor.
Properties:
Type | Description |
---|---|
module:models/DeliveryOrderEntryGroup |
(static) DeliveryPointOfService
The DeliveryPointOfService model constructor.
Properties:
Type | Description |
---|---|
module:models/DeliveryPointOfService |
(static) ExportApi
The ExportApi service constructor.
Properties:
Type | Description |
---|---|
module:api/ExportApi |
(static) Facet
The Facet model constructor.
Properties:
Type | Description |
---|---|
module:models/Facet |
(static) FacetValue
The FacetValue model constructor.
Properties:
Type | Description |
---|---|
module:models/FacetValue |
(static) Feature
The Feature model constructor.
Properties:
Type | Description |
---|---|
module:models/Feature |
(static) FeatureUnit
The FeatureUnit model constructor.
Properties:
Type | Description |
---|---|
module:models/FeatureUnit |
(static) FeatureValue
The FeatureValue model constructor.
Properties:
Type | Description |
---|---|
module:models/FeatureValue |
(static) FeedsApi
The FeedsApi service constructor.
Properties:
Type | Description |
---|---|
module:api/FeedsApi |
(static) ForgottenpasswordtokensApi
The ForgottenpasswordtokensApi service constructor.
Properties:
Type | Description |
---|---|
module:api/ForgottenpasswordtokensApi |
(static) FutureStock
The FutureStock model constructor.
Properties:
Type | Description |
---|---|
module:models/FutureStock |
(static) GeoPoint
The GeoPoint model constructor.
Properties:
Type | Description |
---|---|
module:models/GeoPoint |
(static) Image
The Image model constructor.
Properties:
Type | Description |
---|---|
module:models/Image |
(static) Language
The Language model constructor.
Properties:
Type | Description |
---|---|
module:models/Language |
(static) LanguageList
The LanguageList model constructor.
Properties:
Type | Description |
---|---|
module:models/LanguageList |
(static) LanguageOCC
The LanguageOCC model constructor.
Properties:
Type | Description |
---|---|
module:models/LanguageOCC |
(static) LanguagesApi
The LanguagesApi service constructor.
Properties:
Type | Description |
---|---|
module:api/LanguagesApi |
(static) Member
The Member model constructor.
Properties:
Type | Description |
---|---|
module:models/Member |
(static) MemberList
The MemberList model constructor.
Properties:
Type | Description |
---|---|
module:models/MemberList |
(static) OpeningSchedule
The OpeningSchedule model constructor.
Properties:
Type | Description |
---|---|
module:models/OpeningSchedule |
(static) Order
The Order model constructor.
Properties:
Type | Description |
---|---|
module:models/Order |
(static) OrderEntry
The OrderEntry model constructor.
Properties:
Type | Description |
---|---|
module:models/OrderEntry |
(static) OrderEntryList
The OrderEntryList model constructor.
Properties:
Type | Description |
---|---|
module:models/OrderEntryList |
(static) OrderEntryOCC
The OrderEntryOCC model constructor.
Properties:
Type | Description |
---|---|
module:models/OrderEntryOCC |
(static) OrderHistory
The OrderHistory model constructor.
Properties:
Type | Description |
---|---|
module:models/OrderHistory |
(static) OrderHistoryList
The OrderHistoryList model constructor.
Properties:
Type | Description |
---|---|
module:models/OrderHistoryList |
(static) OrdersApi
The OrdersApi service constructor.
Properties:
Type | Description |
---|---|
module:api/OrdersApi |
(static) OrderStatusUpdateElement
The OrderStatusUpdateElement model constructor.
Properties:
Type | Description |
---|---|
module:models/OrderStatusUpdateElement |
(static) OrderStatusUpdateElementList
The OrderStatusUpdateElementList model constructor.
Properties:
Type | Description |
---|---|
module:models/OrderStatusUpdateElementList |
(static) Pagination
The Pagination model constructor.
Properties:
Type | Description |
---|---|
module:models/Pagination |
(static) PaymentDetails
The PaymentDetails model constructor.
Properties:
Type | Description |
---|---|
module:models/PaymentDetails |
(static) PaymentDetailsList
The PaymentDetailsList model constructor.
Properties:
Type | Description |
---|---|
module:models/PaymentDetailsList |
(static) PaymentDetailsOCC
The PaymentDetailsOCC model constructor.
Properties:
Type | Description |
---|---|
module:models/PaymentDetailsOCC |
(static) PickupOrderEntryGroup
The PickupOrderEntryGroup model constructor.
Properties:
Type | Description |
---|---|
module:models/PickupOrderEntryGroup |
(static) PointOfService
The PointOfService model constructor.
Properties:
Type | Description |
---|---|
module:models/PointOfService |
(static) PointOfServiceStock
The PointOfServiceStock model constructor.
Properties:
Type | Description |
---|---|
module:models/PointOfServiceStock |
(static) Price
The Price model constructor.
Properties:
Type | Description |
---|---|
module:models/Price |
(static) PriceRange
The PriceRange model constructor.
Properties:
Type | Description |
---|---|
module:models/PriceRange |
(static) Principal
The Principal model constructor.
Properties:
Type | Description |
---|---|
module:models/Principal |
(static) Product
The Product model constructor.
Properties:
Type | Description |
---|---|
module:models/Product |
(static) ProductExpressUpdateElement
The ProductExpressUpdateElement model constructor.
Properties:
Type | Description |
---|---|
module:models/ProductExpressUpdateElement |
(static) ProductExpressUpdateElementList
The ProductExpressUpdateElementList model constructor.
Properties:
Type | Description |
---|---|
module:models/ProductExpressUpdateElementList |
(static) ProductList
The ProductList model constructor.
Properties:
Type | Description |
---|---|
module:models/ProductList |
(static) ProductOCC
The ProductOCC model constructor.
Properties:
Type | Description |
---|---|
module:models/ProductOCC |
(static) ProductOCC1
The ProductOCC1 model constructor.
Properties:
Type | Description |
---|---|
module:models/ProductOCC1 |
(static) ProductReference
The ProductReference model constructor.
Properties:
Type | Description |
---|---|
module:models/ProductReference |
(static) ProductReferenceList
The ProductReferenceList model constructor.
Properties:
Type | Description |
---|---|
module:models/ProductReferenceList |
(static) ProductReferenceOCC
The ProductReferenceOCC model constructor.
Properties:
Type | Description |
---|---|
module:models/ProductReferenceOCC |
(static) ProductsApi
The ProductsApi service constructor.
Properties:
Type | Description |
---|---|
module:api/ProductsApi |
(static) ProductSearchPage
The ProductSearchPage model constructor.
Properties:
Type | Description |
---|---|
module:models/ProductSearchPage |
(static) Promotion
The Promotion model constructor.
Properties:
Type | Description |
---|---|
module:models/Promotion |
(static) PromotionList
The PromotionList model constructor.
Properties:
Type | Description |
---|---|
module:models/PromotionList |
(static) PromotionOrderEntryConsumed
The PromotionOrderEntryConsumed model constructor.
Properties:
Type | Description |
---|---|
module:models/PromotionOrderEntryConsumed |
(static) PromotionRestriction
The PromotionRestriction model constructor.
Properties:
Type | Description |
---|---|
module:models/PromotionRestriction |
(static) PromotionResult
The PromotionResult model constructor.
Properties:
Type | Description |
---|---|
module:models/PromotionResult |
(static) PromotionResultList
The PromotionResultList model constructor.
Properties:
Type | Description |
---|---|
module:models/PromotionResultList |
(static) PromotionsApi
The PromotionsApi service constructor.
Properties:
Type | Description |
---|---|
module:api/PromotionsApi |
(static) Region
The Region model constructor.
Properties:
Type | Description |
---|---|
module:models/Region |
(static) RegionOCC
The RegionOCC model constructor.
Properties:
Type | Description |
---|---|
module:models/RegionOCC |
(static) Review
The Review model constructor.
Properties:
Type | Description |
---|---|
module:models/Review |
(static) ReviewList
The ReviewList model constructor.
Properties:
Type | Description |
---|---|
module:models/ReviewList |
(static) ReviewOCC
The ReviewOCC model constructor.
Properties:
Type | Description |
---|---|
module:models/ReviewOCC |
(static) SaveCartResult
The SaveCartResult model constructor.
Properties:
Type | Description |
---|---|
module:models/SaveCartResult |
(static) SearchQuery
The SearchQuery model constructor.
Properties:
Type | Description |
---|---|
module:models/SearchQuery |
(static) SearchState
The SearchState model constructor.
Properties:
Type | Description |
---|---|
module:models/SearchState |
(static) Sort
The Sort model constructor.
Properties:
Type | Description |
---|---|
module:models/Sort |
(static) SpecialOpeningDay
The SpecialOpeningDay model constructor.
Properties:
Type | Description |
---|---|
module:models/SpecialOpeningDay |
(static) SpellingSuggestion
The SpellingSuggestion model constructor.
Properties:
Type | Description |
---|---|
module:models/SpellingSuggestion |
(static) Stock
The Stock model constructor.
Properties:
Type | Description |
---|---|
module:models/Stock |
(static) StoreFinderSearchPage
The StoreFinderSearchPage model constructor.
Properties:
Type | Description |
---|---|
module:models/StoreFinderSearchPage |
(static) StoreFinderStockSearchPage
The StoreFinderStockSearchPage model constructor.
Properties:
Type | Description |
---|---|
module:models/StoreFinderStockSearchPage |
(static) StoresApi
The StoresApi service constructor.
Properties:
Type | Description |
---|---|
module:api/StoresApi |
(static) Suggestion
The Suggestion model constructor.
Properties:
Type | Description |
---|---|
module:models/Suggestion |
(static) SuggestionList
The SuggestionList model constructor.
Properties:
Type | Description |
---|---|
module:models/SuggestionList |
(static) Time
The Time model constructor.
Properties:
Type | Description |
---|---|
module:models/Time |
(static) Title
The Title model constructor.
Properties:
Type | Description |
---|---|
module:models/Title |
(static) TitleList
The TitleList model constructor.
Properties:
Type | Description |
---|---|
module:models/TitleList |
(static) TitlesApi
The TitlesApi service constructor.
Properties:
Type | Description |
---|---|
module:api/TitlesApi |
(static) User
The User model constructor.
Properties:
Type | Description |
---|---|
module:models/User |
(static) UserGroup
The UserGroup model constructor.
Properties:
Type | Description |
---|---|
module:models/UserGroup |
(static) UserGroupList
The UserGroupList model constructor.
Properties:
Type | Description |
---|---|
module:models/UserGroupList |
(static) UserGroupOCC
The UserGroupOCC model constructor.
Properties:
Type | Description |
---|---|
module:models/UserGroupOCC |
(static) UserOCC
The UserOCC model constructor.
Properties:
Type | Description |
---|---|
module:models/UserOCC |
(static) UsersApi
The UsersApi service constructor.
Properties:
Type | Description |
---|---|
module:api/UsersApi |
(static) UserSignUp
The UserSignUp model constructor.
Properties:
Type | Description |
---|---|
module:models/UserSignUp |
(static) VariantCategory
The VariantCategory model constructor.
Properties:
Type | Description |
---|---|
module:models/VariantCategory |
(static) VariantMatrixElement
The VariantMatrixElement model constructor.
Properties:
Type | Description |
---|---|
module:models/VariantMatrixElement |
(static) VariantOption
The VariantOption model constructor.
Properties:
Type | Description |
---|---|
module:models/VariantOption |
(static) VariantOptionQualifier
The VariantOptionQualifier model constructor.
Properties:
Type | Description |
---|---|
module:models/VariantOptionQualifier |
(static) VariantValueCategory
The VariantValueCategory model constructor.
Properties:
Type | Description |
---|---|
module:models/VariantValueCategory |
(static) Voucher
The Voucher model constructor.
Properties:
Type | Description |
---|---|
module:models/Voucher |
(static) VoucherList
The VoucherList model constructor.
Properties:
Type | Description |
---|---|
module:models/VoucherList |
(static) VouchersApi
The VouchersApi service constructor.
Properties:
Type | Description |
---|---|
module:api/VouchersApi |
(static) WeekdayOpeningDay
The WeekdayOpeningDay model constructor.
Properties:
Type | Description |
---|---|
module:models/WeekdayOpeningDay |