Skip to main content

Choose a version:

Anchor to DeliveryLocationGroup

DeliveryLocationGroup

object

Requires Any of assigned_shipping or shipping access scopes or manage_delivery_settings user permission.

A location group is a collection of locations. They share zones and delivery methods across delivery profiles.

Anchor to FieldsFields

•ID!

non-null

A globally-unique ID.

Anchor to locationslocations

•LocationConnection!

non-null

A list of all locations that are part of this location group.

Arguments

Anchor to afterafter

The elements that come after the specified cursor.

Anchor to beforebefore

The elements that come before the specified cursor.

Anchor to firstfirst

•Int

The first n elements from the paginated list.

Anchor to includeInactiveincludeInactive

Default:false

Whether to include the locations that are deactivated.

Anchor to includeLegacyincludeLegacy

Default:false

Whether to include the legacy locations of fulfillment services.

Anchor to lastlast

•Int

The last n elements from the paginated list.

Anchor to queryquery

A filter made up of terms, connectives, modifiers, and comparators.

name	type	description	acceptable_values	default_value	example_use
default	string	Filter by a case-insensitive search of multiple fields
in a document.			- `query=Bob Norman` - `query=title:green hoodie`
active	string
address1	string
address2	string
city	string
country	string
created_at	time
geolocated	boolean
id	id	Filter by `id` range.			- `id:1234` - `id:>=1234` - `id:<=1234`
legacy	boolean
location_id	id
name	string
pickup_in_store	string		- `enabled` - `disabled`
province	string
zip	string
You can apply one or more filters to a query. Learn more about [Shopify API
search syntax](https://shopify.dev/api/usage/search-syntax).

Anchor to reversereverse

Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey

•LocationSortKeys

Default:NAME

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Anchor to locationsCountlocationsCount

A count of all locations that are part of this location group.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to Node Node •interface

Was this section helpful?