Skip to main content
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

Anchor to idid
•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
•String

The elements that come after the specified cursor.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to includeInactiveincludeInactive
•Boolean
Default:false

Whether to include the locations that are deactivated.

Anchor to includeLegacyincludeLegacy
•Boolean
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
•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default
•string

Filter by a case-insensitive search of multiple fields in a document.

Example:

  • query=Bob Norman
  • query=title:green hoodie
Anchor to active
•string
Anchor to address1
•string
Anchor to address2
•string
Anchor to city
•string
Anchor to country
•string
Anchor to created_at
•time
Anchor to geolocated
•boolean
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to legacy
•boolean
Anchor to location_id
•id
Anchor to name
•string
Anchor to pickup_in_store
•string

Valid values:

  • enabled
  • disabled
Anchor to province
•string
Anchor to zip
•string
Anchor to reversereverse
•Boolean
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
•Int!
non-null

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

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to NodeNode
•interface
Was this section helpful?