PaymentRespoonse.shippingAddress
This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for usage in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the specification changes.
The shippingAddress
read-only property of the PaymentRequest
interface returns a PaymentAddress
object containing the shipping address provided by the user.
Syntax
var paymentAddress = PaymentRequest.shippingAddress;
Example
Generally, the user agent will fill the shippingAddress
property for you. 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 brevity. var payment = new PaymentRequest(supportedInstruments, details, options); request.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 the same of 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); }
Specifications
Specification | Status | Comment |
---|---|---|
Payment Request API | Working Draft | Initial definition. |
Browser Compatibility
Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari (WebKit) |
---|---|---|---|---|---|
Basic support |
53.0 |
? | ? | ? | ? |
Feature | Android | Android Webview | Firefox Mobile (Gecko) | Firefox OS | IE Mobile | Opera Mobile | Safari Mobile | Chrome for Android |
---|---|---|---|---|---|---|---|---|
Basic support | No support | 53.0 | ? | ? | ? | ? | ? | 53.0 |
License
© 2016 Mozilla Contributors
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-us/docs/web/api/paymentresponse/shippingaddress