Choose a version:

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 Arguments

Arguments

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

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to DeliveryProfileDeliveryProfile

•DeliveryProfile

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

Anchor to legacyModelegacyMode

•Boolean!

non-nullDeprecated

Anchor to productVariantsCountV2productVariantsCountV2

•DeliveryProductVariantsCount!

non-nullDeprecated

Was this section helpful?