Choose a version:

LocationConnection

connection

An auto-generated type for paginating through multiple Locations.

Anchor to Fields with this connectionFields with this connection

Anchor to DeliveryLocationGroup.locations DeliveryLocationGroup.locations •OBJECT: A location group is a collection of locations. They share zones and delivery methods across delivery profiles.
Anchor to DeliveryProfile.unassignedLocationsPaginated DeliveryProfile.unassignedLocationsPaginated •OBJECT: A shipping profile that defines shipping rates for specific Product objects and ProductVariant objects. Delivery profiles determine which products can ship from which Location objects to which zones, and at what rates.

Profiles can associate with SellingPlanGroup objects to provide custom shipping rules for subscriptions, such as free shipping or restricted delivery zones. The default profile applies to all products that aren't assigned to other profiles.

Learn more about building delivery profiles.
Anchor to LocationsCondition.locations LocationsCondition.locations •OBJECT: A condition checking the location that the visitor is shopping from.
Anchor to Shop.locations Shop.locations •OBJECT Deprecated

Was this section helpful?

Anchor to Queries with this connectionQueries with this connection

Anchor to locations locations

•query

A paginated list of inventory locations where merchants can stock Product items and fulfill Order items.

Returns only active locations by default. Use the includeInactive argument to retrieve deactivated locations that can no longer stock inventory or fulfill orders. Use the includeLegacy argument to include locations that FulfillmentService apps manage. Use the query argument to filter by location attributes like name, address, and whether local pickup is enabled.

Arguments

Anchor to firstfirst

•Int

The first n elements from the paginated list.

Anchor to afterafter

•String

The elements that come after the specified cursor.

Anchor to lastlast

•Int

The last n elements from the paginated list.

Anchor to beforebefore

•String

The elements that come before the specified cursor.

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 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.
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.
Anchor to legacy •boolean
Anchor to location_id •id
Anchor to name •string
Anchor to pickup_in_store •string
Anchor to province •string
Anchor to zip •string

Anchor to includeLegacyincludeLegacy

•Boolean

Default:false

Whether to include the legacy locations of fulfillment services.

Anchor to includeInactiveincludeInactive

•Boolean

Default:false

Whether to include the locations that are deactivated.

Anchor to locationsAvailableForDeliveryProfilesConnection locationsAvailableForDeliveryProfilesConnection

•query

Returns a list of all origin locations available for a delivery profile.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to edgesedges •[LocationEdge!]! non-null: The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
Anchor to nodesnodes •[Location!]! non-null: A list of nodes that are contained in LocationEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.
Anchor to pageInfopageInfo •PageInfo! non-null: An object that’s used to retrieve cursor information about the current page.

Was this section helpful?