DeliveryLocationGroup object

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

On this page

Connections

  • locations ([LocationConnection!](https://shopify.dev/docs/admin-api/graphql/reference/store-properties/location))
    List of active locations that are part of this location group.
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.
includeInactive
(
[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)

)		 If true, also include the locations that are deactivated.
Default value: false
includeLegacy
(
[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)

)		 If true, also include the legacy locations of fulfillment services.
Default value: false
last
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

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

)		 Supported filter parameters:
+ active
+ address1
+ address2
+ city
+ country
+ legacy
+ name
+ province
+ zip
See the detailed search syntax for more information about using filters.
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
(
[LocationSortKeys](https://shopify.dev/docs/admin-api/graphql/reference/store-properties/locationsortkeys)

)		 Sort the underlying list by the given key.
Default value: NAME

  • Fields

  • id ([ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
    Globally unique identifier.

Types that return DeliveryLocationGroup

  • [DeliveryProfileLocationGroup.locationGroup](https://shopify.dev/docs/admin-api/graphql/reference/shipping-and-fulfillment/deliveryprofilelocationgroup#locationgroup-2021-01)

Implements

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