For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Docs API Reference Learn Community Changelog

Docs API Reference Learn Community Changelog

- About Our APIs
REST
GraphQL
MCP

GraphQL B2B Queries

productPurchasable

Example Query

1 query ExampleQuery($storeHash: String, $productId: Int, $sku: String, $isProduct: Boolean) {
2   productPurchasable(storeHash: $storeHash, productId: $productId, sku: $sku, isProduct: $isProduct) {
3     availability
4     inventoryLevel
5     inventoryTracking
6     purchasingDisabled
7     availableToSell
8     unlimitedBackorder
9   }
10 }

Variables

1 {
2   "storeHash": "example",
3   "productId": 0,
4   "sku": "example",
5   "isProduct": true
6 }

Example response

1 {
2   "data": {
3     "productPurchasable": {
4       "availability": "example",
5       "inventoryLevel": 0,
6       "inventoryTracking": "example",
7       "purchasingDisabled": true,
8       "availableToSell": 0,
9       "unlimitedBackorder": true
10     }
11   }
12 }

Was this page helpful?

taxZoneRates

validateProduct

Arguments

storeHashStringOptional

Store hash.

productIdIntegerOptional

Product ID.

skuStringOptional

Variant sku

isProductBooleanOptional

Is product or variant

Returns

an optional ProductPurchasableType

availabilityString

The availability of product

inventoryLevelInteger

The inventory level of product

inventoryTrackingString

The inventory tracking of product

purchasingDisabledBoolean

The purchasing disabled of variant

availableToSellInteger

Total available quantity for a product

unlimitedBackorderBoolean

Indicate if the product has unlimited backorder