locations - storefront - QUERY

Version: 2025-01

Description:

List of the shop's locations that support in-store pickup. When sorting by distance, you must specify a location via the `near` argument.

Access Scopes

`unauthenticated_read_product_pickup_locations` access scope.

Arguments

• after: String - Returns the elements that come after the specified cursor.
• before: String - Returns the elements that come before the specified cursor.
• first: Int - Returns up to the first `n` elements from the list.
• last: Int - Returns up to the last `n` elements from the list.
• near: GeoCoordinateInput - Used to sort results based on proximity to the provided location.
• reverse: Boolean - Reverse the order of the underlying list.
• sortKey: LocationSortKeys - Sort the underlying list by the given key.

Returns

• edges: LocationEdge! A list of edges.
• nodes: Location! A list of the nodes contained in LocationEdge.
• pageInfo: PageInfo! Information to aid in pagination.

Examples