PaymentRequest: shippingaddresschange event

Secure context

This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

The shippingaddresschange event is sent to the PaymentRequest object when the user selects a shipping address or changes details of their shipping address.

Bubbles No
Cancelable No
Interface PaymentRequestUpdateEvent
Event handler property onshippingaddresschange

Usage notes

Depending on the browser, the shipping address information may be redacted for privacy reasons. That is, the PaymentAddress which contains the shipping address may have some portions of its content altered, obscured, or left out entirely in order to prevent identifying the user without their consent (since if they choose to have you ship products to them, you'll need their address).

Example

In this example, a handler for the shippingaddresschange event is set up to validate that the address meets requirements set by the web application.

const paymentRequest = new PaymentRequest(methodData, details, options);

paymentRequest.addEventListener("shippingaddresschange", event => {
  let detailsUpdate = checkAddress(paymentRequest.shippingAddress);
  event.updateWith(detailsUpate);
}, false);

const checkAddress = theAddress => {
  let detailsUpdate = {};

  // Check the address, return a PaymentDetailsUpdate object
  // with any changes or errors.

  return detailsUpdate;
};

You can also establish a handler for shippingaddresschange using the onshippingaddresschange event handler property:

paymentRequest.onshippingaddresschange = event => {
  let detailsUpdate = checkAddress(paymentRequest.shippingAddress);
  event.updateWith(detailsUpdate);
};

Specifications

Specification Status Comment
Payment Request API
The definition of 'shippingaddresschange' in that specification.
Candidate Recommendation Initial definition.

BCD tables only load in the browser