Skip to main content
Anchor to locations

locations

query

Returns a list of active inventory locations.

Anchor to Arguments

LocationConnection arguments

•LocationConnection!
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
•
BooleanDefault:false

Whether to include the locations that are deactivated.

Anchor to includeLegacyincludeLegacy
•
BooleanDefault: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
•
BooleanDefault:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•
LocationSortKeysDefault: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.

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?