Skip to main content
Anchor to DeliveryWeightBasedOptionDefinition

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.

•CurrencyCode!
non-null

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

Show enum values
•String

Optional description shown to buyers.

Anchor to freeDeliveryMinimumValuefreeDeliveryMinimumValue
•MoneyV2

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

Show fields
•ID!
non-null

A globally unique ID for this shipping option.

•CollectionConnection

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

Show fields

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•Boolean
Default:false

Reverse the order of the underlying list.


•LocationConnection

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

Show fields

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•Boolean
Default:false

Reverse the order of the underlying list.


•Boolean!
non-null

Whether this shipping option is active and shown to buyers.

•String!
non-null

The name shown to buyers for this shipping option.

•DeliveryWeightBasedRateGroupConnection

The rate groups for this weight-based shipping option.

Show fields

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•Boolean
Default:false

Reverse the order of the underlying list.



Was this section helpful?


Was this section helpful?