Skip to main content

store_availability

A variant's inventory information for a physical store location.

If a location doesn't stock a variant, then there won't be a store_availability for that variant and location.

Note

A returned location isn't guaranteed to offer local pickup. Check pick_up_enabled before presenting a location as a pickup option.

Properties

Anchor to
available
boolean

Returns true if the variant has available inventory at the location. Returns false if not.

Anchor to
location
location

The location that the variant is stocked at.

Anchor to
pick_up_enabled
boolean

Returns true if the location has pickup enabled. Returns false if not.

Anchor to
pick_up_time
string

The amount of time that it takes for pickup orders to be ready at the location.

Tip

This value can be configured in the Shopify admin. To learn more, visit the Shopify Help Center.

Anchor to
sells_in_person
boolean

Returns true if the location is a physical retail storefront that sells in person. Returns false if not.

{
"available": true,
"location": {},
"pick_up_enabled": true,
"pick_up_time": "Usually ready in 24 hours",
"sells_in_person": false
}
Was this section helpful?