ShippingRateSettings
A ShippingRateSettings represents re-usable pieces of shipping information. It is designed for publication on an URL that may be referenced via the shippingSettingsLink property of an OfferShippingDetails. Several occurrences can be published, distinguished and matched (i.e. identified/referenced) by their different values for shippingLabel.
Build ShippingRateSettings JSON-LD
Loading the builder…
Properties (22)
| Property | Expects | Description |
|---|---|---|
| doesNotShip | Boolean | Indicates when shipping to a particular shippingDestination is not available. |
| freeShippingThreshold | DeliveryChargeSpecification, MonetaryAmount | A monetary value above (or at) which the shipping rate becomes free. Intended to be used via an OfferShippingDetails with shippingSettingsLink matching this ShippingRateSettings. |
| isUnlabelledFallback | Boolean | This can be marked 'true' to indicate that some published DeliveryTimeSettings or ShippingRateSettings are intended to apply to all OfferShippingDetails published by the same merchant, when referenced by a shippingSettingsLink in those settings. It is not meaningful to use a 'true' value for this property alongside a transitTimeLabel (for DeliveryTimeSettings) or shippingLabel (for ShippingRateSettings), since this property is for use with unlabelled settings. |
| minimumOrderValue | MonetaryAmount, Number, PriceSpecification | The minimum order value required for this shipping rate to apply. |
| orderPercentage | Number | Value representing the fraction of the value of the order that is charged as shipping cost. Example: 0.10 would mean shipping rate is 10% of the total order value. |
| shippingDestination | DefinedRegion | indicates (possibly multiple) shipping destinations. These can be defined in several ways, e.g. postalCode ranges. |
| shippingLabel | Text | Label to match an OfferShippingDetails with a ShippingRateSettings (within the context of a shippingSettingsLink cross-reference). |
| shippingRate | MonetaryAmount, ShippingRateSettings | The shipping rate is the cost of shipping to the specified destination. Typically, the maxValue and currency values (of the MonetaryAmount) are most appropriate. |
| weightPercentage | Number | Value representing the fraction of the weight that is used to compute the shipping price. Example: 0.10 and a shipping weight of 15kg would add $1.5 to the order price, where the $ is the currency of the order. |
Where ShippingRateSettings is used as a value
These properties expect a ShippingRateSettings: shippingRate.