Stitchwork Docs
stitchwork.io

Documentation

Pick up where the website left off

Stitchwork connects a merchant's website, physical stores and sales team around a single view of each customer — then uses that view to personalise what the customer sees online, help staff sell to them in person, and record what they buy.

These docs are written for the person setting Stitchwork up. Everything here can be done from the app and the JSON API with no help from us, which is the point: a seven-day trial is long enough to get real data flowing, but only if nothing blocks you on a Tuesday afternoon.

In a hurry?

The quickstart takes you from a fresh sign-up to a tracked storefront, an imported catalogue and a live quote. Budget about an hour, most of it waiting for a CSV export from your commerce platform.

What Stitchwork actually does

Five things, and they compound:

Track

One script tag

Records page views, product views, cart adds, searches and purchases against a first-party cookie — behind whatever consent banner you already run.

Rank

Personalised ordering

A tunable score per product built from sales, views, cart adds, newness, sale status and a manual boost — with a per-customer overlay on top.

Sell

The quote builder

An agent picks a customer and sees what they browsed, what to recommend, and a live-calculating quote they can send, get accepted and take payment on.

Stitch

Identity that survives

Anonymous browsing joins to a named customer via a QR scan, an emailed quote or a signed handoff from your own checkout — and stays joined.

Record

Orders as first-class

Import historical sales from CSV, convert accepted quotes, or post orders from your own backend. All three feed the same ranking signal.

Sync

Signed webhooks

Every quote, order and customer change fans out to your OMS, ERP or workflow tool with an HMAC signature and exponential-backoff retries.

The shape of the system

Stitchwork sits alongside whatever you already sell through. It is not a storefront, not a CMS and not a payment processor. Four surfaces, one database: 

  YOUR WEBSITE                    STITCHWORK                     YOUR STORE
  ┌───────────────────┐          ┌──────────────────┐          ┌────────────────┐
  │ tracking tag      │─events──▶│                  │          │ agent, iPad    │
  │ <sw-recs> widget  │◀─ranks───│   organisation   │◀─quotes─▶│ printed QR     │
  │ category re-rank  │◀─ranks───│   ├ channels     │          │ codes          │
  │ join endpoint     │◀─stitch─▶│   ├ products     │          └────────────────┘
  │ your checkout     │──orders─▶│   ├ customers    │
  └───────────────────┘          │   ├ visitors     │          THE CUSTOMER
                                 │   ├ events       │          ┌────────────────┐
  YOUR BACK OFFICE               │   ├ quotes       │─link────▶│ public quote   │
  ┌───────────────────┐          │   └ orders       │          │ page /q/{token}│
  │ OMS / ERP         │◀webhooks─│                  │          │ on their phone │
  └───────────────────┘          └──────────────────┘          └────────────────┘
Everything in the middle column is scoped to one organisation and isolated at the database layer. The outer columns are yours; Stitchwork reaches them through a script tag, a JSON API and signed webhooks.

Where to start

Step by step

Quickstart →

Sign up, name your workspace, load a catalogue, install the tag, build a quote.

 Understand

How it works →

The data model in one page: organisations, channels, products, customers, events.

 Build

API overview →

Base URLs, four auth schemes, the response envelope, errors and CORS.

 Integrate

Web tracking →

The script tag, consent modes, your own events, campaign and QR attribution.

 Personalise

Ranking engine →

What feeds the score, how to tune it, and three ways to use it on your site.

 Practical

Your 7-day trial →

What's included, how access is enforced, and a day-by-day plan that fits.

Conventions used in these docs

https://app.stitchwork.io
Stands in for wherever your Stitchwork instance lives. If you self-host, it is whatever you set APP_URL to. Every API path in these docs is relative to that origin.
pk_live_… / sk_live_…
Your workspace's public and secret tracking keys. The pk one is safe in browser JavaScript; the sk one must never leave your server. Both come from Settings → Web tracking. See Authentication.
whsec_…
A webhook subscription's signing secret. Shown once when you create the subscription and once more on each rotation. See Verifying signatures.
Owner-only
Marks something only the workspace owner can do — destructive actions, catalogue edits, imports and payment setup. See Roles and permissions.
Offline-friendly

This documentation site is a folder of plain HTML with no external requests. Serve it from anywhere, or open index.html straight off disk — search, theming and code copying all still work.