Docs
Dashboard

ShippingMethodRateCreateInput

Input

Input for creating a new shipping method rate.

#

Fields


predicate
String

An optional predicate that can be used to filter the shipping method rate.

Thor predicates are boolean expressions. Cart discounts and shipping rules evaluate against cart context; product discounts evaluate against price and product context. Cart predicate language and product predicate language.
price
MoneyInput

The price of the shipping method rate, represented as a MoneyInput.

rateOfTotal
RateOfTotalInput

An optional rate of total, which can be used to calculate the shipping cost based on the total order amount.

taxBehavior
TaxBehavior

An optional tax behavior configuration for the rate. Defaults to Exclusive when omitted.

Possible enum values
  • EXCLUSIVE

    Exclusive tax is added on top of the price. For example, a product has the price defined as 5.00 USD. The tax charged on this product could be 10% and would result in a final price of 5.50 USD. (Tax rates might differ—this is only an explanatory example.)

  • INCLUSIVE

    Inclusive tax is already included in the price. For example, a product has the price defined as 5.00 USD. The final price the customer pays is 5.00 USD.