Skip to main content
object

Requires unauthenticated_read_product_pickup_locations 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 StoreAvailability to show customers where a ProductVariant is available for pickup.

Learn more about supporting local pickup on storefronts.

•LocationAddress!
non-null

The address of the location.

•ID!
non-null

A globally-unique ID.

•Metafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Arguments

•String

The container the metafield belongs to. If omitted, the app-reserved namespace will be used.

•String!
required

The identifier for the metafield.


•[Metafield]!
non-null

A list of custom fields that a merchant associates with a Shopify resource.

Arguments

•[HasMetafieldsIdentifier!]!
required

The list of metafields to retrieve by namespace and key.

The input must not contain more than 250 values.


•String!
non-null

The name of the location.


Was this section helpful?

•query

Returns shop locations that support in-store pickup. Use the near argument with GeoCoordinateInput to sort results by proximity to the customer's location.

When sorting by distance, set sortKey to DISTANCE and provide coordinates using the near argument.

Learn more about supporting local pickup on storefronts.

Arguments

•Int

Returns up to the first n elements from the list.

•String

Returns the elements that come after the specified cursor.

•Int

Returns up to the last n elements from the list.

•String

Returns the elements that come before the specified cursor.

•Boolean
Default:false

Reverse the order of the underlying list.

•LocationSortKeys
Default:ID

Sort the underlying list by the given key.

•GeoCoordinateInput

Used to sort results based on proximity to the provided location.



Was this section helpful?

•interface

Was this section helpful?