Skip to main content

addShippingAddress

Add or update shipping address for a cart.

Import​

import { addShippingAddress } from "@evershop/evershop/checkout/services";

Syntax​

addShippingAddress(
  cartUUID: string, 
  addressData: Address, 
  context?: Record<string, any>
): Promise<Address>

Parameters​

cartUUID

Type: string

Cart UUID.

addressData

Type: Address

Address data object:

{
  full_name: string;
  telephone: string;
  address_1: string;
  address_2?: string;
  city: string;
  province: string;
  postcode: string;
  country: string;
}

context

Type: Record<string, any> (optional)

Context object for hooks.

Return Value​

Returns Promise<Address> with created/updated address including cart_address_id.

Examples​

Add Shipping Address​

import { addShippingAddress } from "@evershop/evershop/checkout/services";

const address = await addShippingAddress('cart-uuid-123', {
  full_name: "John Doe",
  telephone: "555-1234",
  address_1: "123 Main St",
  city: "New York",
  province: "NY",
  postcode: "10001",
  country: "US"
});

console.log(`Address ID: ${address.cart_address_id}`);

See Also​