Poq.SDK.Node

Home > @poq/sdk-sfcc > CustomersClient > getCustomersByIDAddresses

CustomersClient.getCustomersByIDAddresses() method

Returns a sorted pageable list of all customer addresses in the address book. The default page size is 10 customer addresses. The addresses are sorted so that the preferred address is always sorted first. The remaining addresses are sorted alphabetically by ID. When the customer cannot be found CustomerNotFoundException is thrown in a case of an agent but an empty result list is returned in a case of JWT.

Signature:

getCustomersByIDAddresses(customerId: string, start?: number, count?: number, options?: RequestOptions): Promise<PoqResponse<CustomerAddressResult>>;

Parameters

Parameter Type Description
customerId string The customer uuid
start number (Optional)
count number (Optional)
options RequestOptions (Optional) Override http request option.

Returns:

Promise<PoqResponse<CustomerAddressResult>>