<!--
{
  "availability" : [

  ],
  "documentType" : "symbol",
  "framework" : "ApplePayontheWeb",
  "identifier" : "/documentation/ApplePayontheWeb/ApplePayShippingMethod",
  "metadataVersion" : "0.1.0",
  "role" : "Structure",
  "symbol" : {
    "kind" : "Structure",
    "modules" : [
      "Apple Pay on the Web"
    ],
    "preciseIdentifier" : "struct/ApplePayShippingMethod"
  },
  "title" : "ApplePayShippingMethod"
}
-->

# ApplePayShippingMethod

A dictionary that describes the shipping method for delivering physical goods.

```
dictionary ApplePayShippingMethod {
	required DOMString label;
	required DOMString detail;
	required DOMString amount;
	required DOMString identifier;
	ApplePayDateComponentsRange dateComponentsRange;
};
```

## Overview

The Apple Pay sheet displays all the properties of a shipping method except `identifier`. The following listing is an example of a shipping method that shows free shipping.

```javascript
{    
    "label": "Free Shipping",
    "detail": "Arrives in 5 to 7 days",
    "amount": "0.00",
    "identifier": "FreeShip"
}
    
```

## Topics

### Working with shipping method properties

[`required DOMString label;`](/documentation/ApplePayontheWeb/ApplePayShippingMethod/label)

A short description of the shipping method.

[`required DOMString detail;`](/documentation/ApplePayontheWeb/ApplePayShippingMethod/detail)

Additional description of the shipping method.

[`ApplePayDateComponentsRange dateComponentsRange;`](/documentation/ApplePayontheWeb/ApplePayShippingMethod/dateComponentsRange)

The expected range of dates for shipping or picking up an item.

[`required DOMString identifier;`](/documentation/ApplePayontheWeb/ApplePayShippingMethod/identifier)

A client-defined value used to identify this shipping method.

[`required DOMString amount;`](/documentation/ApplePayontheWeb/ApplePayShippingMethod/amount)

The nonnegative cost associated with this shipping method.

[`dictionary ApplePayDateComponentsRange {
	required ApplePayDateComponents startDateComponents;
	required ApplePayDateComponents endDateComponents;
};`](/documentation/ApplePayontheWeb/ApplePayDateComponentsRange)

A dictionary that specifies the start and end dates for a range of time.


---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)