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 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.
...

Version:
  • v2
Source:

Members

(static) Address

The Address model constructor.

Properties:
Type Description
module:models/Address
Source:

(static) AddressList

The AddressList model constructor.

Properties:
Type Description
module:models/AddressList
Source:

(static) AddressOCC

The AddressOCC model constructor.

Properties:
Type Description
module:models/AddressOCC
Source:

(static) ApiClient

The ApiClient constructor.

Properties:
Type Description
module:ApiClient
Source:

(static) BaseOption

The BaseOption model constructor.

Properties:
Type Description
module:models/BaseOption
Source:

(static) BillingAddress

The BillingAddress model constructor.

Properties:
Type Description
module:models/BillingAddress
Source:

(static) Breadcrumb

The Breadcrumb model constructor.

Properties:
Type Description
module:models/Breadcrumb
Source:

(static) CardType

The CardType model constructor.

Properties:
Type Description
module:models/CardType
Source:

(static) CardTypeList

The CardTypeList model constructor.

Properties:
Type Description
module:models/CardTypeList
Source:

(static) CardtypesApi

The CardtypesApi service constructor.

Properties:
Type Description
module:api/CardtypesApi
Source:

(static) Cart

The Cart model constructor.

Properties:
Type Description
module:models/Cart
Source:

(static) CartList

The CartList model constructor.

Properties:
Type Description
module:models/CartList
Source:

(static) Catalog

The Catalog model constructor.

Properties:
Type Description
module:models/Catalog
Source:

(static) CatalogList

The CatalogList model constructor.

Properties:
Type Description
module:models/CatalogList
Source:

(static) CatalogsApi

The CatalogsApi service constructor.

Properties:
Type Description
module:api/CatalogsApi
Source:

(static) CatalogVersion

The CatalogVersion model constructor.

Properties:
Type Description
module:models/CatalogVersion
Source:

(static) Category

The Category model constructor.

Properties:
Type Description
module:models/Category
Source:

(static) CategoryHierarchy

The CategoryHierarchy model constructor.

Properties:
Type Description
module:models/CategoryHierarchy
Source:

(static) Classification

The Classification model constructor.

Properties:
Type Description
module:models/Classification
Source:

(static) Consignment

The Consignment model constructor.

Properties:
Type Description
module:models/Consignment
Source:

(static) ConsignmentEntry

The ConsignmentEntry model constructor.

Properties:
Type Description
module:models/ConsignmentEntry
Source:

(static) Country

The Country model constructor.

Properties:
Type Description
module:models/Country
Source:

(static) CountryList

The CountryList model constructor.

Properties:
Type Description
module:models/CountryList
Source:

(static) CountryOCC

The CountryOCC model constructor.

Properties:
Type Description
module:models/CountryOCC
Source:

(static) CurrenciesApi

The CurrenciesApi service constructor.

Properties:
Type Description
module:api/CurrenciesApi
Source:

(static) Currency

The Currency model constructor.

Properties:
Type Description
module:models/Currency
Source:

(static) CurrencyList

The CurrencyList model constructor.

Properties:
Type Description
module:models/CurrencyList
Source:

(static) CurrencyOCC

The CurrencyOCC model constructor.

Properties:
Type Description
module:models/CurrencyOCC
Source:

(static) CustomergroupsApi

The CustomergroupsApi service constructor.

Properties:
Type Description
module:api/CustomergroupsApi
Source:

(static) DeliverycountriesApi

The DeliverycountriesApi service constructor.

Properties:
Type Description
module:api/DeliverycountriesApi
Source:

(static) DeliveryMode

The DeliveryMode model constructor.

Properties:
Type Description
module:models/DeliveryMode
Source:

(static) DeliveryModeList

The DeliveryModeList model constructor.

Properties:
Type Description
module:models/DeliveryModeList
Source:

(static) DeliveryOrderEntryGroup

The DeliveryOrderEntryGroup model constructor.

Properties:
Type Description
module:models/DeliveryOrderEntryGroup
Source:

(static) DeliveryPointOfService

The DeliveryPointOfService model constructor.

Properties:
Type Description
module:models/DeliveryPointOfService
Source:

(static) ExportApi

The ExportApi service constructor.

Properties:
Type Description
module:api/ExportApi
Source:

(static) Facet

The Facet model constructor.

Properties:
Type Description
module:models/Facet
Source:

(static) FacetValue

The FacetValue model constructor.

Properties:
Type Description
module:models/FacetValue
Source:

(static) Feature

The Feature model constructor.

Properties:
Type Description
module:models/Feature
Source:

(static) FeatureUnit

The FeatureUnit model constructor.

Properties:
Type Description
module:models/FeatureUnit
Source:

(static) FeatureValue

The FeatureValue model constructor.

Properties:
Type Description
module:models/FeatureValue
Source:

(static) FeedsApi

The FeedsApi service constructor.

Properties:
Type Description
module:api/FeedsApi
Source:

(static) ForgottenpasswordtokensApi

The ForgottenpasswordtokensApi service constructor.

Properties:
Type Description
module:api/ForgottenpasswordtokensApi
Source:

(static) FutureStock

The FutureStock model constructor.

Properties:
Type Description
module:models/FutureStock
Source:

(static) GeoPoint

The GeoPoint model constructor.

Properties:
Type Description
module:models/GeoPoint
Source:

(static) Image

The Image model constructor.

Properties:
Type Description
module:models/Image
Source:

(static) Language

The Language model constructor.

Properties:
Type Description
module:models/Language
Source:

(static) LanguageList

The LanguageList model constructor.

Properties:
Type Description
module:models/LanguageList
Source:

(static) LanguageOCC

The LanguageOCC model constructor.

Properties:
Type Description
module:models/LanguageOCC
Source:

(static) LanguagesApi

The LanguagesApi service constructor.

Properties:
Type Description
module:api/LanguagesApi
Source:

(static) Member

The Member model constructor.

Properties:
Type Description
module:models/Member
Source:

(static) MemberList

The MemberList model constructor.

Properties:
Type Description
module:models/MemberList
Source:

(static) OpeningSchedule

The OpeningSchedule model constructor.

Properties:
Type Description
module:models/OpeningSchedule
Source:

(static) Order

The Order model constructor.

Properties:
Type Description
module:models/Order
Source:

(static) OrderEntry

The OrderEntry model constructor.

Properties:
Type Description
module:models/OrderEntry
Source:

(static) OrderEntryList

The OrderEntryList model constructor.

Properties:
Type Description
module:models/OrderEntryList
Source:

(static) OrderEntryOCC

The OrderEntryOCC model constructor.

Properties:
Type Description
module:models/OrderEntryOCC
Source:

(static) OrderHistory

The OrderHistory model constructor.

Properties:
Type Description
module:models/OrderHistory
Source:

(static) OrderHistoryList

The OrderHistoryList model constructor.

Properties:
Type Description
module:models/OrderHistoryList
Source:

(static) OrdersApi

The OrdersApi service constructor.

Properties:
Type Description
module:api/OrdersApi
Source:

(static) OrderStatusUpdateElement

The OrderStatusUpdateElement model constructor.

Properties:
Type Description
module:models/OrderStatusUpdateElement
Source:

(static) OrderStatusUpdateElementList

The OrderStatusUpdateElementList model constructor.

Properties:
Type Description
module:models/OrderStatusUpdateElementList
Source:

(static) Pagination

The Pagination model constructor.

Properties:
Type Description
module:models/Pagination
Source:

(static) PaymentDetails

The PaymentDetails model constructor.

Properties:
Type Description
module:models/PaymentDetails
Source:

(static) PaymentDetailsList

The PaymentDetailsList model constructor.

Properties:
Type Description
module:models/PaymentDetailsList
Source:

(static) PaymentDetailsOCC

The PaymentDetailsOCC model constructor.

Properties:
Type Description
module:models/PaymentDetailsOCC
Source:

(static) PickupOrderEntryGroup

The PickupOrderEntryGroup model constructor.

Properties:
Type Description
module:models/PickupOrderEntryGroup
Source:

(static) PointOfService

The PointOfService model constructor.

Properties:
Type Description
module:models/PointOfService
Source:

(static) PointOfServiceStock

The PointOfServiceStock model constructor.

Properties:
Type Description
module:models/PointOfServiceStock
Source:

(static) Price

The Price model constructor.

Properties:
Type Description
module:models/Price
Source:

(static) PriceRange

The PriceRange model constructor.

Properties:
Type Description
module:models/PriceRange
Source:

(static) Principal

The Principal model constructor.

Properties:
Type Description
module:models/Principal
Source:

(static) Product

The Product model constructor.

Properties:
Type Description
module:models/Product
Source:

(static) ProductExpressUpdateElement

The ProductExpressUpdateElement model constructor.

Properties:
Type Description
module:models/ProductExpressUpdateElement
Source:

(static) ProductExpressUpdateElementList

The ProductExpressUpdateElementList model constructor.

Properties:
Type Description
module:models/ProductExpressUpdateElementList
Source:

(static) ProductList

The ProductList model constructor.

Properties:
Type Description
module:models/ProductList
Source:

(static) ProductOCC

The ProductOCC model constructor.

Properties:
Type Description
module:models/ProductOCC
Source:

(static) ProductOCC1

The ProductOCC1 model constructor.

Properties:
Type Description
module:models/ProductOCC1
Source:

(static) ProductReference

The ProductReference model constructor.

Properties:
Type Description
module:models/ProductReference
Source:

(static) ProductReferenceList

The ProductReferenceList model constructor.

Properties:
Type Description
module:models/ProductReferenceList
Source:

(static) ProductReferenceOCC

The ProductReferenceOCC model constructor.

Properties:
Type Description
module:models/ProductReferenceOCC
Source:

(static) ProductsApi

The ProductsApi service constructor.

Properties:
Type Description
module:api/ProductsApi
Source:

(static) ProductSearchPage

The ProductSearchPage model constructor.

Properties:
Type Description
module:models/ProductSearchPage
Source:

(static) Promotion

The Promotion model constructor.

Properties:
Type Description
module:models/Promotion
Source:

(static) PromotionList

The PromotionList model constructor.

Properties:
Type Description
module:models/PromotionList
Source:

(static) PromotionOrderEntryConsumed

The PromotionOrderEntryConsumed model constructor.

Properties:
Type Description
module:models/PromotionOrderEntryConsumed
Source:

(static) PromotionRestriction

The PromotionRestriction model constructor.

Properties:
Type Description
module:models/PromotionRestriction
Source:

(static) PromotionResult

The PromotionResult model constructor.

Properties:
Type Description
module:models/PromotionResult
Source:

(static) PromotionResultList

The PromotionResultList model constructor.

Properties:
Type Description
module:models/PromotionResultList
Source:

(static) PromotionsApi

The PromotionsApi service constructor.

Properties:
Type Description
module:api/PromotionsApi
Source:

(static) Region

The Region model constructor.

Properties:
Type Description
module:models/Region
Source:

(static) RegionOCC

The RegionOCC model constructor.

Properties:
Type Description
module:models/RegionOCC
Source:

(static) Review

The Review model constructor.

Properties:
Type Description
module:models/Review
Source:

(static) ReviewList

The ReviewList model constructor.

Properties:
Type Description
module:models/ReviewList
Source:

(static) ReviewOCC

The ReviewOCC model constructor.

Properties:
Type Description
module:models/ReviewOCC
Source:

(static) SaveCartResult

The SaveCartResult model constructor.

Properties:
Type Description
module:models/SaveCartResult
Source:

(static) SearchQuery

The SearchQuery model constructor.

Properties:
Type Description
module:models/SearchQuery
Source:

(static) SearchState

The SearchState model constructor.

Properties:
Type Description
module:models/SearchState
Source:

(static) Sort

The Sort model constructor.

Properties:
Type Description
module:models/Sort
Source:

(static) SpecialOpeningDay

The SpecialOpeningDay model constructor.

Properties:
Type Description
module:models/SpecialOpeningDay
Source:

(static) SpellingSuggestion

The SpellingSuggestion model constructor.

Properties:
Type Description
module:models/SpellingSuggestion
Source:

(static) Stock

The Stock model constructor.

Properties:
Type Description
module:models/Stock
Source:

(static) StoreFinderSearchPage

The StoreFinderSearchPage model constructor.

Properties:
Type Description
module:models/StoreFinderSearchPage
Source:

(static) StoreFinderStockSearchPage

The StoreFinderStockSearchPage model constructor.

Properties:
Type Description
module:models/StoreFinderStockSearchPage
Source:

(static) StoresApi

The StoresApi service constructor.

Properties:
Type Description
module:api/StoresApi
Source:

(static) Suggestion

The Suggestion model constructor.

Properties:
Type Description
module:models/Suggestion
Source:

(static) SuggestionList

The SuggestionList model constructor.

Properties:
Type Description
module:models/SuggestionList
Source:

(static) Time

The Time model constructor.

Properties:
Type Description
module:models/Time
Source:

(static) Title

The Title model constructor.

Properties:
Type Description
module:models/Title
Source:

(static) TitleList

The TitleList model constructor.

Properties:
Type Description
module:models/TitleList
Source:

(static) TitlesApi

The TitlesApi service constructor.

Properties:
Type Description
module:api/TitlesApi
Source:

(static) User

The User model constructor.

Properties:
Type Description
module:models/User
Source:

(static) UserGroup

The UserGroup model constructor.

Properties:
Type Description
module:models/UserGroup
Source:

(static) UserGroupList

The UserGroupList model constructor.

Properties:
Type Description
module:models/UserGroupList
Source:

(static) UserGroupOCC

The UserGroupOCC model constructor.

Properties:
Type Description
module:models/UserGroupOCC
Source:

(static) UserOCC

The UserOCC model constructor.

Properties:
Type Description
module:models/UserOCC
Source:

(static) UsersApi

The UsersApi service constructor.

Properties:
Type Description
module:api/UsersApi
Source:

(static) UserSignUp

The UserSignUp model constructor.

Properties:
Type Description
module:models/UserSignUp
Source:

(static) VariantCategory

The VariantCategory model constructor.

Properties:
Type Description
module:models/VariantCategory
Source:

(static) VariantMatrixElement

The VariantMatrixElement model constructor.

Properties:
Type Description
module:models/VariantMatrixElement
Source:

(static) VariantOption

The VariantOption model constructor.

Properties:
Type Description
module:models/VariantOption
Source:

(static) VariantOptionQualifier

The VariantOptionQualifier model constructor.

Properties:
Type Description
module:models/VariantOptionQualifier
Source:

(static) VariantValueCategory

The VariantValueCategory model constructor.

Properties:
Type Description
module:models/VariantValueCategory
Source:

(static) Voucher

The Voucher model constructor.

Properties:
Type Description
module:models/Voucher
Source:

(static) VoucherList

The VoucherList model constructor.

Properties:
Type Description
module:models/VoucherList
Source:

(static) VouchersApi

The VouchersApi service constructor.

Properties:
Type Description
module:api/VouchersApi
Source:

(static) WeekdayOpeningDay

The WeekdayOpeningDay model constructor.

Properties:
Type Description
module:models/WeekdayOpeningDay
Source: