getUserAddresses

Get customers addresses from SAP Commerce Cloud.

This method exchanges data with the getAddresses endpoint exposed by the SAP OCC API Address Controller.

The method fetches customer addresses based on the vsf-sap-token cookie (which is assigned to that customer). The cookie must be present in the request for the method to work properly.

Signature

export declare function getUserAddresses(
	context: SapccIntegrationContext,
	props?: BaseProps & BaseUserId
): Promise<AddressList>;

Parameters

Name	Required	Type	Description
`context`	Required	`SapccIntegrationContext`
`props`	Optional	`BaseProps & BaseUserId`	Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.

Returns

Returns a representation of an Address List.

Referenced Types

Examples

Fetching customer addresses.

import { sdk } from '~/sdk';

const { addresses } = await sdk.commerce.getUserAddresses();

Fetching customer addresses and selecting response fields.


const \{ addresses \} = await sdk.commerce.getUserAddresses(\{ fields: 'addresses(firstName,lastName)' \}); `*