DeliveryLocationGroup

Version 2019-07 (Latest)

A location group is a collection of active locations that share zone and delivery methods across delivery profiles.

Required access

read_shipping access scope

Show definition
"""
A location group is a collection of active locations that share zone and delivery methods across delivery profiles.
"""
type DeliveryLocationGroup implements Node {
  """
  Globally unique identifier.
  """
  id: ID!
  """
  List of active locations that are part of this location group.
  """
  locations(
    """
    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
    """
    If true, also include the locations that are deactivated.
    """
    includeInactive: Boolean = false
    """
    If true, also include the legacy locations of fulfillment services.
    """
    includeLegacy: Boolean = false
    """
    Returns up to the last `n` elements from the list.
    """
    last: Int
    """
    Supported filter parameters:
     - `active`
     - `address1`
     - `address2`
     - `city`
     - `country`
     - `legacy`
     - `name`
     - `province`
     - `zip`
    See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax).
    """
    query: String
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
    """
    Sort the underlying list by the given key.
    """
    sortKey: LocationSortKeys = NAME
  ): LocationConnection!
}

Implements

Connections

locations (LocationConnection!)

List of active locations that are part of this location group.

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.

includeInactive ( Boolean )

If true, also include the locations that are deactivated.
Default value: true

includeLegacy ( Boolean )

If true, also include the legacy locations of fulfillment services.
Default value: true

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • active
  • address1
  • address2
  • city
  • country
  • legacy
  • name
  • province
  • zip

See the detailed search syntax.

reverse ( Boolean )

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

sortKey ( LocationSortKeys )

Sort the underlying list by the given key.
Default value: true

Fields

id (ID!)

Globally unique identifier.

Version 2019-10 (Release candidate)

A location group is a collection of active locations that share zone and delivery methods across delivery profiles.

Required access

read_shipping access scope

Show definition
"""
A location group is a collection of active locations that share zone and delivery methods across delivery profiles.
"""
type DeliveryLocationGroup implements Node {
  """
  Globally unique identifier.
  """
  id: ID!
  """
  List of active locations that are part of this location group.
  """
  locations(
    """
    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
    """
    If true, also include the locations that are deactivated.
    """
    includeInactive: Boolean = false
    """
    If true, also include the legacy locations of fulfillment services.
    """
    includeLegacy: Boolean = false
    """
    Returns up to the last `n` elements from the list.
    """
    last: Int
    """
    Supported filter parameters:
     - `active`
     - `address1`
     - `address2`
     - `city`
     - `country`
     - `legacy`
     - `name`
     - `province`
     - `zip`
    See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax).
    """
    query: String
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
    """
    Sort the underlying list by the given key.
    """
    sortKey: LocationSortKeys = NAME
  ): LocationConnection!
}

Implements

Connections

locations (LocationConnection!)

List of active locations that are part of this location group.

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.

includeInactive ( Boolean )

If true, also include the locations that are deactivated.
Default value: true

includeLegacy ( Boolean )

If true, also include the legacy locations of fulfillment services.
Default value: true

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • active
  • address1
  • address2
  • city
  • country
  • legacy
  • name
  • province
  • zip

See the detailed search syntax.

reverse ( Boolean )

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

sortKey ( LocationSortKeys )

Sort the underlying list by the given key.
Default value: true

Fields

id (ID!)

Globally unique identifier.

Sign up for a Partner account to get started.

Sign up