API version: unstable
API version: 2021-01 Release candidate
API version: 2020-10 Latest
API version: 2020-07
API version: 2020-04
API version: 2020-01
API version: 2019-10 Unsupported
API version: 2019-07 Unsupported

DeliveryProfile object

Version unstable

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

Connections

profileItems (DeliveryProfileItemConnection!)

The products and variants associated with this profile.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

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

sortKey ( 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!)

Selling Plan Groups associated with the specified Delivery Profile.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

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

Fields

activeMethodDefinitionsCount (Int!)

The number of active shipping rates for the profile.

default (Boolean!)

Whether this is the default profile.

id (ID!)

Globally unique identifier.

legacyMode (Boolean!)

Whether this shop has enabled legacy compatibility mode for delivery profiles.

locationsWithoutRatesCount (Int!)

The number of locations without rates defined.

name (String!)

The name of the delivery profile.

originLocationCount (Int!)

The number of active origin locations for the profile.

productVariantsCountV2 (DeliveryProductVariantsCount!)

How many product variants are in this profile.

profileLocationGroups ([DeliveryProfileLocationGroup!]!)

The location groups and associated zones using this profile.

unassignedLocations ([Location!]!)

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

zoneCountryCount (Int!)

The number of countries with active rates to deliver to.

Types that return DeliveryProfile

Mutations for DeliveryProfile

deliveryProfileCreate

Creates a delivery profile.

deliveryProfileRemove

Enqueues the deletion/removal of a delivery profile.

deliveryProfileUpdate

Updates a delivery profile.

Implements

Deprecated fields

productVariantsCount (Int!) deprecated

The number of product variants for this profile. The count for the default profile is not supported and will return -1.

Deprecation warning

Use productVariantsCountV2 instead

Version unstable

Fields

edges ([DeliveryProfileEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Types that return DeliveryProfile

Mutations for DeliveryProfile

deliveryProfileCreate

Creates a delivery profile.

deliveryProfileRemove

Enqueues the deletion/removal of a delivery profile.

deliveryProfileUpdate

Updates a delivery profile.

Version unstable

Fields

cursor (String!)

A cursor for use in pagination.

node (DeliveryProfile!)

The item at the end of DeliveryProfileEdge.

Types that return DeliveryProfile

Mutations for DeliveryProfile

deliveryProfileCreate

Creates a delivery profile.

deliveryProfileRemove

Enqueues the deletion/removal of a delivery profile.

deliveryProfileUpdate

Updates a delivery profile.

Version 2021-01 (Release candidate)

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

Connections

profileItems (DeliveryProfileItemConnection!)

The products and variants associated with this profile.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

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

sortKey ( 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!)

Selling Plan Groups associated with the specified Delivery Profile.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

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

Fields

activeMethodDefinitionsCount (Int!)

The number of active shipping rates for the profile.

default (Boolean!)

Whether this is the default profile.

id (ID!)

Globally unique identifier.

legacyMode (Boolean!)

Whether this shop has enabled legacy compatibility mode for delivery profiles.

locationsWithoutRatesCount (Int!)

The number of locations without rates defined.

name (String!)

The name of the delivery profile.

originLocationCount (Int!)

The number of active origin locations for the profile.

productVariantsCountV2 (DeliveryProductVariantsCount!)

How many product variants are in this profile.

profileLocationGroups ([DeliveryProfileLocationGroup!]!)

The location groups and associated zones using this profile.

unassignedLocations ([Location!]!)

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

zoneCountryCount (Int!)

The number of countries with active rates to deliver to.

Types that return DeliveryProfile

Mutations for DeliveryProfile

deliveryProfileCreate

Creates a delivery profile.

deliveryProfileRemove

Enqueues the deletion/removal of a delivery profile.

deliveryProfileUpdate

Updates a delivery profile.

Implements

Deprecated fields

productVariantsCount (Int!) deprecated

The number of product variants for this profile. The count for the default profile is not supported and will return -1.

Deprecation warning

Use productVariantsCountV2 instead

Version 2021-01 (Release candidate)

On this page

Fields

edges ([DeliveryProfileEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Version 2021-01 (Release candidate)

Fields

cursor (String!)

A cursor for use in pagination.

node (DeliveryProfile!)

The item at the end of DeliveryProfileEdge.

Types that return DeliveryProfileEdge

Version 2020-10 (Latest)

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

Connections

profileItems (DeliveryProfileItemConnection!)

The products and variants associated with this profile.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

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

sortKey ( ProfileItemSortKeys )

Sort the underlying list by the given key. This argument is deprecated: Profile item sorting is no longer supported.Default value: ID

Fields

activeMethodDefinitionsCount (Int!)

The number of active shipping rates for the profile.

default (Boolean!)

Whether this is the default profile.

id (ID!)

Globally unique identifier.

legacyMode (Boolean!)

Whether this shop has enabled legacy compatibility mode for delivery profiles.

locationsWithoutRatesCount (Int!)

The number of locations without rates defined.

name (String!)

The name of the delivery profile.

originLocationCount (Int!)

The number of active origin locations for the profile.

productVariantsCountV2 (DeliveryProductVariantsCount!)

How many product variants are in this profile.

profileLocationGroups ([DeliveryProfileLocationGroup!]!)

The location groups and associated zones using this profile.

unassignedLocations ([Location!]!)

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

zoneCountryCount (Int!)

The number of countries with active rates to deliver to.

Types that return DeliveryProfile

Mutations for DeliveryProfile

deliveryProfileCreate

Creates a delivery profile.

deliveryProfileRemove

Enqueues the deletion/removal of a delivery profile.

deliveryProfileUpdate

Updates a delivery profile.

Implements

Deprecated fields

productVariantsCount (Int!) deprecated

The number of product variants for this profile. The count for the default profile is not supported and will return -1.

Deprecation warning

Use productVariantsCountV2 instead

Version 2020-10 (Latest)

On this page

Fields

edges ([DeliveryProfileEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Version 2020-10 (Latest)

Fields

cursor (String!)

A cursor for use in pagination.

node (DeliveryProfile!)

The item at the end of DeliveryProfileEdge.

Types that return DeliveryProfileEdge

Version 2020-07

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

Connections

profileItems (DeliveryProfileItemConnection!)

The products and variants associated with this profile.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

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

sortKey ( ProfileItemSortKeys )

Sort the underlying list by the given key. This argument is deprecated: Profile item sorting is no longer supported.Default value: ID

Fields

activeMethodDefinitionsCount (Int!)

The number of active shipping rates for the profile.

default (Boolean!)

Whether this is the default profile.

id (ID!)

Globally unique identifier.

legacyMode (Boolean!)

Whether this shop has enabled legacy compatibility mode for delivery profiles.

locationsWithoutRatesCount (Int!)

The number of locations without rates defined.

name (String!)

The name of the delivery profile.

originLocationCount (Int!)

The number of active origin locations for the profile.

productVariantsCountV2 (DeliveryProductVariantsCount!)

How many product variants are in this profile.

profileLocationGroups ([DeliveryProfileLocationGroup!]!)

The location groups and associated zones using this profile.

unassignedLocations ([Location!]!)

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

zoneCountryCount (Int!)

The number of countries with active rates to deliver to.

Types that return DeliveryProfile

Mutations for DeliveryProfile

deliveryProfileCreate

Creates a delivery profile.

deliveryProfileRemove

Enqueues the deletion/removal of a delivery profile.

deliveryProfileUpdate

Updates a delivery profile.

Implements

Deprecated fields

productVariantsCount (Int!) deprecated

The number of product variants for this profile. The count for the default profile is not supported and will return -1.

Deprecation warning

Use productVariantsCountV2 instead

Version 2020-07

On this page

Fields

edges ([DeliveryProfileEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Version 2020-07

Fields

cursor (String!)

A cursor for use in pagination.

node (DeliveryProfile!)

The item at the end of DeliveryProfileEdge.

Types that return DeliveryProfileEdge

Version 2020-04

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

Connections

profileItems (DeliveryProfileItemConnection!)

The products and variants associated with this profile.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

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

sortKey ( ProfileItemSortKeys )

Sort the underlying list by the given key. This argument is deprecated: Profile item sorting is no longer supported.Default value: ID

Fields

activeMethodDefinitionsCount (Int!)

The number of active shipping rates for the profile.

default (Boolean!)

Whether this is the default profile.

id (ID!)

Globally unique identifier.

legacyMode (Boolean!)

Whether this shop has enabled legacy compatibility mode for delivery profiles.

locationsWithoutRatesCount (Int!)

The number of locations without rates defined.

name (String!)

The name of the delivery profile.

originLocationCount (Int!)

The number of active origin locations for the profile.

productVariantsCountV2 (DeliveryProductVariantsCount!)

How many product variants are in this profile.

profileLocationGroups ([DeliveryProfileLocationGroup!]!)

The location groups and associated zones using this profile.

unassignedLocations ([Location!]!)

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

zoneCountryCount (Int!)

The number of countries with active rates to deliver to.

Types that return DeliveryProfile

Mutations for DeliveryProfile

deliveryProfileCreate

Creates a delivery profile.

deliveryProfileRemove

Enqueues the deletion/removal of a delivery profile.

deliveryProfileUpdate

Updates a delivery profile.

Implements

Deprecated fields

productVariantsCount (Int!) deprecated

The number of product variants for this profile. The count for the default profile is not supported and will return -1.

Deprecation warning

Use productVariantsCountV2 instead

Version 2020-04

On this page

Fields

edges ([DeliveryProfileEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Version 2020-04

Fields

cursor (String!)

A cursor for use in pagination.

node (DeliveryProfile!)

The item at the end of DeliveryProfileEdge.

Types that return DeliveryProfileEdge

Version 2020-01

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

Connections

profileItems (DeliveryProfileItemConnection!)

The products and variants associated with this profile.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

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

sortKey ( ProfileItemSortKeys )

Sort the underlying list by the given key. This argument is deprecated: Profile item sorting is no longer supported.Default value: ID

Fields

activeMethodDefinitionsCount (Int!)

The number of active shipping rates for the profile.

default (Boolean!)

Whether this is the default profile.

id (ID!)

Globally unique identifier.

legacyMode (Boolean!)

Whether this shop has enabled legacy compatibility mode for delivery profiles.

locationsWithoutRatesCount (Int!)

The number of locations without rates defined.

name (String!)

The name of the delivery profile.

originLocationCount (Int!)

The number of active origin locations for the profile.

productVariantsCountV2 (DeliveryProductVariantsCount!)

How many product variants are in this profile.

profileLocationGroups ([DeliveryProfileLocationGroup!]!)

The location groups and associated zones using this profile.

unassignedLocations ([Location!]!)

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

zoneCountryCount (Int!)

The number of countries with active rates to deliver to.

Types that return DeliveryProfile

Mutations for DeliveryProfile

deliveryProfileCreate

Creates a delivery profile.

deliveryProfileRemove

Enqueues the deletion/removal of a delivery profile.

deliveryProfileUpdate

Updates a delivery profile.

Implements

Deprecated fields

productVariantsCount (Int!) deprecated

The number of product variants for this profile. The count for the default profile is not supported and will return -1.

Deprecation warning

Use productVariantsCountV2 instead

Version 2020-01

On this page

Fields

edges ([DeliveryProfileEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Version 2020-01

Fields

cursor (String!)

A cursor for use in pagination.

node (DeliveryProfile!)

The item at the end of DeliveryProfileEdge.

Types that return DeliveryProfileEdge

Version 2019-10 (Unsupported)

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

Connections

profileItems (DeliveryProfileItemConnection!)

The products and variants associated with this profile.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

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

sortKey ( ProfileItemSortKeys )

Sort the underlying list by the given key. This argument is deprecated: Profile item sorting is no longer supported.Default value: ID

Fields

activeMethodDefinitionsCount (Int!)

The number of active shipping rates for the profile.

default (Boolean!)

Whether this is the default profile.

id (ID!)

Globally unique identifier.

legacyMode (Boolean!)

Whether this shop has enabled legacy compatibility mode for delivery profiles.

locationsWithoutRatesCount (Int!)

The number of locations without rates defined.

name (String!)

The name of the delivery profile.

originLocationCount (Int!)

The number of active origin locations for the profile.

productVariantsCountV2 (DeliveryProductVariantsCount!)

How many product variants are in this profile.

profileLocationGroups ([DeliveryProfileLocationGroup!]!)

The location groups and associated zones using this profile.

unassignedLocations ([Location!]!)

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

zoneCountryCount (Int!)

The number of countries with active rates to deliver to.

Types that return DeliveryProfile

Mutations for DeliveryProfile

deliveryProfileCreate

Creates a delivery profile.

deliveryProfileRemove

Enqueues the deletion/removal of a delivery profile.

deliveryProfileUpdate

Updates a delivery profile.

Implements

Deprecated fields

productVariantsCount (Int!) deprecated

The number of product variants for this profile. The count for the default profile is not supported and will return -1.

Deprecation warning

Use productVariantsCountV2 instead

Version 2019-10 (Unsupported)

On this page

Fields

edges ([DeliveryProfileEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Version 2019-10 (Unsupported)

Fields

cursor (String!)

A cursor for use in pagination.

node (DeliveryProfile!)

The item at the end of DeliveryProfileEdge.

Types that return DeliveryProfileEdge

Version 2019-07 (Unsupported)

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

Connections

profileItems (DeliveryProfileItemConnection!)

The products and variants associated with this profile.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

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

sortKey ( ProfileItemSortKeys )

Sort the underlying list by the given key. This argument is deprecated: Profile item sorting is no longer supported.Default value: ID

Fields

activeMethodDefinitionsCount (Int!)

The number of active shipping rates for the profile.

default (Boolean!)

Whether this is the default profile.

id (ID!)

Globally unique identifier.

legacyMode (Boolean!)

Whether this shop has enabled legacy compatibility mode for delivery profiles.

locationsWithoutRatesCount (Int!)

The number of locations without rates defined.

name (String!)

The name of the delivery profile.

originLocationCount (Int!)

The number of active origin locations for the profile.

productVariantsCountV2 (DeliveryProductVariantsCount!)

How many product variants are in this profile.

profileLocationGroups ([DeliveryProfileLocationGroup!]!)

The location groups and associated zones using this profile.

unassignedLocations ([Location!]!)

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

zoneCountryCount (Int!)

The number of countries with active rates to deliver to.

Types that return DeliveryProfile

Mutations for DeliveryProfile

deliveryProfileCreate

Creates a delivery profile.

deliveryProfileRemove

Enqueues the deletion/removal of a delivery profile.

deliveryProfileUpdate

Updates a delivery profile.

Implements

Deprecated fields

productVariantsCount (Int!) deprecated

The number of product variants for this profile. The count for the default profile is not supported and will return -1.

Deprecation warning

Use productVariantsCountV2 instead

Version 2019-07 (Unsupported)

On this page

Fields

edges ([DeliveryProfileEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Version 2019-07 (Unsupported)

Fields

cursor (String!)

A cursor for use in pagination.

node (DeliveryProfile!)

The item at the end of DeliveryProfileEdge.

Types that return DeliveryProfileEdge

Version 2019-04 (Unsupported)

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

Connections

profileItems (DeliveryProfileItemConnection!)

The products and variants associated with this profile.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

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

sortKey ( ProfileItemSortKeys )

Sort the underlying list by the given key. This argument is deprecated: Profile item sorting is no longer supported.Default value: ID

Fields

activeMethodDefinitionsCount (Int!)

The number of active shipping rates for the profile.

default (Boolean!)

Whether this is the default profile.

id (ID!)

Globally unique identifier.

legacyMode (Boolean!)

Whether this shop has enabled legacy compatibility mode for delivery profiles.

locationsWithoutRatesCount (Int!)

The number of locations without rates defined.

name (String!)

The name of the delivery profile.

originLocationCount (Int!)

The number of active origin locations for the profile.

productVariantsCountV2 (DeliveryProductVariantsCount!)

How many product variants are in this profile.

profileLocationGroups ([DeliveryProfileLocationGroup!]!)

The location groups and associated zones using this profile.

unassignedLocations ([Location!]!)

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

zoneCountryCount (Int!)

The number of countries with active rates to deliver to.

Types that return DeliveryProfile

Mutations for DeliveryProfile

deliveryProfileCreate

Creates a delivery profile.

deliveryProfileRemove

Enqueues the deletion/removal of a delivery profile.

deliveryProfileUpdate

Updates a delivery profile.

Implements

Deprecated fields

productVariantsCount (Int!) deprecated

The number of product variants for this profile. The count for the default profile is not supported and will return -1.

Deprecation warning

Use productVariantsCountV2 instead

Version 2019-04 (Unsupported)

On this page

Fields

edges ([DeliveryProfileEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Version 2019-04 (Unsupported)

Fields

cursor (String!)

A cursor for use in pagination.

node (DeliveryProfile!)

The item at the end of DeliveryProfileEdge.

Types that return DeliveryProfileEdge

Samples