DeliveryProfile

Version 2019-07

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

Required access

read_shipping access scope

Show definition
"""
A profile for multi-location, per-product delivery.
"""
type DeliveryProfile implements Node {
  """
  The number of active shipping rates for the profile.
  """
  activeMethodDefinitionsCount: Int!
  """
  Whether this is the default profile.
  """
  default: Boolean!
  """
  Globally unique identifier.
  """
  id: ID!
  """
  Whether this shop has enabled legacy compatibility mode for delivery profiles.
  """
  legacyMode: Boolean!
  """
  The number of locations without rates defined.
  """
  locationsWithoutRatesCount: Int!
  """
  The name of the delivery profile.
  """
  name: String!
  """
  The number of active origin locations for the profile.
  """
  originLocationCount: Int!
  """
  The number of product variants for this profile. The count for the default profile is not supported and will return -1.
  """
  productVariantsCount: Int!
  """
  The products and variants associated with this profile.
  """
  profileItems(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first `n` elements from the list.
    """
    first: Int
    """
    Returns up to the last `n` elements from the list.
    """
    last: Int
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
    """
    Sort the underlying list by the given key. This argument is deprecated: Profile item sorting is no longer supported.
    """
    sortKey: ProfileItemSortKeys = ID
  ): DeliveryProfileItemConnection!
  """
  The location groups and associated zones using this profile.
  """
  profileLocationGroups: [DeliveryProfileLocationGroup!]!
  """
  List of locations that have not been assigned to a location group for this profile.
  """
  unassignedLocations: [Location!]!
  """
  The number of countries with active rates to deliver to.
  """
  zoneCountryCount: Int!
}

Implements

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: true

sortKey ( ProfileItemSortKeys )

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

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.

productVariantsCount (Int!)

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

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.

Version 2019-10 (Latest)

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

Required access

read_shipping access scope

Show definition
"""
A profile for multi-location, per-product delivery.
"""
type DeliveryProfile implements Node {
  """
  The number of active shipping rates for the profile.
  """
  activeMethodDefinitionsCount: Int!
  """
  Whether this is the default profile.
  """
  default: Boolean!
  """
  Globally unique identifier.
  """
  id: ID!
  """
  Whether this shop has enabled legacy compatibility mode for delivery profiles.
  """
  legacyMode: Boolean!
  """
  The number of locations without rates defined.
  """
  locationsWithoutRatesCount: Int!
  """
  The name of the delivery profile.
  """
  name: String!
  """
  The number of active origin locations for the profile.
  """
  originLocationCount: Int!
  """
  The number of product variants for this profile. The count for the default profile is not supported and will return -1.
  """
  productVariantsCount: Int!
  """
  The products and variants associated with this profile.
  """
  profileItems(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first `n` elements from the list.
    """
    first: Int
    """
    Returns up to the last `n` elements from the list.
    """
    last: Int
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
    """
    Sort the underlying list by the given key. This argument is deprecated: Profile item sorting is no longer supported.
    """
    sortKey: ProfileItemSortKeys = ID
  ): DeliveryProfileItemConnection!
  """
  The location groups and associated zones using this profile.
  """
  profileLocationGroups: [DeliveryProfileLocationGroup!]!
  """
  List of locations that have not been assigned to a location group for this profile.
  """
  unassignedLocations: [Location!]!
  """
  The number of countries with active rates to deliver to.
  """
  zoneCountryCount: Int!
}

Implements

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: true

sortKey ( ProfileItemSortKeys )

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

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.

productVariantsCount (Int!)

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

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.

Version 2020-01 (Release candidate)

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

Required access

read_shipping access scope

Show definition
"""
A profile for multi-location, per-product delivery.
"""
type DeliveryProfile implements Node {
  """
  The number of active shipping rates for the profile.
  """
  activeMethodDefinitionsCount: Int!
  """
  Whether this is the default profile.
  """
  default: Boolean!
  """
  Globally unique identifier.
  """
  id: ID!
  """
  Whether this shop has enabled legacy compatibility mode for delivery profiles.
  """
  legacyMode: Boolean!
  """
  The number of locations without rates defined.
  """
  locationsWithoutRatesCount: Int!
  """
  The name of the delivery profile.
  """
  name: String!
  """
  The number of active origin locations for the profile.
  """
  originLocationCount: Int!
  """
  The number of product variants for this profile. The count for the default profile is not supported and will return -1.
  """
  productVariantsCount: Int!
  """
  The products and variants associated with this profile.
  """
  profileItems(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first `n` elements from the list.
    """
    first: Int
    """
    Returns up to the last `n` elements from the list.
    """
    last: Int
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
    """
    Sort the underlying list by the given key. This argument is deprecated: Profile item sorting is no longer supported.
    """
    sortKey: ProfileItemSortKeys = ID
  ): DeliveryProfileItemConnection!
  """
  The location groups and associated zones using this profile.
  """
  profileLocationGroups: [DeliveryProfileLocationGroup!]!
  """
  List of locations that have not been assigned to a location group for this profile.
  """
  unassignedLocations: [Location!]!
  """
  The number of countries with active rates to deliver to.
  """
  zoneCountryCount: Int!
}

Implements

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: true

sortKey ( ProfileItemSortKeys )

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

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.

productVariantsCount (Int!)

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

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.

Sign up for a Partner account to get started.

Sign up