Docs
Dashboard

ShippingMethodRate

Interface

Shared fields implemented by shipping method rate types.

#

Fields


currencyCode
String!

The currency code for the shipping method rate.

id
ID!

The unique identifier for the shipping method rate.

predicate
String

The predicate of the shipping method rate. Predicates are used to filter shipping methods based on certain criteria.

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.
priority
Int!

The priority of the shipping method rate. Lower values indicate higher priority.

taxBehavior
TaxBehavior!

The tax behavior of the shipping method rate, indicating whether the rate is inclusive or exclusive of tax.

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.

#

Implementations


AbsoluteShippingMethodRate
AbsoluteShippingMethodRate

Fields returned for absolute shipping method rate.

RelativeShippingMethodRate
RelativeShippingMethodRate

Fields returned for relative shipping method rate.