deleteUserAddress

Delete customer address in SAP Commerce Cloud.

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

The method deletes a customer address 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 deleteUserAddress(
	context: SapccIntegrationContext,
	props: DeleteAddressProps
): Promise<void>;

Parameters

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

Returns

This method does not return anything.

Referenced Types

SapccIntegrationContext
DeleteAddressProps

Examples

Deleting a customer address.

import { sdk } from '~/sdk';

await sdk.commerce.deleteUserAddress({ addressId: '8796879552535' });