Choose a version:

StoreAvailability

object

Requires unauthenticated_read_product_pickup_locations access scope.

Inventory information for a product variant at a physical store location. Includes stock availability, quantity on hand, and estimated pickup readiness time. Availability also includes inventory that can be moved to the location through a store transfer route, so a variant can be available for pickup with no on-hand stock at the location.

Most locations are returned because local pickup is enabled in the store's shipping settings. Some shops also return locations that sell products in person without offering local pickup, so a returned location isn't necessarily one a buyer can collect from. Results can be sorted by proximity to a customer's location using the near argument on the ProductVariant.storeAvailability connection.

Learn more about supporting local pickup on storefronts.

Anchor to FieldsFields

Anchor to availableavailable •Boolean! non-null: Whether the product variant can be picked up at this location. This is true when the variant is in stock here, can be supplied through a store transfer from another location, or is sold with untracked or oversellable inventory (its inventory isn't tracked, or its inventory policy allows continuing to sell when out of stock). As a result, available can be true even when quantityAvailable is 0.
Anchor to locationlocation •Location! non-null: The location where this product variant is stocked at.
Anchor to pickUpTimepickUpTime •String! non-null: Returns the estimated amount of time it takes for pickup to be ready (Example: Usually ready in 24 hours). When the variant is out of stock at this location and supplied through a store transfer, this reflects the estimated transfer transit time when available, otherwise it falls back to the location's standard pickup processing time.
Anchor to quantityAvailablequantityAvailable •Int! non-null: The quantity of the product variant physically in stock at this location. This counts on-hand inventory only and excludes inventory available through a store transfer, so it can be 0 while available is true.

Was this section helpful?