AddressesAPI
The API for interacting with addresses.
Anchor to standardapiStandardApi
The base API object provided to purchase extension targets.
The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke.
Requires access to protected customer data.
The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.
Requires access to protected customer data.
Anchor to checkoutapiCheckoutApi
The API object provided to purchase.checkout extension targets.
Performs an update of the shipping address. Shipping address changes will completely overwrite the existing shipping address added by the user without any prompts. If successful, this mutation results in an update to the value retrieved through the property.
This method will return an error if the cart instruction is false, or the buyer is using an accelerated checkout method, such as Apple Pay, Google Pay, or Meta Pay.
Requires access to protected customer data.
Anchor to useBillingAddressuse
Returns the proposed applied to the checkout.
Anchor to useShippingAddressuse
Returns the proposed applied to the checkout.
Anchor to useApplyShippingAddressChangeuse
Returns a function to mutate the property of checkout.
