This SDK covers the functionality provided by team Atlas' (aka Distributed Commerce) APIs, namely, Checkout, Guest Checkout, and Catalog APIs.

Those APIs, and in turn this SDK, provide our partners a more streamlined access the Zalando shopping platform to enable our customers to purchase wherever they are.

The purpose of this project is to provide low-level calls to API backend and response models for Zalando Checkout, Guest Checkout, and Catalog APIs in order to allow easily integrate and run Zalando Сheckout in minutes using your own UI solution.

If you want to access the APIs directly we recommend that you take a look at their documentation.

We use Promises a lot :)

npm install --save atlas-sdk-core es6-promise

On install we're transpiling the code for your convenience. You have access to two files under a lib/ folder, one for using in node and another for browser usages.

Because we are using Promises you must bring your own ES6 Promise compatible polyfill, e.g. es6-promise.

If you want to contribute, please, read our Contributing guidelines first.

In order to start SDK development simply run

npm run tdd

Check existing codebase tests for test examples.

You need to configure Atlas JavaScript SDK Core first and use configured instance variable to interact with AtlasSDK.

In order to configure AtlasSDK manually provide an object with 2 mandatory parameters client_id and sales_channel:

import AtlasSDK from 'atlas-sdk-core';

AtlasSDK.configure({
  client_id: 'CLIENT_ID',
  sales_channel: 'SALES_CHANNEL',
  is_sandbox: true
}).then((sdk) => {
  // sdk instance is ready to use

  sdk.getArticle('AD112B0F6-A11').then((article) => {
    console.log(`Article name: ${article.name}`);
  });
}).catch((error) => {
  console.error(`${error}`);
});

Since we are using Promises you can benefit from await/async:

import AtlasSDK from 'atlas-sdk-core';

const sdk = await AtlasSDK.configure({
  client_id: 'CLIENT_ID',
  sales_channel: 'SALES_CHANNEL'
});
const article = await sdk.getArticle('AD112B0F6-A11');
console.log(`Article name: ${article.name}`);

AtlasSDK

AtlasSDK is a global namespace.

AtlasSDKClient

AtlasSDK instance returned from AtlasSDK configure method.

PickupPoint

AddressSchema

Baseclass for Address model

CheckoutAddressSchema

Baseclass for CheckoutAddress model

NormalizedAddress

Baseclass for NormalizedAddress model

CheckedAddress

Baseclass for CheckedAddress model

Brand

Class for Brand model.

Partner

Class for Partner model.

PriceSchema

Class for Article Unit Price model.

Unit

Class for Article Unit model.

Attribute

Class for Article Unit Attribute model.

EnrichmentAttribute

Class for Article Unit EnrichmentAttribute model.

TargetGroups

Class for TargetGroups model.

ArticleImage

Class for ArticleImage model.

Media

Class for Media model.

Item

Class for CartItem model

ItemWithPrice

Class for CartItem model

Payment

Class for Payment model

Delivery

Class for Delivery model'

ReviewRatingDistribution

Class for ReviewRatingDistribution.

ReviewRating

Class for ReviewRating.

ReviewRecommendations

Class for ReviewRecommendations.

ReviewSummary

Class for ReviewSummary.

ReviewEntry

Class for ReviewEntry.

Reviews

Class for Article Reviews.

Image

Class for Image model.

Video

Class for Video model.

Article

Class for Article model

ArticleFamily

Class for ArticleFamily model

DiscountSchema

Class for Discount model

CheckoutCouponDiscount

Class for Checkout Discount model

DeliveryRequest

Class for Delivery Request model

CreateCartRequest

Class for Cart Request model

SelectedPayment

Class for Selected Payment model

Payment

Class for Payment model

CheckoutCouponDetails

Class for Checkout Coupon Details model

CartResponse

Class for Cart Response model

CartsResponse

Class for Carts Response model

CreateCheckoutRequest

Class for Checkout Request model

CheckoutResponse

Class for Checkout Response model

PutCheckoutRequest

Class for Put Checkout Request model

CheckoutOrderRequest

Class for Checkout Order Request model

SalesChannel

SalesChannel class struct

Recommendations

Recommendations class struct

Config

Config class struct

GuestCustomer

Class for Guest Customer model

CheckoutCustomer

Class for Guest Customer model

Cart

Cart

CreateOrderRequest

Class for CreateOrderRequest model

CreateOrderResponse

Class for CreateOrderResponse model

CreateOrderRedirectResponse

Class for CreateOrderRedirectResponse model

GetCheckoutResponse

Class for GetCheckoutResponse model

OrderResponse

Class for Order Response model

CheckoutApiOrderResponseSchema

Class for Checkout Order Response model

CheckoutOrder

Class for Guest Customer model

RecommendedArticle

Class for Recommended Article model

configCache

A temporary fix to handle the current high load capacity

fetchEndpoint(endpoint) ⇒ Promise

Calls the given endpoint using fetch and intercepts the response via various operations

AtlasSDK is a global namespace.

Access: public

Configure AtlasSDK. This is the main entry point to use the AtlasSDK.

Kind: static method of AtlasSDK
Returns: Promise.<AtlasSDKClient> - a promise resolving with an AtlasSDKClient object
Access: public

Example

const sdk = await AtlasSDK.configure({
  client_id: 'CLIENT_ID',
  sales_channel: 'SALES_CHANNEL',
  is_sandBox: true
});

AtlasSDK instance returned from AtlasSDK configure method.

Kind: global class

• AtlasSDKClient
  • new AtlasSDKClient(config)
  • .getLocale() ⇒ String
  • .getLanguage() ⇒ String
  • .getCountryCode() ⇒ String
  • .getConfig() ⇒ Object
  • .getArticle(sku, [options]) ⇒ Article
  • .getArticles(skus, [options]) ⇒ Array.<Article>
  • .getArticleFamilies(sku, [options]) ⇒ Array.<ArticleFamily>
  • .getGuestCheckout(checkoutId, token) ⇒ GetCheckoutResponse
  • .createGuestOrder(checkoutId, token) ⇒ CreateOrderResponse
  • .getRecommendations(sku, [options]) ⇒ Array.<RecommendedArticle>
  • .createGuestCheckout(json) ⇒ CreateOrderRedirectResponse
  • .getCheckoutCustomer(token) ⇒ CheckoutCustomer
  • .getCheckoutAddresses(token) ⇒ CheckoutAddress
  • .getCheckoutCarts(token, headers) ⇒ CartsResponse
  • .createCheckoutCart(json, token, options) ⇒ CartResponse
  • .getCheckoutCart(cartId, token) ⇒ CartResponse
  • .putCheckoutcart(json, cartId, token, headers) ⇒ CartResponse

Creates an AtlasSDK instance from config provided by config-api

Returns locale based on sales channel, e.g. 'de_DE'

Kind: instance method of AtlasSDKClient
Returns: String - locale

Returns language based on sales channel, e.g. 'de'

Kind: instance method of AtlasSDKClient
Returns: String - language

Returns country code based on sales channel, e.g. 'DE'

Kind: instance method of AtlasSDKClient
Returns: String - country code

Returns configuration from config-api

Kind: instance method of AtlasSDKClient
Returns: Object - config

Fetches an article based on a SKU.

Kind: instance method of AtlasSDKClient
Returns: Article - return Article object
Access: public

 {  media: {    cdn: 'mosaic02',    image_resolutions: ['thumbnail', 'medium']  } } 

Example

const sdk = await AtlasSDK.configure({
  client_id: 'CLIENT_ID',
  sales_channel: 'SALES_CHANNEL',
  is_sandBox: true,
  lang: 'en'
});
const article = await sdk.getArticle('AD112B0F6-A11', {
   media: {
     image_resolutions: ['thumbnail', 'medium']
   }
});

Fetches multiple articles based on SKUs.

Kind: instance method of AtlasSDKClient
Returns: Array.<Article> - return Article[] object
Access: public

 {  media: {    cdn: 'mosaic02',    image_resolutions: ['thumbnail', 'medium']  } } 

Example

const sdk = await AtlasSDK.configure({
  client_id: 'CLIENT_ID',
  sales_channel: 'SALES_CHANNEL',
  is_sandBox: true,
  lang: 'en'
});
const articles = await sdk.getArticles('AD112B0F6-A11,SO254C009-K12', {
   media: {
     image_resolutions: ['thumbnail', 'medium']
   }
});

Fetches article families based on SKU.

Kind: instance method of AtlasSDKClient
Returns: Array.<ArticleFamily> - return ArticleFamily[] object
Access: public

 {  media: {    cdn: 'mosaic02',    image_resolutions: ['thumbnail', 'medium']  } } 

Example

const sdk = await AtlasSDK.configure({
  client_id: 'CLIENT_ID',
  sales_channel: 'SALES_CHANNEL',
  is_sandBox: true,
  lang: 'en'
});
const article = await sdk.getArticleFamilies('AD112B0F6-A11');

Returns the complete details of the checkout: guest checkout object GetCheckoutResponse created using createGuestCheckout. Parameters checkoutId, token should be fetched from redirect URL after payment.

Kind: instance method of AtlasSDKClient
Returns: GetCheckoutResponse - guest checkout object
Access: public

Creates an order for the guest chekout object based on checkoutId, token.

Kind: instance method of AtlasSDKClient
Returns: CreateOrderResponse - object with order information
Access: public

Fetches recommendations for an article based on a SKU.

Kind: instance method of AtlasSDKClient
Returns: Array.<RecommendedArticle> - return array of RecommendedArticle[] objects
Access: public

 {  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'],  } } 

Example

const sdk = await AtlasSDK.configure({
  client_id: 'CLIENT_ID',
  sales_channel: 'SALES_CHANNEL',
  is_sandBox: true
});
const recos = await sdk.getRecommendations('AD112B0F6-A11', {
   reco_id: 'UUID',
   tracking_string: 'TRACK',
   media: {
     cdn: 'mosaic02',
     image_resolutions: ['thumbnail', 'medium']
   },
   filters: {
     '-filter_gender': 'FEMALE'
     'brand_code': ['AN1', 'N12', 'PU1'],
   }
});

Creates guest checkout object with payload.

Kind: instance method of AtlasSDKClient
Returns: CreateOrderRedirectResponse - response containing redirectURL that should be used to go to the payment.
Access: public

Returns customer object CheckoutCustomer. Parameters customer token needed to fetch customer object.

Kind: instance method of AtlasSDKClient
Returns: CheckoutCustomer - customer object
Access: public

Returns customer addresses CheckoutAddress. Parameters customer token needed to fetch customer object.

Kind: instance method of AtlasSDKClient
Returns: CheckoutAddress - CheckoutAddress array
Access: public

Returns a customer's cart(s)

Kind: instance method of AtlasSDKClient
Returns: CartsResponse - - carts

Creates Zalando customer cart

Kind: instance method of AtlasSDKClient
Returns: CartResponse - - customer cart

Returns a cart by id

Kind: instance method of AtlasSDKClient
Returns: CartResponse - - cart

Updates existing cart by id

Kind: instance method of AtlasSDKClient
Returns: CartResponse - - updated cart

Kind: global class

Baseclass for Address model

Kind: global class

Baseclass for CheckoutAddress model

Kind: global class

Baseclass for NormalizedAddress model

Kind: global class

Baseclass for CheckedAddress model

Kind: global class

Class for Brand model.

Kind: global class

Class for Partner model.

Kind: global class

Class for Article Unit Price model.

Kind: global class

Class for Article Unit model.

Kind: global class

Class for Article Unit Attribute model.

Kind: global class

Class for Article Unit EnrichmentAttribute model.

Kind: global class

Class for TargetGroups model.

Kind: global class

Class for ArticleImage model.

Kind: global class

Class for Media model.

Kind: global class

Class for CartItem model

Kind: global class

Class for CartItem model

Kind: global class

Class for Payment model

Kind: global class

• Payment
  • new Payment(method, selectionPageUrl, metadata)
  • new Payment(selected, selectionPageUrl)

Class for Delivery model'

Kind: global class

Class for ReviewRatingDistribution.

Kind: global class

Class for ReviewRating.

Kind: global class

Class for ReviewRecommendations.

Kind: global class

Class for ReviewSummary.

Kind: global class

Class for ReviewEntry.

Kind: global class

Class for Article Reviews.

Kind: global class

Class for Image model.

Kind: global class

Class for Video model.

Kind: global class

Class for Article model

Kind: global class

Class for ArticleFamily model

Kind: global class

Class for Discount model

Kind: global class

Class for Checkout Discount model

Kind: global class

Class for Delivery Request model

Kind: global class

Class for Cart Request model

Kind: global class

Class for Selected Payment model

Kind: global class

Class for Payment model

Kind: global class

• Payment
  • new Payment(method, selectionPageUrl, metadata)
  • new Payment(selected, selectionPageUrl)

Class for Checkout Coupon Details model

Kind: global class

Class for Cart Response model

Kind: global class

Class for Carts Response model

Kind: global class

Class for Checkout Request model

Kind: global class

Class for Checkout Response model

Kind: global class

Class for Put Checkout Request model

Kind: global class

Class for Checkout Order Request model

Kind: global class

SalesChannel class struct

Kind: global class

Recommendations class struct

Kind: global class

Config class struct

Kind: global class

Example

const source = {
  catalog_api_url: 'https://catalog_api.com/api',
  checkout_api_url: 'https://checkout_api.com/api',
  oauth2_provider_url: 'https://oauth2_provider.com/api',
  sales_channel: {
    locale: 'de_DE',
    channel: '11111111-1111-1111-1111-111111111111',
    toc_url: 'https://m.zalando.de/agb/'
  },
  recommendations: {
    location: 'my_app_pdp',
    type: 'similar',
    channel: 'myapp'
  }
};

const config = new Config(source);

Class for Guest Customer model

Kind: global class

Class for Guest Customer model

Kind: global class

Cart

Kind: global class

Class for Cart model

Class for CreateOrderRequest model

Kind: global class

Class for CreateOrderResponse model

Kind: global class

Class for CreateOrderRedirectResponse model

Kind: global class

Class for GetCheckoutResponse model

Kind: global class

Class for Order Response model

Kind: global class

Class for Checkout Order Response model

Kind: global class

Class for Guest Customer model

Kind: global class

Class for Recommended Article model

Kind: global class

A temporary fix to handle the current high load capacity

Kind: global constant

Calls the given endpoint using fetch and intercepts the response via various operations

Kind: global function
Returns: Promise - Promise after resolving or rejecting the request.

For any inquiry, please contact Team Atlas via team-atlas@zalando.de

The MIT License (MIT) Copyright © 2016 Zalando SE, https://tech.zalando.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.