Skip to main content
Anchor to DeliveryOptionDefinitionRateGroup

DeliveryOptionDefinitionRateGroup

interface

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

A delivery rate group within an option definition.

•DeliveryRateGroupConditions!
non-null

Conditions that scope this rate group to specific collections or origin locations.

•ID!
non-null

A globally-unique ID.


Was this section helpful?

Anchor to Types implemented inTypes implemented in

•OBJECT

A rate group for a carrier-calculated shipping option.

Sets the carrier service, rate adjustments, and carrier-provided services offered at checkout.

•MoneyV2

The flat amount added to or subtracted from carrier rates.

Anchor to autoIncludeNewServicesautoIncludeNewServices
•Boolean!
non-null

Whether new services from this carrier are automatically included at checkout. When true, buyers see any service that isn't excluded. When false, buyers see only included services.

•DeliveryCarrierService!
non-null

The carrier service that provides rates for this rate group.

•DeliveryRateGroupConditions!
non-null

Conditions that limit this rate group to specific collections or origin locations.

•ID!
non-null

A globally unique ID.

Anchor to percentageAdjustmentpercentageAdjustment
•Int

The percentage added to or subtracted from carrier rates. Applied after absoluteAdjustment. A value of 10 means +10%.

Anchor to serviceConfigurationserviceConfiguration
•[DeliveryCarrierCalculatedRateGroupService!]!
non-null

Carrier-provided services included or excluded for this rate group.

•OBJECT

A flat rate group for a shipping option.

Contains one fixed-price rate and optional collection or origin location conditions.

•DeliveryRateGroupConditions!
non-null

Conditions that limit this rate group to specific collections or origin locations.

•ID!
non-null

A globally unique ID.

•DeliveryFlatRate!
non-null

The fixed-price rate and optional transit time.

•OBJECT

A rate group for a value-based shipping option.

Contains rates that define price tiers based on cart value.

•DeliveryRateGroupConditions!
non-null

Conditions that limit this rate group to specific collections or origin locations.

•ID!
non-null

A globally unique ID.

•DeliveryValueBasedRateConnection!
non-null

The value-based rates in this rate group.

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.


•OBJECT

A rate group for a weight-based shipping option.

Contains rates that define price tiers based on package weight.

•DeliveryRateGroupConditions!
non-null

Conditions that limit this rate group to specific collections or origin locations.

•ID!
non-null

A globally unique ID.

•DeliveryWeightBasedRateConnection!
non-null

The weight-based rates in this rate group.

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?