DeliveryProfile object

A profile for multi-location, per-product delivery.

On this page

Connections

  • profileItems ([DeliveryProfileItemConnection!](https://shopify.dev/docs/admin-api/graphql/reference/shipping-and-fulfillment/deliveryprofileitem))
    The products and variants associated with this profile.
Argument Description
after
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 Returns the elements that come after the specified cursor.
before
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 Returns the elements that come before the specified cursor.
first
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

)		 Returns up to the first n elements from the list.
last
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

)		 Returns up to the last n elements from the list.
reverse
(
[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)

)		 Reverse the order of the underlying list.
Default value: false
sortKey
(
[ProfileItemSortKeys](https://shopify.dev/docs/admin-api/graphql/reference/shipping-and-fulfillment/profileitemsortkeys)

)		 Sort the underlying list by the given key. This argument is deprecated: Profile item sorting is no longer supported.
Default value: ID
  • sellingPlanGroups ([SellingPlanGroupConnection!](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/sellingplangroup))
    Selling Plan Groups associated with the specified Delivery Profile.
Argument Description
after
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 Returns the elements that come after the specified cursor.
before
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 Returns the elements that come before the specified cursor.
first
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

)		 Returns up to the first n elements from the list.
last
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

)		 Returns up to the last n elements from the list.
reverse
(
[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)

)		 Reverse the order of the underlying list.
Default value: false

  • Fields

  • activeMethodDefinitionsCount ([Int!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01))
    The number of active shipping rates for the profile.
  • default ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
    Whether this is the default profile.
  • id ([ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
    Globally unique identifier.
  • legacyMode ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
    Whether this shop has enabled legacy compatibility mode for delivery profiles.
  • locationsWithoutRatesCount ([Int!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01))
    The number of locations without rates defined.
  • name ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The name of the delivery profile.
  • originLocationCount ([Int!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01))
    The number of active origin locations for the profile.
  • productVariantsCountV2 ([DeliveryProductVariantsCount!](https://shopify.dev/docs/admin-api/graphql/reference/shipping-and-fulfillment/deliveryproductvariantscount))
    How many product variants are in this profile.
  • profileLocationGroups ([[DeliveryProfileLocationGroup!]!](https://shopify.dev/docs/admin-api/graphql/reference/shipping-and-fulfillment/deliveryprofilelocationgroup))
    The location groups and associated zones using this profile.
  • unassignedLocations ([[Location!]!](https://shopify.dev/docs/admin-api/graphql/reference/store-properties/location))
    List of locations that have not been assigned to a location group for this profile.
  • zoneCountryCount ([Int!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01))
    The number of countries with active rates to deliver to.

Types that return DeliveryProfile

  • [ProductVariant.deliveryProfile](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/productvariant#deliveryprofile-2021-01)
  • [QueryRoot.deliveryProfile](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/queryroot#deliveryprofile-2021-01)
  • [QueryRoot.deliveryProfiles](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/queryroot#deliveryprofiles-2021-01)

Mutations for DeliveryProfile

Implements

  • [Node](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/node)

Deprecated fields

Show/Hide

An auto-generated type for paginating through multiple DeliveryProfiles.

On this page

Fields

  • edges ([[DeliveryProfileEdge!]!](https://shopify.dev/docs/admin-api/graphql/reference/shipping-and-fulfillment/deliveryprofile))
    A list of edges.
  • pageInfo ([PageInfo!](https://shopify.dev/docs/admin-api/graphql/reference/pageinfo))
    Information to aid in pagination.

An auto-generated type which holds one DeliveryProfile and a cursor during pagination.

On this page

Fields

  • cursor ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    A cursor for use in pagination.
  • node ([DeliveryProfile!](https://shopify.dev/docs/admin-api/graphql/reference/shipping-and-fulfillment/deliveryprofile))
    The item at the end of DeliveryProfileEdge.

Types that return DeliveryProfileEdge

  • [DeliveryProfileConnection.edges](https://shopify.dev/docs/admin-api/graphql/reference/shipping-and-fulfillment/deliveryprofile#edges-2021-01)