Class CustomerList

Object representing the collection of customers who are registered for a given site. In Commerce Cloud Digital, every site has exactly one assigned customer list but multiple sites may share a customer list.

Property Summary 

PropertyDescription
ID: String (read-only)Get the ID of the customer list.
description: String (read-only)Get the optional description of the customer list.

Constructor Summary 

This class does not have a constructor, so you cannot create it directly.

Method Summary 

MethodDescription
getDescription()Get the optional description of the customer list.
getID()Get the ID of the customer list.

Methods inherited from class Object 

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

Property Details 

ID 

ID: String (read-only)

Get the ID of the customer list. For customer lists that were created automatically for a given site, this is equal to the ID of the site itself.


description 

description: String (read-only)

Get the optional description of the customer list.


Method Details 

getDescription() 

getDescription(): String

Get the optional description of the customer list.

Returns:

  • The optional description of the list.

getID() 

getID(): String

Get the ID of the customer list. For customer lists that were created automatically for a given site, this is equal to the ID of the site itself.

Returns:

  • The ID of the customer list.