Location
Requires access scope.
A physical store location where product inventory is held and that supports
in-store pickup. Provides the location's name, address, and geographic
coordinates for proximity-based sorting. Use with
to show customers where a
is available for pickup.
Learn more about supporting local pickup on storefronts.
Anchor to FieldsFields
- address (LocationAddress!)
- id (ID!)
- metafield (Metafield)
- metafields ([Metafield]!)
- name (String!)
- Anchor to addressaddress•Location
Address! non-null The address of the location.
Show fields
- •ID!non-null
A globally-unique ID.
- Anchor to metafieldmetafield•MetafieldToken access required
A custom field, including its
namespaceandkey, that's associated with a Shopify resource for the purposes of adding and storing additional information.Show fields
- •String!required
The identifier for the metafield.
- Anchor to namespacenamespace•String
The container the metafield belongs to. If omitted, the app-reserved namespace will be used.
Arguments
- •String!
- Anchor to metafieldsmetafields•[Metafield]!non-null Token access required
A list of custom fields that a merchant associates with a Shopify resource.
Show fields
- Anchor to identifiersidentifiers•[Has
Metafields Identifier!]! required The list of metafields to retrieve by namespace and key.
The input must not contain more than
250values.Show input fields
Arguments
- Anchor to namename•String!non-null
The name of the location.
Anchor to QueriesQueries
- locations (LocationConnection!)
- •query
Returns shop locations that support in-store pickup. Use the
nearargument withto sort results by proximity to the customer's location.When sorting by distance, set
toDISTANCEand provide coordinates using thenearargument.Learn more about supporting local pickup on storefronts.
Show fields
- 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.
Show input fields
- 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.
Show enum values
Arguments