ShippingRate - Liquid Object Reference
On this page
Description
The ShippingRate object contains information about the shipping rates.
:::note
This object supports custom data via the data attribute.
:::
Backed by
This drop renders the s_c__Shipping_Rate__c Salesforce object. A theme writes it as shipping_rate.
| Liquid attribute | Salesforce field |
|---|---|
shipping_method |
s_c__Method__c |
Every other attribute on this drop is derived by StoreConnect rather than read straight from one field. The Attributes section lists them all.
Fields you add yourself are not listed above. Expose one with a Custom Data Mapping record, then read it from shipping_rate.data. See custom data fields in Liquid.
Attributes
| Attribute | Type | Description |
|---|---|---|
form_value |
String | Returns the value to be used in the form when selection this rate |
id |
String | Returns the id of this shipping rate |
instructions_content |
String | Returns the instructions for this shipping rate |
name |
String | Returns the name of this shipping rate |
price |
Number | Returns the price for this shipping rate. For a carrier rate from a shipping provider, this is the carrier’s quote, plus tax on the quote when the shipping product is priced tax-inclusive. For one of your own shipping rates, this is the rate’s cost for the current cart. |
product_type |
String | Returns the type of product to which this shipping rate applies |
shipping_method |
String | Returns the method of this shipping rate |
Carrier rates on tax-inclusive stores
Carriers quote rates without tax. When the Tax Method on the shipping product’s Price Book Entry or Price Book is Inclusive, price for a carrier rate already includes the tax on the quote, and checkout charges exactly that amount. Do not add tax to it in your theme.
For example, with 10% GST linked to the shipping product and a carrier quote of $20.75, {{ shipping_rate.price | money }} renders $22.83.
Carts that use a tax provider, and carts for tax-exempt customers, return the carrier quote without tax. See how tax applies to carrier rates.
Available on
- Cart - Liquid Object Reference —
shipping_rates - Fulfillment - Liquid Object Reference —
shipping_rate
Was this article helpful?
Thanks for your feedback! It helps us improve our docs.