Developer API

if (window.stockful) {
  // Already loaded
  useStockful();
} else {
  window.addEventListener("stockful:ready", useStockful);
}

function useStockful() {
  // window.stockful is now available
}

window.stockful.getVariant(variantId: number): Promise<VariantData | null>

const data = await window.stockful.getVariant(44123456789);
if (data) {
  console.log(data.stockStatus);  // "in_stock"
  console.log(data.daysOfSupply); // 12
}

window.stockful.getProduct(productId: number): Promise<ProductData | null>

const data = await window.stockful.getProduct(8012345678);
if (data) {
  console.log(data.totalSold30d);          // 342
  console.log(data.lowStockVariantCount);   // 2
}

window.stockful.getVariants(variantIds: number[]): Promise<VariantData[]>

const variants = await window.stockful.getVariants([44123456789, 44123456790]);
variants.forEach(v => {
  console.log(`Variant ${v.variantId}: ${v.stockStatus}`);
});

window.stockful.getLocationAvailability(variantId: number): Promise<LocationData[]>

const locations = await window.stockful.getLocationAvailability(44123456789);
locations.forEach(loc => {
  console.log(`${loc.name}: ${loc.available ?? loc.status}`);
});

interface VariantData {
  variantId: number;
  stockStatus: string;           // "in_stock" | "low_stock" | "out_of_stock"
  daysOfSupply: number | null;
  velocityTrend: string;         // "selling_fast" | "steady" | "slow"
  projectedStockout: string | null; // ISO 8601 date
  abcClass: string | null;       // "A" | "B" | "C"
  restockStatus: string;         // "pending" | "needed" | "none"
  soldLast30d: number;
}

interface ProductData {
  productId: number;
  stockStatus: string;           // "in_stock" | "low_stock" | "out_of_stock"
  lowStockVariantCount: number;
  velocityTrend: string;         // "selling_fast" | "steady" | "slow"
  totalSold30d: number;
}

interface LocationData {
  locationId: string;
  name: string;
  city: string | null;
  provinceCode: string | null;
  countryCode: string | null;
  available?: number;   // Present when store has "show quantities" enabled
  status?: string;      // "in_stock" | "out_of_stock" - present when quantities are hidden
}

window.addEventListener("stockful:ready", () => {
  console.log("Stockful API ready");
});