AtlasSDK is a global namespace.
\nAtlasSDK instance returned from AtlasSDK configure method.
\nBaseclass for Address model
\nBaseclass for CheckoutAddress model
\nBaseclass for NormalizedAddress model
\nBaseclass for CheckedAddress model
\nClass for Brand model.
\nClass for Partner model.
\nClass for Article Unit Price model.
\nClass for Article Unit model.
\nClass for Article Unit Attribute model.
\nClass for Article Unit EnrichmentAttribute model.
\nClass for TargetGroups model.
\nClass for ArticleImage model.
\nClass for Media model.
\nClass for CartItem model
\nClass for CartItem model
\nClass for Payment model
\nClass for Delivery model'
\nClass for ReviewRatingDistribution.
\nClass for ReviewRating.
\nClass for ReviewRecommendations.
\nClass for ReviewSummary.
\nClass for ReviewEntry.
\nClass for Article Reviews.
\nClass for Image model.
\nClass for Video model.
\nClass for Article model
\nClass for ArticleFamily model
\nClass for Discount model
\nClass for Checkout Discount model
\nClass for Delivery Request model
\nClass for Cart Request model
\nClass for Selected Payment model
\nClass for Payment model
\nClass for Checkout Coupon Details model
\nClass for Cart Response model
\nClass for Carts Response model
\nClass for Checkout Request model
\nClass for Checkout Response model
\nClass for Put Checkout Request model
\nClass for Checkout Order Request model
\nSalesChannel class struct
\nRecommendations class struct
\nConfig class struct
\nClass for Guest Customer model
\nClass for Guest Customer model
\nCart
\nClass for CreateOrderRequest model
\nClass for CreateOrderResponse model
\nClass for CreateOrderRedirectResponse model
\nClass for GetCheckoutResponse model
\nClass for Order Response model
\nClass for Checkout Order Response model
\nClass for Guest Customer model
\nClass for Recommended Article model
\nA temporary fix to handle the current high load capacity
\nPromiseCalls the given endpoint using fetch and intercepts the response\nvia various operations
\nPromise.<AtlasSDKClient>](#AtlasSDKClient)\nConfigure AtlasSDK. This is the main entry point to use the AtlasSDK.\n\n**Kind**: static method of [AtlasSDK](#module_AtlasSDK) \n**Returns**: [Promise.<AtlasSDKClient>](#AtlasSDKClient) - a promise resolving with an [AtlasSDKClient](#AtlasSDKClient) object \n**Access**: public \n\n| Param | Type | Description |\n| --- | --- | --- |\n| options | Object | An object containing configiration data: String\n * [.getLanguage()](#AtlasSDKClient+getLanguage) ⇒ String\n * [.getCountryCode()](#AtlasSDKClient+getCountryCode) ⇒ String\n * [.getConfig()](#AtlasSDKClient+getConfig) ⇒ Object\n * [.getArticle(sku, [options])](#AtlasSDKClient+getArticle) ⇒ [Article](#Article)\n * [.getArticles(skus, [options])](#AtlasSDKClient+getArticles) ⇒ [Array.<Article>](#Article)\n * [.getArticleFamilies(sku, [options])](#AtlasSDKClient+getArticleFamilies) ⇒ [Array.<ArticleFamily>](#ArticleFamily)\n * [.getGuestCheckout(checkoutId, token)](#AtlasSDKClient+getGuestCheckout) ⇒ [GetCheckoutResponse](#GetCheckoutResponse)\n * [.createGuestOrder(checkoutId, token)](#AtlasSDKClient+createGuestOrder) ⇒ [CreateOrderResponse](#CreateOrderResponse)\n * [.getRecommendations(sku, [options])](#AtlasSDKClient+getRecommendations) ⇒ [Array.<RecommendedArticle>](#RecommendedArticle)\n * [.createGuestCheckout(json)](#AtlasSDKClient+createGuestCheckout) ⇒ [CreateOrderRedirectResponse](#CreateOrderRedirectResponse)\n * [.getCheckoutCustomer(token)](#AtlasSDKClient+getCheckoutCustomer) ⇒ [CheckoutCustomer](#CheckoutCustomer)\n * [.getCheckoutAddresses(token)](#AtlasSDKClient+getCheckoutAddresses) ⇒ CheckoutAddress\n * [.getCheckoutCarts(token, headers)](#AtlasSDKClient+getCheckoutCarts) ⇒ [CartsResponse](#CartsResponse)\n * [.createCheckoutCart(json, token, options)](#AtlasSDKClient+createCheckoutCart) ⇒ [CartResponse](#CartResponse)\n * [.getCheckoutCart(cartId, token)](#AtlasSDKClient+getCheckoutCart) ⇒ [CartResponse](#CartResponse)\n * [.putCheckoutcart(json, cartId, token, headers)](#AtlasSDKClient+putCheckoutcart) ⇒ [CartResponse](#CartResponse)\n\n\n\n### new AtlasSDKClient(config)\nCreates an AtlasSDK instance from config provided by config-api\n\n\n| Param | Type | Description |\n| --- | --- | --- |\n| config | Object | config from config-api |\n\n\n\n### atlasSDKClient.getLocale() ⇒ String\nReturns locale based on sales channel, e.g. 'de_DE'\n\n**Kind**: instance method of [AtlasSDKClient](#AtlasSDKClient) \n**Returns**: String - locale \n\n\n### atlasSDKClient.getLanguage() ⇒ String\nReturns language based on sales channel, e.g. 'de'\n\n**Kind**: instance method of [AtlasSDKClient](#AtlasSDKClient) \n**Returns**: String - language \n\n\n### atlasSDKClient.getCountryCode() ⇒ String\nReturns country code based on sales channel, e.g. 'DE'\n\n**Kind**: instance method of [AtlasSDKClient](#AtlasSDKClient) \n**Returns**: String - country code \n\n\n### atlasSDKClient.getConfig() ⇒ Object\nReturns configuration from config-api\n\n**Kind**: instance method of [AtlasSDKClient](#AtlasSDKClient) \n**Returns**: Object - config \n\n\n### atlasSDKClient.getArticle(sku, [options]) ⇒ [Article](#Article)\nFetches an article based on a SKU.\n\n**Kind**: instance method of [AtlasSDKClient](#AtlasSDKClient) \n**Returns**: [Article](#Article) - return [Article](#Article) object \n**Access**: public \n\n| Param | Type | Description |\n| --- | --- | --- |\n| sku | String | SKU of an article |\n| [options] | Object | Configuration options: { media: { cdn: 'mosaic02', image_resolutions: ['thumbnail', 'medium'] } } |\n\n**Example** \n```js\nconst sdk = await AtlasSDK.configure({\n client_id: 'CLIENT_ID',\n sales_channel: 'SALES_CHANNEL',\n is_sandBox: true,\n lang: 'en'\n});\nconst article = await sdk.getArticle('AD112B0F6-A11', {\n media: {\n image_resolutions: ['thumbnail', 'medium']\n }\n});\n```\n\n\n### atlasSDKClient.getArticles(skus, [options]) ⇒ [Array.<Article>](#Article)\nFetches multiple articles based on SKUs.\n\n**Kind**: instance method of [AtlasSDKClient](#AtlasSDKClient) \n**Returns**: [Array.<Article>](#Article) - return [Article[]](Article[]) object \n**Access**: public \n\n| Param | Type | Description |\n| --- | --- | --- |\n| skus | String | comma separated SKUs of multiple articles |\n| [options] | Object | Configuration options: { media: { cdn: 'mosaic02', image_resolutions: ['thumbnail', 'medium'] } } |\n\n**Example** \n```js\nconst sdk = await AtlasSDK.configure({\n client_id: 'CLIENT_ID',\n sales_channel: 'SALES_CHANNEL',\n is_sandBox: true,\n lang: 'en'\n});\nconst articles = await sdk.getArticles('AD112B0F6-A11,SO254C009-K12', {\n media: {\n image_resolutions: ['thumbnail', 'medium']\n }\n});\n```\n\n\n### atlasSDKClient.getArticleFamilies(sku, [options]) ⇒ [Array.<ArticleFamily>](#ArticleFamily)\nFetches article families based on SKU.\n\n**Kind**: instance method of [AtlasSDKClient](#AtlasSDKClient) \n**Returns**: [Array.<ArticleFamily>](#ArticleFamily) - return [ArticleFamily[]](ArticleFamily[]) object \n**Access**: public \n\n| Param | Type | Description |\n| --- | --- | --- |\n| sku | String | SKU of an article |\n| [options] | Object | Configuration options: { media: { cdn: 'mosaic02', image_resolutions: ['thumbnail', 'medium'] } } |\n\n**Example** \n```js\nconst sdk = await AtlasSDK.configure({\n client_id: 'CLIENT_ID',\n sales_channel: 'SALES_CHANNEL',\n is_sandBox: true,\n lang: 'en'\n});\nconst article = await sdk.getArticleFamilies('AD112B0F6-A11');\n```\n\n\n### atlasSDKClient.getGuestCheckout(checkoutId, token) ⇒ [GetCheckoutResponse](#GetCheckoutResponse)\nReturns the complete details of the checkout: guest checkout object [GetCheckoutResponse](#GetCheckoutResponse) created using [createGuestCheckout](#AtlasSDKClient+createGuestCheckout).\nParameters checkoutId, token should be fetched from redirect URL after payment.\n\n**Kind**: instance method of [AtlasSDKClient](#AtlasSDKClient) \n**Returns**: [GetCheckoutResponse](#GetCheckoutResponse) - guest checkout object \n**Access**: public \n\n| Param | Type | Description |\n| --- | --- | --- |\n| checkoutId | String | Id of guest checkout object |\n| token | String | Token for checkout completion. |\n\n\n\n### atlasSDKClient.createGuestOrder(checkoutId, token) ⇒ [CreateOrderResponse](#CreateOrderResponse)\nCreates an order for the guest chekout object based on checkoutId, token.\n\n**Kind**: instance method of [AtlasSDKClient](#AtlasSDKClient) \n**Returns**: [CreateOrderResponse](#CreateOrderResponse) - object with order information \n**Access**: public \n\n| Param | Type | Description |\n| --- | --- | --- |\n| checkoutId | String | Id of guest checkout object |\n| token | String | |\n\n\n\n### atlasSDKClient.getRecommendations(sku, [options]) ⇒ [Array.<RecommendedArticle>](#RecommendedArticle)\nFetches recommendations for an article based on a SKU.\n\n**Kind**: instance method of [AtlasSDKClient](#AtlasSDKClient) \n**Returns**: [Array.<RecommendedArticle>](#RecommendedArticle) - return array of [RecommendedArticle[]](RecommendedArticle[]) objects \n**Access**: public \n\n| Param | Type | Description |\n| --- | --- | --- |\n| sku | String | SKU of an article |\n| [options] | Object | Configuration options: { '-filter_gender': 'FEMALE', 'brand_code': ['AN1', 'N12', 'PU1'], } { reco_id: 'UUUID', tracking_string: 'SOME_TRACKING_STRING', reco_location: 'some_reco_location', media: { cdn: 'mosaic02', image_resolutions: ['thumbnail', 'medium'] }, filters: { '-filter_gender': 'FEMALE' 'brand_code': ['AN1', 'N12', 'PU1'], } } |\n\n**Example** \n```js\nconst sdk = await AtlasSDK.configure({\n client_id: 'CLIENT_ID',\n sales_channel: 'SALES_CHANNEL',\n is_sandBox: true\n});\nconst recos = await sdk.getRecommendations('AD112B0F6-A11', {\n reco_id: 'UUID',\n tracking_string: 'TRACK',\n media: {\n cdn: 'mosaic02',\n image_resolutions: ['thumbnail', 'medium']\n },\n filters: {\n '-filter_gender': 'FEMALE'\n 'brand_code': ['AN1', 'N12', 'PU1'],\n }\n});\n```\n\n\n### atlasSDKClient.createGuestCheckout(json) ⇒ [CreateOrderRedirectResponse](#CreateOrderRedirectResponse)\nCreates guest checkout object with payload.\n\n**Kind**: instance method of [AtlasSDKClient](#AtlasSDKClient) \n**Returns**: [CreateOrderRedirectResponse](#CreateOrderRedirectResponse) - response containing redirectURL\nthat should be used to go to the payment. \n**Access**: public \n\n| Param | Type | Description |\n| --- | --- | --- |\n| json | Object | JSON payload |\n\n\n\n### atlasSDKClient.getCheckoutCustomer(token) ⇒ [CheckoutCustomer](#CheckoutCustomer)\nReturns customer object [CheckoutCustomer](#CheckoutCustomer).\nParameters customer token needed to fetch customer object.\n\n**Kind**: instance method of [AtlasSDKClient](#AtlasSDKClient) \n**Returns**: [CheckoutCustomer](#CheckoutCustomer) - customer object \n**Access**: public \n\n| Param | Type | Description |\n| --- | --- | --- |\n| token | String | customer OAuth2 token |\n\n\n\n### atlasSDKClient.getCheckoutAddresses(token) ⇒ CheckoutAddress\nReturns customer addresses [CheckoutAddress](CheckoutAddress).\nParameters customer token needed to fetch customer object.\n\n**Kind**: instance method of [AtlasSDKClient](#AtlasSDKClient) \n**Returns**: CheckoutAddress - CheckoutAddress array \n**Access**: public \n\n| Param | Type | Description |\n| --- | --- | --- |\n| token | String | customer OAuth2 token |\n\n\n\n### atlasSDKClient.getCheckoutCarts(token, headers) ⇒ [CartsResponse](#CartsResponse)\nReturns a customer's cart(s)\n\n**Kind**: instance method of [AtlasSDKClient](#AtlasSDKClient) \n**Returns**: [CartsResponse](#CartsResponse) - - carts \n\n| Param | Type | Description |\n| --- | --- | --- |\n| token | String | |\n| headers | Object | additional headers that will override the default ones |\n\n\n\n### atlasSDKClient.createCheckoutCart(json, token, options) ⇒ [CartResponse](#CartResponse)\nCreates Zalando customer cart\n\n**Kind**: instance method of [AtlasSDKClient](#AtlasSDKClient) \n**Returns**: [CartResponse](#CartResponse) - - customer cart \n\n| Param | Type | Description |\n| --- | --- | --- |\n| json | [CreateCartRequest](#CreateCartRequest) | cart to create |\n| token | String | customer OAuth2 token |\n| options | Object | additional headers, rawResponse that will override the default ones |\n\n\n\n### atlasSDKClient.getCheckoutCart(cartId, token) ⇒ [CartResponse](#CartResponse)\nReturns a cart by id\n\n**Kind**: instance method of [AtlasSDKClient](#AtlasSDKClient) \n**Returns**: [CartResponse](#CartResponse) - - cart \n\n| Param | Type | Description |\n| --- | --- | --- |\n| cartId | String | cart ID to get |\n| token | String | |\n\n\n\n### atlasSDKClient.putCheckoutcart(json, cartId, token, headers) ⇒ [CartResponse](#CartResponse)\nUpdates existing cart by id\n\n**Kind**: instance method of [AtlasSDKClient](#AtlasSDKClient) \n**Returns**: [CartResponse](#CartResponse) - - updated cart \n\n| Param | Type | Description |\n| --- | --- | --- |\n| json | [CreateCartRequest](#CreateCartRequest) | cart object to update a cart with |\n| cartId | String | id of the cart to be updated |\n| token | String | |\n| headers | Object | additional headers that will override the default ones |\n\n\n\n## PickupPoint\n**Kind**: global class \n\n\n### new PickupPoint(name, id, memberId)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| name | String | name of the pick up point |\n| id | String | id of the pickup point |\n| memberId | String | member id of the pickpup point |\n\n\n\n## AddressSchema\nBaseclass for Address model\n\n**Kind**: global class \n\n\n### new AddressSchema(email, gender, firstName, lastName, street, zip, city, countryCode, pickupPoint)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| email | String | email of a customer. |\n| gender | String | gender of the customer (FEMALE / MALE) |\n| firstName | String | first name of the customer |\n| lastName | String | last name of the customer |\n| street | String | street of the address |\n| zip | String | zip code of the address |\n| city | String | city of the address |\n| countryCode | String | country of the address |\n| pickupPoint | [PickupPoint](#PickupPoint) | pickup point of the address (Optional because only valid in shipping addresses) |\n\n\n\n## CheckoutAddressSchema\nBaseclass for CheckoutAddress model\n\n**Kind**: global class \n\n\n### new CheckoutAddressSchema(customerNumber, email, gender, firstName, lastName, street, zip, city, countryCode, pickupPoint, defaultBilling, defaultShipping)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| customerNumber | String | customer number |\n| email | String | email of a customer. |\n| gender | String | gender of the customer (FEMALE / MALE) |\n| firstName | String | first name of the customer |\n| lastName | String | last name of the customer |\n| street | String | street of the address |\n| zip | String | zip code of the address |\n| city | String | city of the address |\n| countryCode | String | country of the address |\n| pickupPoint | [PickupPoint](#PickupPoint) | pickup point of the address (Optional because only valid in shipping addresses) |\n| defaultBilling | Boolean | is this address the default billing address |\n| defaultShipping | Boolean | is this address the default shipping address |\n\n\n\n## NormalizedAddress\nBaseclass for NormalizedAddress model\n\n**Kind**: global class \n\n\n### new NormalizedAddress(street, zip, city, countryCode)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| street | String | street of the address |\n| zip | String | zip code of the address |\n| city | String | city of the address |\n| countryCode | String | country of the address |\n\n\n\n## CheckedAddress\nBaseclass for CheckedAddress model\n\n**Kind**: global class \n\n\n### new CheckedAddress(status, normalizedAddress)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| status | String | status of the address check |\n| normalizedAddress | [NormalizedAddress](#NormalizedAddress) | the normalized address |\n\n\n\n## Brand\nClass for Brand model.\n\n**Kind**: global class \n\n\n### new Brand(name)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| name | String | name of brand. |\n\n\n\n## Partner\nClass for Partner model.\n\n**Kind**: global class \n\n\n### new Partner(id, name, detailURL)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| id | String | id of partner. |\n| name | String | name of partner. |\n| detailURL | String | URL of partner. |\n\n\n\n## PriceSchema\nClass for Article Unit Price model.\n\n**Kind**: global class \n\n\n### new PriceSchema(amount, currency)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| amount | number | amount of price. |\n| currency | String | currency of price. |\n\n\n\n## Unit\nClass for Article Unit model.\n\n**Kind**: global class \n\n\n### new Unit(id, size, price, originalPrice, available, stock, partner, media)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| id | String | id of article. |\n| size | String | size of article. |\n| price | Price | price of article. |\n| originalPrice | Price | price of article. |\n| available | boolean | whether the unit is available or not. |\n| stock | number | |\n| partner | [Partner](#Partner) | |\n| media | [Media](#Media) | |\n\n\n\n## Attribute\nClass for Article Unit Attribute model.\n\n**Kind**: global class \n\n\n### new Attribute(name, category, subCategory, values)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| name | String | name of attribute. |\n| category | String | category of attribute. |\n| subCategory | String | sub-category of attribute. |\n| values | Array.<String> | values of attribute. |\n\n\n\n## EnrichmentAttribute\nClass for Article Unit EnrichmentAttribute model.\n\n**Kind**: global class \n\n\n### new EnrichmentAttribute(key, value)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| key | String | name of enrichment attribute. |\n| value | Array.<String> | values of enrichment attribute. |\n\n\n\n## TargetGroups\nClass for TargetGroups model.\n\n**Kind**: global class \n\n\n### new TargetGroups(gender, age, domain, ageRange)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| gender | Array.<String> | The targeted gender group. Can be FEMALE or MALE. Unisex articles will have both. |\n| age | Array.<String> | The targeted age group. Current values are: ADULT, BABY, KID, TEEN |\n| domain | Array.<String> | The target domain. Can be: DEFAULT, GREEN, LIFESTYLE, MATERNITY, PREMIUM, OVERSIZE, SPORTS |\n| ageRange | Array.<String> | Current values: Under 20, 20-29, 30-39, 40-49, Over 50 |\n\n\n\n## ArticleImage\nClass for ArticleImage model.\n\n**Kind**: global class \n\n\n### new ArticleImage(order, catalog, catalogHD, detail, detailHD, large, largeHD)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| order | Number | order number of image used for sorting. |\n| catalog | String | URL of catalog image. |\n| catalogHD | String | URL of HD catalog image. |\n| detail | String | URL of details image. |\n| detailHD | String | URL of HD details image. |\n| large | String | URL of large image. |\n| largeHD | String | URL of HD large image. |\n\n\n\n## Media\nClass for Media model.\n\n**Kind**: global class \n\n\n### new Media(images)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| images | [ArticleImage](#ArticleImage) | array of images. |\n\n\n\n## Item\nClass for CartItem model\n\n**Kind**: global class \n\n\n### new Item(sku, quantity)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| sku | String | SKU of item. |\n| quantity | Number | Quantity of item. |\n\n\n\n## ItemWithPrice\nClass for CartItem model\n\n**Kind**: global class \n\n\n### new ItemWithPrice(sku, configSku, quantity, price)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| sku | String | SKU of item. |\n| configSku | String | Config SKU of the item. |\n| quantity | Number | Quantity of item. |\n| price | Price | pirce of the item |\n\n\n\n## Payment\nClass for Payment model\n\n**Kind**: global class \n\n* [Payment](#Payment)\n * [new Payment(method, selectionPageUrl, metadata)](#new_Payment_new)\n * [new Payment(selected, selectionPageUrl)](#new_Payment_new)\n\n\n\n### new Payment(method, selectionPageUrl, metadata)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| method | String | Payment Method type. |\n| selectionPageUrl | String | URL of the payment selection page. |\n| metadata | Object | Metadata for payment. |\n\n\n\n### new Payment(selected, selectionPageUrl)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| selected | [SelectedPayment](#SelectedPayment) | the selected payment. |\n| selectionPageUrl | String | URL of the payment selection page. |\n\n\n\n## Delivery\nClass for Delivery model'\n\n**Kind**: global class \n\n\n### new Delivery(service, cost, earliest, latest, options)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| service | String | the delivery service. |\n| cost | Price | the delivery cost. |\n| earliest | String | Delivery earliest date. |\n| latest | String | Delivery latest date. |\n| options | Array.<String> | the delivery options. |\n\n\n\n## ReviewRatingDistribution\nClass for ReviewRatingDistribution.\n\n**Kind**: global class \n\n\n### new ReviewRatingDistribution(count)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| level. | String | |\n| count | Number | count of reviews distribution. |\n\n\n\n## ReviewRating\nClass for ReviewRating.\n\n**Kind**: global class \n\n\n### new ReviewRating(average, distribution)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| average | Number | average rating of Article reviews. |\n| distribution | [ReviewRatingDistribution](#ReviewRatingDistribution) | distribution of reviews. |\n\n\n\n## ReviewRecommendations\nClass for ReviewRecommendations.\n\n**Kind**: global class \n\n\n### new ReviewRecommendations(total, positive)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| total | Number | total number of Article reviews. |\n| positive | Number | number of positive reviews. |\n\n\n\n## ReviewSummary\nClass for ReviewSummary.\n\n**Kind**: global class \n\n\n### new ReviewSummary(total, rating, recommendations)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| total | Number | total number of Article reviews. |\n| rating | [ReviewRating](#ReviewRating) | average rating of Article review. |\n| recommendations | [ReviewRecommendations](#ReviewRecommendations) | recommendations of Article review. |\n\n\n\n## ReviewEntry\nClass for ReviewEntry.\n\n**Kind**: global class \n\n\n### new ReviewEntry(name, title, description, rating, recommends, created)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| name | String | name of Article reviewer. |\n| title | String | title of Article review. |\n| description | String | description of Article review. |\n| rating | Number | rating of Article review. |\n| recommends | Boolean | boolean if the reviewer recommends or not. |\n| created | String | created timestamp of Article review. |\n\n\n\n## Reviews\nClass for Article Reviews.\n\n**Kind**: global class \n\n\n### new Reviews(summary, entries)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| summary | [ReviewSummary](#ReviewSummary) | summary of Article review. |\n| entries | [Array.<ReviewEntry>](#ReviewEntry) | entries of Article review. |\n\n\n\n## Image\nClass for Image model.\n\n**Kind**: global class \n\n\n### new Image(type, mediaCharacter, resolutions)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| type | String | Type of the media item, e.g. 'IMAGE', 'IMAGE_360' |\n| mediaCharacter | String | Media Character descriptor with meta information about image, for example 'MODEL' image that indicates that this media item contains model image URL. |\n| resolutions | Object | Requested resolutions of the media item. |\n\n\n\n## Video\nClass for Video model.\n\n**Kind**: global class \n\n\n### new Video(type, mediaCharacter, url)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| type | String | Type of the media item, e.g. 'VIDEO', 'VIDEO_HD', 'VIDEO_THUMBNAIL', 'VIDEO_SMALL' |\n| mediaCharacter | String | Media Character descriptor with meta information about video, for example 'MODEL' image that indicates that this media item contains model image URL. |\n| url | String | An absolute URL to the image |\n\n\n\n## Article\nClass for Article model\n\n**Kind**: global class \n\n\n### new Article(id, name, color, silhouetteCode, supplierColor, productGroup, detailUrl, brand, units, images, videos, attributes, enrichmentAttributes, targetGroups, infos, review)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| id | String | id of the article. |\n| name | String | name of the article. |\n| color | String | color of the article. |\n| silhouetteCode | String | silhouette code of the article. |\n| supplierColor | String | color of the article from supplier. |\n| productGroup | String | product group of the article. |\n| detailUrl | String | product detail url of the article. |\n| brand | [Brand](#Brand) | brand of the article. |\n| units | [Array.<Unit>](#Unit) | size, price and stock availability from the article. |\n| images | [Array.<Image>](#Image) | Array of article images. |\n| videos | [Array.<Video>](#Video) | Array of article videos. |\n| attributes | [Array.<Attribute>](#Attribute) | characteristics of the article. |\n| enrichmentAttributes | Array.<EnrichmentAttributes> | variable generic attributes. |\n| targetGroups | [TargetGroups](#TargetGroups) | the targeted groups of the article. |\n| infos | Array.<String> | generic article description. |\n| review | [Array.<Reviews>](#Reviews) | article reviews. |\n\n\n\n## ArticleFamily\nClass for ArticleFamily model\n\n**Kind**: global class \n\n\n### new ArticleFamily(id, color, supplierColor, lowestPrice, images)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| id | String | id of the article. |\n| color | String | color of the article. |\n| supplierColor | String | color of the article from supplier. |\n| lowestPrice | Price | lowestPrice of article. |\n| images | [Array.<Image>](#Image) | Array of article images. |\n\n\n\n## DiscountSchema\nClass for Discount model\n\n**Kind**: global class \n\n\n### new DiscountSchema(grossTotal, taxTotal)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| grossTotal | Price | gross total of the discount. |\n| taxTotal | Price | tax total of the discount. |\n\n\n\n## CheckoutCouponDiscount\nClass for Checkout Discount model\n\n**Kind**: global class \n\n\n### new CheckoutCouponDiscount(remaining, gross, tax)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| remaining | Price | remaining amount. |\n| gross | Price | gross total of the discount. |\n| tax | Price | tax total of the discount. |\n\n\n\n## DeliveryRequest\nClass for Delivery Request model\n\n**Kind**: global class \n\n\n### new DeliveryRequest(service)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| service | String | the delivery service. |\n\n\n\n## CreateCartRequest\nClass for Cart Request model\n\n**Kind**: global class \n\n\n### new CreateCartRequest(items)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| items | Items | a list of items. |\n\n\n\n## SelectedPayment\nClass for Selected Payment model\n\n**Kind**: global class \n\n\n### new SelectedPayment(method, metadata, externalPayment)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| method | String | Payment Method type. |\n| metadata | Object | Metadata for payment. |\n| externalPayment | Boolean | is an external payment provider used. |\n\n\n\n## Payment\nClass for Payment model\n\n**Kind**: global class \n\n* [Payment](#Payment)\n * [new Payment(method, selectionPageUrl, metadata)](#new_Payment_new)\n * [new Payment(selected, selectionPageUrl)](#new_Payment_new)\n\n\n\n### new Payment(method, selectionPageUrl, metadata)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| method | String | Payment Method type. |\n| selectionPageUrl | String | URL of the payment selection page. |\n| metadata | Object | Metadata for payment. |\n\n\n\n### new Payment(selected, selectionPageUrl)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| selected | [SelectedPayment](#SelectedPayment) | the selected payment. |\n| selectionPageUrl | String | URL of the payment selection page. |\n\n\n\n## CheckoutCouponDetails\nClass for Checkout Coupon Details model\n\n**Kind**: global class \n\n\n### new CheckoutCouponDetails(coupon, warning, error, discount)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| coupon | String | the coupon. |\n| warning | String | warnings regardings coupons. |\n| error | String | errors regardings coupons. |\n| discount | [CheckoutCouponDiscount](#CheckoutCouponDiscount) | the discount. |\n\n\n\n## CartResponse\nClass for Cart Response model\n\n**Kind**: global class \n\n\n### new CartResponse(id, items, itemsOutOfStock, delivery, grossTotal, taxTotal, totalDiscount)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| id | String | the response id. |\n| items | [ItemWithPrice](#ItemWithPrice) | the items with price. |\n| itemsOutOfStock | String | a list of items that are out of stock. |\n| delivery | [Delivery](#Delivery) | the delivery information. |\n| grossTotal | Price | the gross total. |\n| taxTotal | Price | the tax total. |\n| totalDiscount | [DiscountSchema](#DiscountSchema) | the total discount. |\n\n\n\n## CartsResponse\nClass for Carts Response model\n\n**Kind**: global class \n\n\n### new CartsResponse(id, carts)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| id | String | the response id. |\n| carts | [Array.<CartResponse>](#CartResponse) | the requested carts. |\n\n\n\n## CreateCheckoutRequest\nClass for Checkout Request model\n\n**Kind**: global class \n\n\n### new CreateCheckoutRequest(id, billingAddressId, billingAddress, shippingAddressId, shippingAddress, delivery, coupons)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| id | String | the cart id. |\n| billingAddressId | String | the id of the billing address. |\n| billingAddress | Address | the billing address. |\n| shippingAddressId | String | the id of the shipping address. |\n| shippingAddress | Address | the shipping address. |\n| delivery | [DeliveryRequest](#DeliveryRequest) | the desired delivery type. |\n| coupons | String | a coupon. |\n\n\n\n## CheckoutResponse\nClass for Checkout Response model\n\n**Kind**: global class \n\n\n### new CheckoutResponse(id, customerNumber, cartId, billingAddress, shippingAddress, delivery, couponDetails, payment)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| id | String | the response id. |\n| customerNumber | String | the customer number. |\n| cartId | String | the id of the cart id. |\n| billingAddress | Address | the billing address. |\n| shippingAddress | Address | the shipping address. |\n| delivery | [Delivery](#Delivery) | the delivery information. |\n| couponDetails | [CheckoutCouponDetails](#CheckoutCouponDetails) | the coupon details. |\n| payment | [Payment](#Payment) | the payment selection. |\n\n\n\n## PutCheckoutRequest\nClass for Put Checkout Request model\n\n**Kind**: global class \n\n\n### new PutCheckoutRequest(billingAddressId, billingAddress, shippingAddressId, shippingAddress, delivery, coupons)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| billingAddressId | String | the id of the billing address. |\n| billingAddress | Address | the billing address. |\n| shippingAddressId | String | the id of the shipping address. |\n| shippingAddress | Address | the shipping address. |\n| delivery | [DeliveryRequest](#DeliveryRequest) | the desired delivery type. |\n| coupons | String | a coupon. |\n\n\n\n## CheckoutOrderRequest\nClass for Checkout Order Request model\n\n**Kind**: global class \n\n\n### new CheckoutOrderRequest(checkoutId)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| checkoutId | String | the id of the checkout. |\n\n\n\n## SalesChannel\nSalesChannel class struct\n\n**Kind**: global class \n\n\n### new SalesChannel(source)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| source | Object | Initialisation object for SalesChannel |\n\n\n\n## Recommendations\nRecommendations class struct\n\n**Kind**: global class \n\n\n### new Recommendations(source)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| source | Object | Initialisation object for Recommendations |\n\n\n\n## Config\nConfig class struct\n\n**Kind**: global class \n\n\n### new Config(source)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| source | Object | Initialisation object for Config |\n\n**Example** \n```js\nconst source = {\n catalog_api_url: 'https://catalog_api.com/api',\n checkout_api_url: 'https://checkout_api.com/api',\n oauth2_provider_url: 'https://oauth2_provider.com/api',\n sales_channel: {\n locale: 'de_DE',\n channel: '11111111-1111-1111-1111-111111111111',\n toc_url: 'https://m.zalando.de/agb/'\n },\n recommendations: {\n location: 'my_app_pdp',\n type: 'similar',\n channel: 'myapp'\n }\n};\n\nconst config = new Config(source);\n```\n\n\n## GuestCustomer\nClass for Guest Customer model\n\n**Kind**: global class \n\n\n### new GuestCustomer(email, subscribeNewsletter)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| email | String | the id of the billing address. |\n| subscribeNewsletter | Boolean | subscribe to the newsletter. |\n\n\n\n## CheckoutCustomer\nClass for Guest Customer model\n\n**Kind**: global class \n\n\n### new CheckoutCustomer(customerNumber, customerHash, gender, firstName, lastName, email)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| customerNumber | String | the customer number. |\n| customerHash | String | the customer hash. |\n| gender | String | the gender. |\n| firstName | String | the first name. |\n| lastName | String | the last name. |\n| email | String | the email address. |\n\n\n\n## Cart\nCart\n\n**Kind**: global class \n\n\n### new Cart(items, itemsOutOfStock, grossTotal, taxTotal)\nClass for Cart model\n\n\n| Param | Type | Description |\n| --- | --- | --- |\n| items | [Array.<Item>](#Item) | Array of CartItem. |\n| itemsOutOfStock | Array.<String> | Array of simple SKUs for CartItems which are out of stock. |\n| grossTotal | Price | Gross Total Price. |\n| taxTotal | Price | Tax Total Price. |\n\n\n\n## CreateOrderRequest\nClass for CreateOrderRequest model\n\n**Kind**: global class \n\n\n### new CreateOrderRequest(customer, billingAddress, shippingAddress, cart, payment)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| customer | Customer | Customer object. |\n| billingAddress | Address | Billing GuestAddress of Order. |\n| shippingAddress | Address | Shipping GuestAddress of Order. |\n| cart | [Cart](#Cart) | Cart of Order. |\n| payment | [Payment](#Payment) | Payment of Order. |\n\n\n\n## CreateOrderResponse\nClass for CreateOrderResponse model\n\n**Kind**: global class \n\n\n### new CreateOrderResponse(orderNumber, customerNumber, billingAddress, shippingAddress, grossTotal, taxTotal, created, externalPaymentURL)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| orderNumber | String | Order Number. |\n| customerNumber | String | Customer Number. |\n| billingAddress | Address | Billing GuestAddress of Order. |\n| shippingAddress | Address | Shipping GuestAddress of Order. |\n| grossTotal | Price | Gross Total Price. |\n| taxTotal | Price | Tax Total Price. |\n| created | String | Date/Time when the order was created. |\n| externalPaymentURL | String | URL of Payment. |\n\n\n\n## CreateOrderRedirectResponse\nClass for CreateOrderRedirectResponse model\n\n**Kind**: global class \n\n\n### new CreateOrderRedirectResponse(url)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| url | String | Redirect URL. |\n\n\n\n## GetCheckoutResponse\nClass for GetCheckoutResponse model\n\n**Kind**: global class \n\n\n### new GetCheckoutResponse(cart, billingAddress, shippingAddress, payment, delivery)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| cart | [Cart](#Cart) | Cart of Order. |\n| billingAddress | Address | Billing GuestAddress of Order. |\n| shippingAddress | Address | Shipping GuestAddress of Order. |\n| payment | [Payment](#Payment) | Payment of Order. |\n| delivery | [Delivery](#Delivery) | the delivery information. |\n\n\n\n## OrderResponse\nClass for Order Response model\n\n**Kind**: global class \n\n\n### new OrderResponse(orderNumber, billingAddress, shippingAddress, grossTotal, taxTotal, created, externalPaymentURL)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| orderNumber | String | the order number. |\n| billingAddress | Address | the billing address. |\n| shippingAddress | Address | the shipping address. |\n| grossTotal | Price | gross total of the discount. |\n| taxTotal | Price | tax total of the discount. |\n| created | String | creation date. |\n| externalPaymentURL | String | the payment URL. |\n\n\n\n## CheckoutApiOrderResponseSchema\nClass for Checkout Order Response model\n\n**Kind**: global class \n\n\n### new CheckoutApiOrderResponseSchema(customerNumber, orderNumber, billingAddress, shippingAddress, grossTotal, taxTotal, created, externalPaymentURL)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| customerNumber | String | the customer number. |\n| orderNumber | String | the order number. |\n| billingAddress | Address | the billing address. |\n| shippingAddress | Address | the shipping address. |\n| grossTotal | Price | gross total of the discount. |\n| taxTotal | Price | tax total of the discount. |\n| created | String | creation date. |\n| externalPaymentURL | String | the payment URL. |\n\n\n\n## CheckoutOrder\nClass for Guest Customer model\n\n**Kind**: global class \n\n\n### new CheckoutOrder(orderNumber, customerNumber, grossTotal, created, detailUrl)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| orderNumber | String | the order number. |\n| customerNumber | String | the customer number. |\n| grossTotal | Price | gross total of the discount. |\n| created | String | creation date. |\n| detailUrl | String | the details URL. |\n\n\n\n## RecommendedArticle\nClass for Recommended Article model\n\n**Kind**: global class \n\n\n### new RecommendedArticle(id, tracking_string, name, lowestPrice, brand, images, videos, units)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| id | String | id of article. |\n| tracking_string | String | the tracking string to help with recommendations |\n| name | String | name of article. |\n| lowestPrice | Price | lowestPrice of article. |\n| brand | [Brand](#Brand) | brand of article. |\n| images | [Array.<Image>](#Image) | Array of article images. |\n| videos | [Array.<Video>](#Video) | Array of article videos. |\n| units | [Array.<Unit>](#Unit) | Array of article units. |\n\n\n\n## configCache\nA temporary fix to handle the current high load capacity\n\n**Kind**: global constant \n\n\n## fetchEndpoint(endpoint) ⇒ Promise\nCalls the given endpoint using fetch and intercepts the response\nvia various operations\n\n**Kind**: global function \n**Returns**: Promise - Promise after resolving or rejecting the request. \n\n| Param | Type | Description |\n| --- | --- | --- |\n| endpoint | Object | endpoint object. |\n\n\n## Contact\n\nFor any inquiry, please contact Team Atlas via team-atlas@zalando.de\n\n## LICENSE\n\nThe MIT License (MIT) Copyright © 2016 Zalando SE, https://tech.zalando.com\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the “Software”), to deal in\nthe Software without restriction, including without limitation the rights to\nuse, copy, modify, merge, publish, distribute, sublicense, and/or sell copies\nof the Software, and to permit persons to whom the Software is furnished to do\nso, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","maintainers":[{"name":"ahmed-shehata","email":"ahmed.shehata92@outlook.com"},{"name":"artdaw","email":"gleb.galkin@zalando.de"},{"name":"ricardomatias","email":"ricardo.matias0@gmail.com"}],"time":{"modified":"2022-06-13T03:40:28.881Z","created":"2016-11-15T16:03:52.717Z","1.0.0-alpha":"2016-11-15T16:03:52.717Z","1.0.0":"2016-11-23T10:09:18.749Z","1.1.0":"2016-11-23T12:48:38.631Z","1.1.1":"2016-12-06T16:36:05.288Z","1.1.2":"2016-12-07T18:43:51.721Z","1.1.3":"2016-12-15T14:44:53.812Z","1.1.4":"2017-01-10T16:35:51.943Z","1.2.0":"2017-01-11T11:27:21.427Z","1.2.1":"2017-01-12T17:26:43.760Z","1.3.0":"2017-01-25T16:29:18.657Z","1.3.1":"2017-02-10T13:10:29.155Z","1.4.0":"2017-02-23T16:56:52.288Z","1.4.1":"2017-02-28T12:05:10.730Z","1.4.2":"2017-03-06T14:37:08.727Z","1.5.0":"2017-03-07T14:49:40.391Z","1.6.0":"2017-03-07T18:09:12.433Z","1.6.1":"2017-03-09T11:25:47.600Z","1.6.2":"2017-03-29T11:59:42.824Z","1.6.3":"2017-03-30T10:58:22.440Z","1.6.4":"2017-05-29T14:40:42.189Z","2.0.0":"2017-06-09T08:20:38.477Z","2.0.1":"2017-06-09T10:34:37.895Z","3.0.0":"2017-06-14T14:49:49.163Z","3.0.1":"2017-06-15T11:31:08.722Z","3.0.2":"2017-06-15T11:44:54.627Z","3.0.3":"2017-06-20T09:04:00.789Z","3.0.4":"2017-06-22T12:05:24.334Z","4.0.0":"2017-06-30T15:23:11.902Z","3.0.5":"2017-07-03T15:02:09.552Z","4.0.1":"2017-07-14T17:19:01.699Z","4.1.0":"2017-09-11T15:09:37.030Z","4.2.0":"2017-10-27T08:35:23.494Z","4.2.1":"2017-11-07T09:56:41.249Z","4.2.2":"2017-11-20T09:46:19.194Z","4.2.3":"2017-11-20T11:03:41.378Z","4.2.4":"2017-11-20T12:25:06.177Z","4.2.5":"2017-11-29T13:53:11.008Z","4.2.6":"2017-12-15T17:14:23.419Z","4.2.7":"2018-02-01T15:45:53.947Z","4.2.8":"2018-02-02T16:03:55.394Z","4.2.9":"2018-04-26T13:52:35.999Z","4.2.10":"2018-05-24T18:23:07.720Z","4.2.11":"2018-05-25T12:35:13.282Z","4.2.12":"2018-06-27T11:51:04.172Z","4.2.13":"2018-07-27T14:46:58.474Z","4.2.14":"2018-07-31T12:19:13.757Z","4.2.15":"2018-08-01T16:19:48.646Z","4.3.0":"2018-08-01T16:44:08.278Z","4.3.1":"2018-08-15T13:27:45.231Z","4.3.2":"2018-08-15T14:39:26.371Z","4.3.3":"2018-08-15T15:38:21.247Z","4.3.4":"2018-08-17T08:53:21.809Z","4.4.0":"2018-08-24T09:02:40.453Z","4.5.0":"2018-08-24T09:29:43.960Z","4.6.0":"2018-09-06T09:53:52.484Z","4.7.0":"2018-09-11T10:49:23.870Z","4.8.0":"2018-09-13T13:39:25.569Z","4.8.1":"2018-09-28T14:21:02.933Z","4.9.0":"2018-10-02T13:37:11.503Z","4.10.0":"2018-10-11T16:00:23.997Z","4.10.1":"2018-10-29T16:49:27.346Z","4.10.2":"2018-11-05T12:03:23.486Z","4.11.0":"2018-11-08T16:08:30.927Z","4.11.1":"2018-11-09T09:45:03.169Z","4.12.0":"2018-11-23T13:03:36.917Z","4.12.1":"2018-11-28T13:48:24.747Z","4.13.0":"2018-12-03T13:27:52.745Z","4.14.0":"2019-03-04T14:13:13.462Z","4.15.0":"2019-04-08T14:51:11.572Z","4.16.0":"2019-06-17T09:31:20.349Z","4.17.0":"2019-06-18T09:52:49.196Z","4.17.1":"2019-06-20T10:17:25.037Z","4.18.0":"2019-06-24T12:31:42.496Z"},"homepage":"https://github.com/zalando-incubator/atlas-js-core#readme","keywords":["atlas","guest checkout","checkout","catalog","api","extensions"],"repository":{"type":"git","url":"git+https://github.com/zalando-incubator/atlas-js-core.git"},"author":{"name":"Zalando SE"},"bugs":{"url":"https://github.com/zalando-incubator/atlas-js-core/issues"},"license":"MIT","readmeFilename":"README.md","users":{"artdaw":true,"ahmed-shehata":true}}