Skip to main content

Choose a version:

Anchor to DeliveryCarrierCalculatedOptionDefinition

DeliveryCarrierCalculatedOptionDefinition

object

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

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 FieldsFields

Anchor to currencycurrency

•CurrencyCode!

non-null

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

Anchor to descriptiondescription

Optional description shown to buyers.

Anchor to freeDeliveryMinimumValuefreeDeliveryMinimumValue

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 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.

Anchor to isActiveisActive

non-null

Whether this shipping option is active and shown to buyers.

Anchor to rateGrouprateGroup

•DeliveryCarrierCalculatedRateGroup!

non-null

The rate group for this carrier-calculated shipping option.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to DeliveryOptionDefinition DeliveryOptionDefinition •interface

Was this section helpful?