Skip to main content
Anchor to DeliveryConditionCriteria

DeliveryConditionCriteria

union

Requires Any of assigned_shipping or shipping access scopes or manage_delivery_settings user permission.

The value (weight or price) that the condition field is compared to.

•OBJECT

A precise monetary value and its associated currency. Combines a decimal amount with a three-letter currency code to express prices, costs, and other financial values throughout the API. For example, 12.99 USD.

•Decimal!
non-null

A monetary value in decimal format, allowing for precise representation of cents or fractional currency. For example, 12.99.

•CurrencyCode!
non-null

The three-letter currency code that represents a world currency used in a store. Currency codes include standard standard ISO 4217 codes, legacy codes, and non-standard codes. For example, USD.

•OBJECT

A weight measurement with its numeric value and unit. Used throughout the API, for example in shipping calculations, delivery conditions, order line items, and inventory measurements.

The weight combines a decimal value with a standard unit of measurement to ensure consistent weight handling across different regional systems.

•WeightUnit!
non-null

The unit of measurement for value.

•Float!
non-null

The weight value using the unit system specified with unit.


Was this section helpful?

Anchor to Fields with this unionFields with this union

•OBJECT

A condition that must pass for a delivery method definition to be applied to an order.


Was this section helpful?