replaceCartAddress

Method assigning an existing delivery address to the cart in SAP Commerce Cloud.

This method sends a POST request to the replaceCartAddress endpoint of the Alokai Middleware. In turn, it exchanges data with the replaceCartDeliveryAddress endpoint exposed by the SAP OCC API Cart Addresses Controller.

This method will only work for either a current user cart or a guest cart (i.e. cart with an email added to it). It will not work with an anonymous cart. In case of a guest cart, remember to pass cart guid as the cartId param. In case of a current user cart, pass cart code instead.

Signature

export declare function replaceCartAddress<Props extends ReplaceCartAddressProps = ReplaceCartAddressProps>(
	props: Props,
	options?: MethodOptions
): Promise<void>;

Parameters

Name	Required	Type	Description
`props`	Required	`Props`	Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.
`options`	Optional	`MethodOptions`	Options that can be passed to additionally configure the request or customize the logic in a plugin.

Returns

This method does not return anything.

Referenced Types

Examples

Assigning an existing delivery address to the cart.

import { sdk } from '~/sdk';

await sdk.commerce.replaceCartAddress({ cartId: '00035084', addressId: '8796716793879' });