Secure context
This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
This is an experimental technology
Check 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.
PaymentRequest.addEventListener('shippingaddresschange', shippingaddresschangeevent => { ... }); PaymentRequest.onshippingaddresschange = function(shippingaddresschangeevent) { ... };
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)); });
Specification | Status | Comment |
---|---|---|
Payment Request API The definition of 'onshippingoptionchange' in that specification. | Candidate Recommendation | Initial definition. |
Feature | Chrome | Edge | Firefox (Gecko) | Internet Explorer | Opera | Safari (WebKit) |
---|---|---|---|---|---|---|
Basic support | 61 | (Yes) | No support[1] | ? | No support | ? |
Feature | Android Webview | Chrome for Android | Edge | Firefox Mobile (Gecko) | IE Mobile | Opera Mobile | Safari Mobile |
---|---|---|---|---|---|---|---|
Basic support | No support | 53 | (Yes) | No support[1] | ? | No support | ? |
[1] Supported since 55 but disabled on all versions. Hidden behind the dom.payments.request.enabled
pref.
© 2005–2018 Mozilla Developer Network and individual contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/PaymentRequest/onshippingoptionchange