overlook-sdk (v1.0.0)

Official TypeScript / JavaScript Headless E-Commerce SDK for Overlook OS..

Installation

npm install overlook-sdk
# or
yarn add overlook-sdk
# or
pnpm add overlook-sdk

Quickstart

import { createOverlookClient } from "overlook-sdk";

const overlook = createOverlookClient({
  apiKey: "ovk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  baseUrl: "https://overlookhub.com/api/v1", // Optional override
});

1. Catalog & Product Discovery

List Storefront Products

const { data: products } = await overlook.storefront.products.list({
  category: "apparel",
  limit: 20,
});

Get Single Product

const product = await overlook.storefront.products.get("HD-BLK-L");
console.log(product.title, product.inStock, product.variants);

List Categories

const categories = await overlook.storefront.categories.list();

2. Real-Time Inventory Check

Before letting a user complete checkout, instantly verify live physical stock across warehouses:

const stockMap = await overlook.storefront.inventory.check(["var_1", "HD-BLK-L"]);
console.log("Stock for HD-BLK-L:", stockMap["HD-BLK-L"]);

3. Cart & Live Checkout Pipeline

Initialize Checkout Session (Server-Calculated Taxes, Shipping & Totals)

const session = await overlook.storefront.checkout.initialize({
  lineItems: [{ variantId: "HD-BLK-L", quantity: 2 }],
  shippingAddress: { country: "US", postalCode: "90210" },
  couponCode: "WELCOME10",
});

console.log("Subtotal:", session.subtotal);
console.log("Tax:", session.taxAmount);
console.log("Total:", session.totalAmount);
console.log("Payment Secret:", session.clientSecret);

Complete Checkout & Deduct Physical Inventory

const order = await overlook.storefront.checkout.complete({
  sessionId: session.sessionId,
  lineItems: [{ variantId: "HD-BLK-L", quantity: 2 }],
  customerName: "Amelia Vance",
  customerEmail: "[email protected]",
  totalAmount: session.totalAmount,
  paymentMethod: "Stripe Card",
});

4. Shopper Identity & Customer Management

// Authenticate web shopper
const auth = await overlook.storefront.customer.auth({
  email: "[email protected]",
  name: "Amelia Vance",
});

// Fetch past web/POS orders for shopper
const orders = await overlook.storefront.customer.getOrders("[email protected]");

License

MIT © Pocket Studios Group Ltd.