Web/API/PaymentRequest/onshippingoptionchange

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

This is an experimental technologyCheck the Browser compatibility table carefully before using this in production.

The onshippingoptionchange event of the PaymentRequest interface is fired whenever the user changes a shipping option.

Syntax

PaymentRequest.addEventListener('shippingoptionchange', shippingOptionChangeEvent => { ... });

PaymentRequest.onshippingoptionchange = function(shippingOptionChangeEvent) { ... };

Examples

The shippingoptionchange event is triggered by a user-agent controlled interaction. If the option stored by the user agent changes at any time during a payment process, the event is triggered. To make sure an updated option is included when sending payment information to the server, you should add event listeners for a PaymentRequest object after instantiation, but before the call to show().

// Initialization of PaymentRequest arguments are excerpted for clarity.
var request = new PaymentRequest(supportedInstruments, details, options);

// When user selects a shipping address
request.addEventListener('shippingaddresschange', e => {
  e.updateWith(((details, addr) => {
    var shippingOption = {
      id: '',
      label: '',
      amount: { currency: 'USD', value: '0.00' },
      selected: true
    };
    // Shipping to US is supported
    if (addr.country === 'US') {
      shippingOption.id = 'us';
      shippingOption.label = 'Standard shipping in US';
      shippingOption.amount.value = '0.00';
      details.total.amount.value = '55.00';
    // Shipping to JP is supported
    } else if (addr.country === 'JP') {
      shippingOption.id = 'jp';
      shippingOption.label = 'International shipping';
      shippingOption.amount.value = '10.00';
      details.total.amount.value = '65.00';
    // Shipping to elsewhere is unsupported
    } else {
      // Empty array indicates rejection of the address
      details.shippingOptions = [];
      return Promise.resolve(details);
      console.log(details.error);
    }
    // Hardcode for simplicity
    if (details.displayItems.length === 2) {
      details.displayItems[2] = shippingOption;
    } else {
      details.displayItems.push(shippingOption);
    }
    details.shippingOptions = [shippingOption];

    return Promise.resolve(details);
  })(details, request.shippingAddress));
});

Specifications

Specification	Status	Comment
Payment Request APIThe definition of 'onshippingoptionchange' in that specification.	Candidate Recommendation	Initial definition.

Browser Compatibility

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
`onshippingoptionchange`	Chrome Full support 60	Edge Full support 15	Firefox No support No Notes' No support No Notes' Notes' Available only in nightly builds.	IE No support No	Opera Full support 47	Safari Full support 11.1	WebView Android No support No	Chrome Android Full support 53	Firefox Android No support No Notes' No support No Notes' Notes' Available only in nightly builds.	Opera Android Full support 44	Safari iOS Full support 11.3	Samsung Internet Android Full support 6.0

Legend

Full support: Full support
No support: No support
See implementation notes.': See implementation notes.

PaymentRequest.onshippingoptionchange by Mozilla Contributors is licensed under CC-BY-SA 2.5.