DeliveryWeightBasedOptionDefinition

object

Requires read_markets for queries and both read_markets as well as write_markets for mutations.

A shipping option with rates based on package weight.

Rates contain tiers that define package-weight thresholds. Checkout selects the appropriate tier using the package weight of the shipping allocation, or the combined package weight when allocations are grouped for weight conditions.

Anchor to FieldsFields

Anchor to currencycurrency

•CurrencyCode!

non-null

The currency used for all money values in this shipping option.

Anchor to descriptiondescription

•String

Optional description shown to buyers.

Anchor to freeDeliveryMinimumValuefreeDeliveryMinimumValue

•MoneyV2

The cart subtotal required for free shipping. Null if no threshold is set.

Anchor to idid

•ID!

non-null

A globally unique ID for this shipping option.

Anchor to includedCollectionsincludedCollections

•CollectionConnection

Collections that any rate group in this shipping option applies to.

Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to includedLocationsincludedLocations

•LocationConnection

Origin locations that any rate group in this shipping option applies to.

Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.