Choose a version:

DeliveryProfile

object

A shipping profile that defines shipping rates for specific Product objects and ProductVariant objects. Delivery profiles determine which products can ship from which Location objects to which zones, and at what rates.

Profiles can associate with SellingPlanGroup objects to provide custom shipping rules for subscriptions, such as free shipping or restricted delivery zones. The default profile applies to all products that aren't assigned to other profiles.

Learn more about building delivery profiles.

Anchor to FieldsFields

Anchor to activeMethodDefinitionsCountactiveMethodDefinitionsCount

•Int!

non-null

The number of active shipping rates for the profile.

Anchor to defaultdefault

•Boolean!

non-null

Whether this is the default profile.

Anchor to idid

•ID!

non-null

A globally-unique ID.

Anchor to locationsWithoutRatesCountlocationsWithoutRatesCount

•Int!

non-null

The number of locations without rates defined.

Anchor to namename

•String!

non-null

The name of the delivery profile.

Anchor to originLocationCountoriginLocationCount

•Int!

non-null

The number of active origin locations for the profile.

Anchor to productVariantsCountproductVariantsCount

•Count

How many product variants are in this profile.

Anchor to profileItemsprofileItems

•DeliveryProfileItemConnection!

non-null

The products and variants associated with this profile.

Arguments

Anchor to firstfirst

•Int

The first n elements from the paginated list.

Anchor to afterafter

•String

The elements that come after the specified cursor.

Anchor to lastlast

•Int

The last n elements from the paginated list.

Anchor to beforebefore

•String

The elements that come before the specified cursor.

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey

•ProfileItemSortKeys

DeprecatedDefault:ID

Anchor to profileLocationGroupsprofileLocationGroups

•[DeliveryProfileLocationGroup!]!

non-null

The location groups and associated zones using this profile.

Anchor to locationGroupIdlocationGroupId •ID: Filter the location groups of the profile by location group ID.

Anchor to sellingPlanGroupssellingPlanGroups

•SellingPlanGroupConnection!

non-null

Selling plan groups associated with the specified delivery profile.

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

Anchor to unassignedLocationsunassignedLocations

•[Location!]!

non-null

List of locations that haven't been assigned to a location group for this profile.

Anchor to unassignedLocationsPaginatedunassignedLocationsPaginated

•LocationConnection!

non-null

List of locations that have not been assigned to a location group for this profile.

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

Anchor to versionversion

•Int!

non-null

The version of the delivery profile.

Anchor to zoneCountryCountzoneCountryCount

•Int!

non-null

The number of countries with active rates to deliver to.

Deprecated fields

Anchor to legacyModelegacyMode •Boolean! non-nullDeprecated
Anchor to productVariantsCountV2productVariantsCountV2 •DeliveryProductVariantsCount! non-nullDeprecated

Was this section helpful?

Anchor to QueriesQueries

Anchor to deliveryProfile deliveryProfile

•query

Retrieves a DeliveryProfile by ID. Delivery profiles group shipping settings for specific Product objects that ship from selected Location objects to [delivery zones](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryZone with defined rates.

Learn more about delivery profiles.

Anchor to idid •ID! required: The ID of the DeliveryProfile to return.

Anchor to deliveryProfiles deliveryProfiles

•query

Returns a paginated list of DeliveryProfile objects for the shop. Delivery profiles group Product and ProductVariant objects that share shipping rates and zones.

Each profile contains DeliveryLocationGroup objects that organize fulfillment Location objects and their associated delivery zones. DeliveryZone objects define geographic regions with specific shipping methods and rates. Use the merchantOwnedOnly filter to exclude profiles that third-party apps manage.

Learn more about delivery profiles.

Anchor to merchantOwnedOnlymerchantOwnedOnly •Boolean: If true, returns only delivery profiles that were created by the merchant.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Was this section helpful?

Anchor to MutationsMutations

Anchor to deliveryProfileCreate deliveryProfileCreate

•mutation

Creates a DeliveryProfile that defines shipping rates for specific products and locations.

A delivery profile groups products with their shipping zones and rates. You can associate profiles with SellingPlanGroup objects to customize shipping for subscriptions and pre-orders. Each profile contains DeliveryProfileLocationGroup objects that specify which Location objects ship to which DeliveryZone objects with specific DeliveryMethodDefinition objects and rates.

Learn more about building delivery profiles.

Arguments

Anchor to profileprofile

•DeliveryProfileInput!

required

Specifies the input fields for a delivery profile.

Anchor to deliveryProfileUpdate deliveryProfileUpdate

•mutation

Updates a DeliveryProfile's configuration, including its shipping zones, rates, and associated products.

Modify location groups to control which fulfillment Location objects serve specific geographic areas. Add or remove shipping zones with custom countries and provinces. Create or update shipping methods with rate definitions and delivery conditions. Associate or dissociate ProductVariant objects and SellingPlanGroup objects to determine which products use this profile's shipping rules.

The mutation supports partial updates through dedicated input fields for creating, updating, and deleting specific components without affecting the entire profile structure.

Learn more about building delivery profiles.