Broadleaf Microservices
  • v1.0.0-latest-prod

Customer

In this section of the documentation we look at the customer related functionality exposed by the CommerceSDK. This is concerned with retrieving the currently authenticated customer. It also provides methods managing the customer’s saved addresses and payments.

All of the operations in this section require the current customer to be authenticated and to provide their access token.

Table of Contents

Setup the client

Before you can make a request using the CustomerClient, you’ll need to import the client and create a new instance. An example of this setup is as follows:

Example of creating a CustomerClient instance
import { CustomerClient } from '@broadleaf/commerce-browse';

const APPLICATION_TOKEN = `${YOUR_APPLICATION_TOKEN}`; (1)
const BASE_HOST = `${YOUR_PUBLIC_BASE_URL}`; (2)

export const CustomerClient = new CustomerClient({
  applicationToken: APPLICATION_TOKEN,
  baseHost: BASE_HOST
});
  1. This is the unique "Application Token" for your store. You can find this by logging into your instance and looking at the application’s properties page.

  2. This is the base URL for your application (i.e. https://demo123.broadleafcommerce.org)