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 shippingAddress
read-only property of the PaymentRequest
interface returns the shipping address provided by the user. It is null
by default.
var paymentAddress = PaymentRequest.shippingAddress;
Generally, the user agent will fill the shippingAddress
property value. You can trigger this by setting PaymentOptions.requestShipping
to true
when calling the PaymentRequest
constructor.
In the example below, the cost of shipping varies by geography. When the PaymentRequest.onshippingaddresschange
is called, updateDetails()
is called to update the details of the PaymentRequest
, using shippingAddress
to set the correct shipping cost.
// Initialization of PaymentRequest arguments are excerpted for the sake of // brevity. var payment = new PaymentRequest(supportedInstruments, details, options); payment.addEventListener('shippingaddresschange', function(evt) { evt.updateWith(new Promise(function(resolve) { updateDetails(details, request.shippingAddress, resolve); })); }); payment.show().then(function(paymentResponse) { // Processing of paymentResponse exerpted for brevity. }).catch(function(err) { console.error("Uh oh, something bad happened", err.message); }); function updateDetails(details, shippingAddress, resolve) { if (shippingAddress.country === 'US') { var shippingOption = { id: '', label: '', amount: {currency: 'USD', value: '0.00'}, selected: true }; if (shippingAddress.region === 'MO') { shippingOption.id = 'mo'; shippingOption.label = 'Free shipping in Missouri'; details.total.amount.value = '55.00'; } else { shippingOption.id = 'us'; shippingOption.label = 'Standard shipping in US'; shippingOption.amount.value = '5.00'; details.total.amount.value = '60.00'; } details.displayItems.splice(2, 1, shippingOption); details.shippingOptions = [shippingOption]; } else { delete details.shippingOptions; } resolve(details); }
Specification | Status | Comment |
---|---|---|
Payment Request API The definition of 'shippingaddress' in that specification. | Candidate Recommendation | Initial definition. |
Feature | Chrome | Edge | Firefox (Gecko) | Internet Explorer | Opera | Safari (WebKit) |
---|---|---|---|---|---|---|
Basic support | 61 | (Yes) | ? | ? | 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 | ? |
© 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/shippingAddress