Skip to main content
POST
Set cart address

Authorizations

Authorization
string
header
required

Access token

Path Parameters

id
string
required

Cart ID

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]{1,128}$

Body

application/json

Update billing and shipping address during checkout

Provide a shipping address or saved shipping address ID. Billing defaults to shipping; saved IDs and inline addresses can be mixed.

shipping_address_id
string
required
billing_address_id
string
shipping_address
CartAddressRequest · object
billing_address
CartAddressRequest · object

Response

OK

message
string
required
Example:

"Address updated successfully"

success
boolean
required
content
object
required
events
(CartLifecycleEvent · object | CartLineChangeEvent · object | CartCouponEvent · object | OrderCreatedEvent · object | OrderCancelledEvent · object | WishlistChangeEvent · object)[]
required

Analytics events to emit for the change this request made, each with a server-issued event_id. Replay them to your analytics destinations so your client-side and server-side copies of the same action dedupe. Empty when the request produced no analytics event.

Emitted when a cart is created or deleted, or when checkout begins. Checkout Started is sent each time an address is set on the cart, even an unchanged one, matching Commerce Engine's own server-side copy.