TypeScript SDK

npm install @getfom/sdk

import { FomClient } from "@getfom/sdk"

const fom = new FomClient({ apiKey: process.env.FOM_API_KEY! })

const { shop, api_key } = await fom.shop.get()
console.log(`${shop.name}, as ${api_key.acts_for}`)

const order = await fom.orders.create({
  customer: { name: "Ko Ko", phone: "09123456789" },
  items: [{ variant_id: "var_123", qty: 2 }],
})

await fom.orders.changeStatus(order.id, {
  status: "confirmed",
  expected_revision: order.revision,
})

await fom.products.adjustStock("var_123", { delta: -2, reason: "manual_adjust" })

let since = await loadCheckpoint() // e.g. "2026-11-01T00:00:00.000Z"
for await (const product of fom.products.listAll({ updated_since: since })) {
  await save(product)
  since = product.updated_at
}
await saveCheckpoint(since)

import { FomConflictError, FomValidationError } from "@getfom/sdk"

try {
  await fom.orders.changeStatus(order.id, { status: "delivered", expected_revision: 3 })
} catch (error) {
  if (error instanceof FomConflictError) {
    // Someone changed the order; read it again.
  } else if (error instanceof FomValidationError) {
    console.log(error.details)
  } else {
    throw error
  }
}

import express from "express"
import { constructWebhookEvent } from "@getfom/sdk"

app.post("/fom-webhooks", express.raw({ type: "application/json" }), async (req, res) => {
  let event
  try {
    event = await constructWebhookEvent(req.body, req.get("FOM-Signature"), process.env.FOM_WEBHOOK_SECRET!)
  } catch {
    return res.sendStatus(400)
  }
  if (event.type === "order.created") {
    console.log("New order", event.data.order.order_no)
  }
  res.sendStatus(200)
})

new FomClient({
  apiKey: "fom_live_…",
  maxRetries: 2, // retries for 429, 5xx and network failures
  timeoutMs: 30_000, // per try
  maxRetryDelayMs: 60_000, // a longer Retry-After throws instead of waiting
  fetch: myFetch, // e.g. through a proxy
})