Delivery
Requires Any of or shipping access scopes or user permission.
A location group is a collection of locations. They share zones and delivery methods across delivery profiles.
Anchor to FieldsFields
- id (ID!)
- locations (LocationConnection!)
- locationsCount (Count)
- •ID!non-null
A globally-unique ID.
- Anchor to locationslocations•Location
Connection! non-null A list of all locations that are part of this location group.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Location
Key Sort Keys 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 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.
query=Bob Normanquery=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 legacy•boolean
- Anchor to location_id•id
- Anchor to name•string
- Anchor to pickup_in_store•string
enableddisabled- Anchor to province•string
- Anchor to zip•string
Example:
Valid values:
- Anchor to includeLegacyinclude•Boolean
Legacy Default:false Whether to include the legacy locations of fulfillment services.
- Anchor to includeInactiveinclude•Boolean
Inactive Default:false Whether to include the locations that are deactivated.
Arguments
- Anchor to locationsCountlocations•Count
Count A count of all locations that are part of this location group.