Storefront Data

Stockful can write live inventory data to Shopify metafields and expose a JavaScript API for theme developers - giving you location availability, stock status badges, urgency messaging, and more. The location availability block is drop-in; badges and urgency are built from the metafields with a few lines of Liquid.

What you get

11 metafields

7 variant-level + 4 product-level metafields written daily and updated in real time

Theme blocks

Drop-in location availability block - no code required

Developer API

window.stockful JavaScript API for custom integrations

Code examples

Copy-paste Liquid and JavaScript snippets for common patterns

Quick start

1. Enable storefront data

Go to Settings > Storefront in the Stockful app and toggle Enable storefront data. Choose which metafields to sync.

2. Activate the app embed

In your Shopify admin, go to Online Store > Themes > Customize. Open the App embeds panel and enable Stockful.

3. Add the block to your product page

Still in the theme editor, navigate to your product template. Click Add block and choose Stockful Location Availability - a “Check store availability” button that opens a drawer of per-location stock.

4. Add badges and urgency (optional)

Stock badges and urgency messaging are built from the metafields rather than a block, which gives you full control over the markup. Both have copyable Liquid: stock badges and urgency messaging. The data reference lists every available field.

How data flows

Inventory change
  → Stockful processes change
  → Metafields written to Shopify (real-time for status, daily for analytics)
  → Available via Liquid, Storefront API, and window.stockful

Real-time updates: stock_status metafields update within seconds of an inventory change. Daily sync: Analytics metafields (days of supply, velocity, sold count, etc.) sync once per day as part of the daily analytics run.

Accessing metafields

Stockful’s metafield namespace is app--326028230657--stockful. Use this in your Liquid templates and Storefront API queries.

In Liquid

{{ product.metafields.app--326028230657--stockful.stock_status.value }}

In the Storefront API (headless)

query ProductWithStock($handle: String!) {
  product(handle: $handle) {
    stockStatus: metafield(namespace: "app--326028230657--stockful", key: "stock_status") {
      value
    }
    totalSold: metafield(namespace: "app--326028230657--stockful", key: "total_sold_30d") {
      value
    }
  }
}

Overview

Reference

Guides

Examples

What you get

11 metafields

Theme blocks

Developer API

Code examples

Quick start

1. Enable storefront data

2. Activate the app embed

3. Add the block to your product page

4. Add badges and urgency (optional)

How data flows

Accessing metafields

In Liquid

In the Storefront API (headless)

​What you get

11 metafields

Theme blocks

Developer API

Code examples

​Quick start

​1. Enable storefront data

​2. Activate the app embed

​3. Add the block to your product page

​4. Add badges and urgency (optional)

​How data flows

​Accessing metafields

​In Liquid

​In the Storefront API (headless)

What you get

Quick start

1. Enable storefront data

2. Activate the app embed

3. Add the block to your product page

4. Add badges and urgency (optional)

How data flows

Accessing metafields

In Liquid

In the Storefront API (headless)