ShippingEstimate
This object represents the estimate for a shipping method on a cart.
Local currency fields are only available to the REST API.
This method is usually called in a separate ajax call from the main cart since shipping estimates are slower.
Field | Type | Description |
name | string | Name of the shipping method. If this method is selected by the customer than this is the method name that should be set on the cart.shippingMethod field. |
| baseCurrencyCode | string | The base currency code for the merchant. |
comment | string | Comment associated with the shipping method. |
cost costLocalized costLocalizedFormatted | number number string | Cost of the shipping method |
costBeforeDiscount costBeforeDiscountLocalized costBeforeDiscountLocalizedFormatted | number number string | The shipping cost before any discounts. |
| currencyCode | string | The currency of the shipping estimate. |
| defaultMethod | boolean | True if this is the default shipping method for this cart, else false. |
discount discountLocalized discountLocalizedFormatted | number number string | The shipping discount due to pricing tiers or coupons |
discounted | boolean | True if this method has been discounted because of a coupon. |
displayName | string | Name of this method that should be displayed to the customer. |
estimatedDelivery | string | Estimated delivery time. Should be displayed beside the method if it's available. |
tax taxLocalized taxLocalizedFormatted | number number string | The tax for this shipping method. |
totalTax totalTaxLocalized totalTaxLocalizedFormatted | number number string | The total tax for the shopping cart if this shipping method is selected. This is a convenience value so you can update the total cart tax if a shipping method is selected. |