GitHub

ShopifyStoreAvailability

Type

import { ShopifyStoreAvailability } from '@daffodil/driver/shopify'

Inventory information for a product variant at a physical store location that offers local pickup. Includes stock availability, quantity on hand, and estimated pickup readiness time.

Local pickup must be enabled in the store's shipping settings for this data to be returned. 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.

interface ShopifyStoreAvailability {
  __typename: "StoreAvailability"
  available: boolean
  location: ShopifyLocation
  pickUpTime: string
  quantityAvailable: number
}

Properties

__typename
"StoreAvailability"
available
boolean

Whether the product variant is in-stock at this location.

location
ShopifyLocation

The location where this product variant is stocked at.

pickUpTime
string

Returns the estimated amount of time it takes for pickup to be ready (Example: Usually ready in 24 hours).

quantityAvailable
number

The quantity of the product variant in-stock at this location.