Delivery
Requires for queries and both as well as for mutations.
A shipping option shown to buyers at checkout. Implemented by concrete option types.
Anchor to FieldsFields
- currency (CurrencyCode!)
- description (String)
- freeDeliveryMinimumValue (MoneyV2)
- id (ID!)
- includedCollections (CollectionConnection)
- includedLocations (LocationConnection)
- isActive (Boolean!)
- Anchor to currencycurrency•Currency
Code! non-null The currency used for all money values in this shipping option.
- Anchor to descriptiondescription•String
Optional description shown to buyers.
- Anchor to freeDeliveryMinimumValuefree•Money
Delivery Minimum Value V2 The cart subtotal required for free shipping. Null if no threshold is set.
- •ID!non-null
A globally unique ID for this shipping option.
- Anchor to includedCollectionsincluded•Collection
Collections Connection 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
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to includedLocationsincluded•Location
Locations Connection 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
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to isActiveis•Boolean!
Active non-null Whether this shipping option is active and shown to buyers.
Anchor to Types implemented inTypes implemented in
- DeliveryCarrierCalculatedOptionDefinition (DeliveryCarrierCalculatedOptionDefinition)
- DeliveryFlatRateOptionDefinition (DeliveryFlatRateOptionDefinition)
- DeliveryValueBasedOptionDefinition (DeliveryValueBasedOptionDefinition)
- DeliveryWeightBasedOptionDefinition (DeliveryWeightBasedOptionDefinition)
- •OBJECT
A shipping option with rates calculated by a carrier service.
Carrier-calculated options fetch real-time rates from carriers(e.g., UPS, FedEx) at checkout instead of using merchant-defined fixed prices.
- Anchor to currencycurrency•Currency
Code! non-null The currency used for all money values in this shipping option.
- Anchor to descriptiondescription•String
Optional description shown to buyers.
- Anchor to freeDeliveryMinimumValuefree•Money
Delivery Minimum Value V2 The cart subtotal required for free shipping. Null if no threshold is set.
- •ID!non-null
A globally unique ID for this shipping option.
- Anchor to includedCollectionsincluded•Collection
Collections Connection 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
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to includedLocationsincluded•Location
Locations Connection 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
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to isActiveis•Boolean!
Active non-null Whether this shipping option is active and shown to buyers.
- Anchor to rateGrouprate•Delivery
Group Carrier Calculated Rate Group! non-null The rate group for this carrier-calculated shipping option.
- •OBJECT
A shipping option with fixed-price rates.
Flat rate options charge the same price regardless of cart value or weight.
- Anchor to currencycurrency•Currency
Code! non-null The currency used for all money values in this shipping option.
- Anchor to descriptiondescription•String
Optional description shown to buyers.
- Anchor to freeDeliveryMinimumValuefree•Money
Delivery Minimum Value V2 The cart subtotal required for free shipping. Null if no threshold is set.
- •ID!non-null
A globally unique ID for this shipping option.
- Anchor to includedCollectionsincluded•Collection
Collections Connection 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
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to includedLocationsincluded•Location
Locations Connection 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
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to isActiveis•Boolean!
Active non-null Whether this shipping option is active and shown to buyers.
- Anchor to namename•String!non-null
The name shown to buyers for this shipping option.
- Anchor to rateGroupsrate•Delivery
Groups Flat Rate Group Connection The flat rate groups for this shipping option.
- 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
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- •OBJECT
A shipping option with rates based on cart value.
Value-based options charge different rates depending on cart value, using tiers that define price thresholds (e.g., "$5 shipping under $50, $2 shipping over $50").
- Anchor to currencycurrency•Currency
Code! non-null The currency used for all money values in this shipping option.
- Anchor to descriptiondescription•String
Optional description shown to buyers.
- Anchor to freeDeliveryMinimumValuefree•Money
Delivery Minimum Value V2 The cart subtotal required for free shipping. Null if no threshold is set.
- •ID!non-null
A globally unique ID for this shipping option.
- Anchor to includedCollectionsincluded•Collection
Collections Connection 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
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to includedLocationsincluded•Location
Locations Connection 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
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to isActiveis•Boolean!
Active non-null Whether this shipping option is active and shown to buyers.
- Anchor to namename•String!non-null
The name shown to buyers for this shipping option.
- Anchor to rateGroupsrate•Delivery
Groups Value Based Rate Group Connection! non-null The rate groups for this value-based shipping option.
- 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
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- •OBJECT
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 currencycurrency•Currency
Code! non-null The currency used for all money values in this shipping option.
- Anchor to descriptiondescription•String
Optional description shown to buyers.
- Anchor to freeDeliveryMinimumValuefree•Money
Delivery Minimum Value V2 The cart subtotal required for free shipping. Null if no threshold is set.
- •ID!non-null
A globally unique ID for this shipping option.
- Anchor to includedCollectionsincluded•Collection
Collections Connection 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
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to includedLocationsincluded•Location
Locations Connection 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
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to isActiveis•Boolean!
Active non-null Whether this shipping option is active and shown to buyers.
- Anchor to namename•String!non-null
The name shown to buyers for this shipping option.
- Anchor to rateGrouprate•Delivery
Group Weight Based Rate Group! non-null The rate group for this weight-based shipping option.