createCartAddress

Method creating an address and assigning it to the cart as delivery address in SAP Commerce Cloud.

This method sends a POST request to the createCartAddress endpoint of the Alokai Middleware. In turn, it exchanges data with the createCartDeliveryAddress 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 createCartAddress<Res extends Address = Address,
	Props extends CreateCartAddressProps = CreateCartAddressProps>(
	props: Props,
	options?: MethodOptions
): Promise<Res>;

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

Returns a representation of an Address.

Referenced Types

Examples

Creating a delivery address for a cart.

import { sdk } from '~/sdk';

const cartAddress = await sdk.commerce.createCartAddress({
  cartId: '00035084',
  address: {
    titleCode: 'mr',
    firstName: 'John',
    lastName: 'Doe',
    line1: 'Some Street',
    postalCode: '54-022',
    country: { isocode: 'GB' },
    town: 'Radom'
  }
});

Creating a delivery address for a cart and selecting response fields.

import { sdk } from '~/sdk';

const cartAddress = await sdk.commerce.createCartAddress({
  cartId: '00035084',
  address: {
    titleCode: 'mr',
    firstName: 'John',
    lastName: 'Doe',
    line1: 'Some Street',
    postalCode: '54-022',
    country: { isocode: 'GB' },
    town: 'Radom'
  },
  fields: 'firstName,lastName,town'
});