commerce-sdk

commerce-sdk

The Commerce SDK allows easy interaction with the B2C Commerce platform APIs on the Node.js runtime. ​

Prerequisites

Download and install Node.js and npm here. ​

Note: Only Node.js version 10 is supported. A version other than version 10 can cause unexpected results. To use a different version of Node.js for other projects, you can manage multiple versions of Node.js with nvm. ​

Installation

Use npm to install the Commerce SDK. ​

npm install commerce-sdk

Usage

To use an SDK client, instantiate an object of that client and configure these parameters.

Note: These are optional parameters. ​

Parameter	Description
baseUri	URL of the service with which the SDK interacts. If the baseUri isn't provided, the default baseUri for the relevant RAML file is used.
clientId	ID of the client account created with Salesforce B2C Commerce.
clientSecret	Secret associated with the client ID.

Sample Code

/**
 * Sample TypeScript code shows how Commerce SDK can access 
 * Salesforce B2C Commerce platform APIs.
 */
​
// Import the SDK
import { Shop } from 'commerce-sdk';
​
// Instantiate a Shop client object with configuration parameters.
const shopClient = new Shop({
    baseUri: "https://somewhere.com/v1/shop",
    clientId: 'test-client-id',
    clientSecret: 'test-client-secret'
});
​
// Retrieve a list of currencies allowed by a merchant.
shopClient.getSite()
    .then(response => {
        // Do something with the response
        return response.allowed_currencies;
    })
    .catch(error => {
        // Do something with the error
        throw new Error(`Error fetching allowed currencies: ${error}`);
    });

When using an IDE such as VSCode, the autocomplete feature lets you view the available method and class definitions, including parameters. ​ ​ To view the details of a method or a variable, hover over methods and variables. ​ ​

License Information

The Commerce SDK is licensed under BSD-3-Clause license. See the license for details.