locations
Requires access scope.
Returns shop locations that support in-store pickup. Use the near argument with to sort results by proximity to the customer's location.
When sorting by distance, set to and provide coordinates using the near argument.
Learn more about supporting local pickup on storefronts.
LocationConnection arguments
- after (String)
- before (String)
- first (Int)
- last (Int)
- near (GeoCoordinateInput)
- reverse (Boolean)
- sortKey (LocationSortKeys)
- Anchor to afterafter•String
Returns the elements that come after the specified cursor.
- Anchor to beforebefore•String
Returns the elements that come before the specified cursor.
- Anchor to firstfirst•Int
Returns up to the first
nelements from the list.- Anchor to lastlast•Int
Returns up to the last
nelements from the list.- Anchor to nearnear•Geo
Coordinate Input Used to sort results based on proximity to the provided location.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Location
Key Sort Keys Default:ID Sort the underlying list by the given key.
Anchor to Possible returnsPossible returns
- edges ([LocationEdge!]!)
- nodes ([Location!]!)
- pageInfo (PageInfo!)
- Anchor to edgesedges•[Location
Edge!]! non-null A list of edges.
- Anchor to nodesnodes•[Location!]!non-null
A list of the nodes contained in LocationEdge.
- Anchor to pageInfopage•Page
Info Info! non-null Information to aid in pagination.