ThreadReadyThreadReady
PricingHelpBlogContact

Operator Handbook

Help Center

Guides for setting up and running your ThreadReady kiosk, from your first design to taking orders at the counter.

Help & Guides

Step-by-step guides for setup, designs, the kiosk, orders, and billing. Can't find what you need? Contact us.

ThreadReadyThreadReady

Embroidery personalization for modern shops — from live stitch preview and customer approval to a clean production handoff. Starting with the kiosk, built to grow with you.

KioskAll productsPricingAnswersAboutHelpBlogContact

© 2026 Lambda Coffie LLC. ThreadReady is built for modern machine embroidery shops.

Terms of ServicePrivacy PolicyRefund Policy
Help CenterOrders & FulfillmentManaging Orders

Managing Orders

The order page: what to sew, the approval record and audit trail, machine files, scanning receipts, labels and the order API.

Running orders

Orders come from the kiosk. This article covers the order page: what to sew, the approval record, machine files, scanning receipts, labels, analytics and the API. The rest of running orders has its own articles:

  • The order queue and CSV export: the status tabs, dates, search, new-order alerts, test orders and exporting to a spreadsheet.
  • Order statuses and telling the customer: moving an order along, cancelling, overrides, and the Ready for pickup email.
  • Correcting an order after approval: fixing the text, font or thread, and changing contact details.

Order lifecycle

Every order moves from Awaiting payment to Paid, In production, Ready for pickup and Picked up, one step at a time, or is Cancelled. On the order page the Status card has one button for the next step. See Order statuses for every rule.

Machine files for production

Settings → Kiosk → Machine files sets the format your embroidery machine reads: DST (the recommended default, read by most commercial machines), PES, JEF or EXP. Every main Download for machine button uses it, on the order page and in the queue; the other formats stay a click away on each order.

On the Paid and In production tabs each order has a download button on the right, which downloads its machine file without opening the order. To get several at once, tick the orders (or Select all for the page, up to 25) and press Download machine files. You get one ZIP with a file per order, plus order-list.txt: each file's order number, customer, design, lines of text and thread. An order with no machine file (no stitch data, its design's art can't be read, or a correction still waiting for the customer) is left out of the ZIP and listed in order-list.txt with the reason. When none of the selected orders has a file, nothing downloads and the queue says why.

Anyone on the team can download machine files, viewers included, also while the workspace is locked for billing. Each file in a ZIP is recorded on its order's Audit trail, like a single download.

The same ticked orders print their work orders with Print work orders, one order per page, and Work orders at the top of Orders prints every Paid and In production order's sheet. The work order and the order page also show the trims, the hoop and an estimated sewing time, from the speed you set under Settings → Kiosk → Machine files. See Labels and work orders.

Download and mark In production is off by default. Turn on Offer "Download and mark In production" under Settings → Kiosk → Machine files to add it to the Paid tab and to a Paid order's page: the files download and each order moves to In production, as if you had pressed the button on the order, so the queue matches what's on the machine. It's for owners, admins and members; viewers can download but can't move orders. An order someone else moved in the meantime is left where it is, and the queue tells you.

Every machine file, downloaded on its own or in a ZIP, is named with a six-character order code and the customer's name, for example 8F8B19_Olivia-Rose.dst. The code is the end of the order number (TR-20261101-3C8F8B19), and order-list.txt lists which order each code belongs to. Many machines, Brother's among them, show only the first 6 to 8 characters of a file name on their screen, so starting with the code keeps every file different there. Names use only letters, digits, - and _: accents, spaces, periods and commas are left out, so any machine or USB stick can read them.

Beside the machine formats, each order also downloads as OED: the order's design as an Open Embroidery Format design file (.oed), an open format for embroidery designs. Every machine file of the order is made from it, so its DST, PES, JEF and EXP sew the same stitches and cut the thread in the same places. It holds one part per field of the design (and one for its art), and what the customer typed in each field with the font file it was sewn in, so embroidery software that reads OEF can open the whole order. No machine sews an .oed directly, so it is never the shop's machine format or in the queue's ZIP. It is named like the machine files (8F8B19_Olivia-Rose.oed) and its downloads are recorded on the Audit trail too. The licences of the fonts and designs it was sewn from apply to it as they do to the machine files, and the file says so.

Integrations get the same files from the Order API: GET /api/v1/orders/{id}/stitch/{format} with format one of dst, pes, jef, exp or oed.

Order details

Click any order to see its full details. The page puts the production task first:

  • Customer comment — Shown at the top of the page when the customer left one.

  • What to embroider — Next: for each line, the text the customer entered, the font and the size that was actually sewn (with the scale when the lettering was shrunk to fit, for example "1 inch, scaled to 80%", or the height when it was re-sewn smaller to fit, for example "1.063 in · 27.0 mm, re-sewn from 2 inch"), the lettering size in millimetres, and the thread. Below that are the item, template, thread, stitch count and design size. When an order has no machine file, it says what is missing: a line with no font on the design, a font no longer in your library, a font with no file, characters the font can't stitch, a design whose art can't be read, or a stitch file that couldn't be rebuilt.

  • Colour sequence — The machine file's colours in the order the machine sews them, each with its thread, stitch count and a small picture with that colour dark. An appliqué order shows N appliqué stops here and next to What to embroider, and each appliqué step says what it sews, when to place or trim the fabric, and how many pieces to cut for it. Beside the machine file, Cut file (SVG) downloads the fabric outlines for a cutting machine, with an Inflate (mm) box (see Appliqué cut files). The work order prints the same list (see Labels and work orders).

  • Customer info — Name, email, phone.

  • Preview and machine file — The stitch preview captured at submission time, with Download for machine in your shop's machine format (DST unless you change it, see Machine files for production) and the other formats (DST, PES, JEF, EXP, and OED, the Open Embroidery Format design) beside it, plus the approved preview as an SVG or PNG. Every download is recorded on the order's Audit trail, with who downloaded which file.

    Before a machine file is written, ThreadReady checks it. When a file would sew something no machine should (a stitch straight across the gap between two lines, a sewn stitch far longer than a machine stitch, a colour list shorter than the colour changes), it repairs it: the thread is tied off, cut and moved needle-up, or the colour list gets one entry per colour block. A font's own long moves are handled as the font's digitizer software writes them: carried with the needle up, and cut when they are longer than about 36 mm. The download still works. The order then shows This file was repaired before writing with what was repaired, its row in the queue has a File repaired badge, and the download's Audit trail entry lists each repair, so you know to look at the file before sewing. Things worth a look that were left as they are (needle drops piled up in one spot, many very short stitches, a cut with no lock stitch, a design larger than its hoop) show apart, as Warnings about this file and a File warnings badge. In a ZIP, order-list.txt lists both under the file. A design with no stitches at all isn't written.

  • Status — The next step for the order (see above), with the Order summary and the customer's contact details below it. On a laptop or a tablet held sideways they sit in a column beside the design; on a narrower screen Status comes first, so the counter's next step is on the first screen. Email addresses and phone numbers are links, so you can email or call from the order.

  • Staff updates, Receipt and Audit trail — Closed below the rest of the page, each with a one-line summary; click the heading to open one.

  • Print label — Next to the status badge, only when Print garment and bag labels is on (Settings → Kiosk → Printing, off by default). The label to stick on the garment or bag: the order number, customer, item, what to stitch and a code to scan at pickup, sized for your label stock. Hover over it (or tab to it) for a reminder, or press Which to print?. See Labels and work orders.

  • Print work order — Next to it, always available: the sheet for the machine operator. It opens a one-page job sheet and the print dialog, with the design, each line's text, font, size and thread, the item, setup details, the colour sequence with any appliqué stops, notes and a QR code you can scan to open the order. It leaves off prices and the customer's email and phone, and prints on any office printer. It isn't available while a correction is waiting for the customer.

  • Pricing breakdown — Each price line item and the approved total. An order placed while your shop didn't price orders has none (Settings → Kiosk → Prices).

  • Thread selection — The thread color, brand, catalog number, and type chosen.

One order: its status, the customer's approval, what to embroider line by line, and the machine file downloads.

Receipts and barcodes

  • Receipt scan — Scan a receipt on any staff page: a USB or Bluetooth scanner that reads QR codes types the code, and the order opens. Scan the receipt's QR code, a garment and bag label (a QR code, or a Code 128 TR-RECEIPT:… barcode), or an older receipt. The receipt QR code is the customer's proof link, so a customer showing their proof on their phone works too, even after the link has expired for them (30 days). While you're typing in a box (a note, the order search), the scan goes into that box instead; click outside it first. Owners, admins and members can scan; viewers can't. The design editor doesn't take scans, so a scan can't throw away unsaved work. A code from another shop says Not found.
  • The Scan button — Bottom right on staff pages. It opens the scan panel: Ready: scan a receipt on any page, a box to find an order by receipt code, order number, name or phone, Scan with camera on a phone or tablet whose browser supports it, and your recent scans. By default a scan just opens the order. To move the scanned order along as well, choose a step under After scanning (Mark paid, Start production, Mark ready for pickup or Mark picked up): the button then reads, for example, "Next scan marks PAID", and the step applies to the next scan only unless you tick Keep for every scan ("Scans mark PAID"). If an order can't move to that status (for example it's already picked up), the order still opens and a message says why. Each scan beeps (turn off Beep on scan to silence it). New-order sound is here too: a chime when a new order arrives, on any page. These choices are kept in this browser. On an order page the button is a small round icon so it stays clear of the Status panel.
  • Scan screen — For a counter screen that only scans, open Open the scan screen from the panel (or go to /scan). It has the same settings, keeps the cursor in its field and shows each result in place instead of opening the order, so you can scan receipts one after another; each one is listed under Recent scans. Order numbers aren't receipt codes: search for those in the order queue.
  • Saved designs — Scanning a customer's saved design that hasn't been ordered yet tells you to ask the customer to tap Finish a saved design on the kiosk tablet and scan it there. On a paired kiosk tablet you can also press Open here.
  • Download file — Scan a Paid or In production order from the scan panel's search box or camera, and the panel stays open with Download file: its machine file in your shop's format, the same audited download as Download for machine. Not while a correction is waiting for the customer.
  • Labels — Only when garment and bag labels are on (it used to be called Barcodes). A label for every open order (awaiting payment, paid, in production and ready for pickup), sized for your label stock. Press Print labels to print them; the app's menus are left off the printout. Picked-up and cancelled orders are left off. An order number is always printed on one line (a very long one is set smaller). With labels off, an old link to this page says labels are off and links to the setting. Sizes, printers and when to print: Labels and work orders.
  • At the register (paperless) — Most customers have no paper receipt: they show the QR code on their phone (from the receipt email, or from scanning the kiosk screen) or tell you their order number or name. Scan the phone on any staff page (or with the Scan button), or search the order queue. See Paperless receipts.

Approval workflow

Every kiosk order keeps a record of what the customer approved: the preview, each line's text, font and thread, the price lines and the total, as they were when the customer pressed Submit order (see Price, review, approval and the receipt). The order page shows it as the Approval Record: when the customer approved, the Source (kiosk for an order placed on the kiosk) and the customer's comment. The record names the approver only as the customer: no device or person is stored.

The Audit Trail lists the latest 50 things that happened to the order (approved, submitted, status changes, edits, downloads, emails), each with who did it: a staff member's name or email, Customer, or System. Nobody in your shop can edit or delete it.

Anyone on the team can open an order, viewers included. To fix an approved order, see Correcting an order after approval. The original approval record is never overwritten.

Analytics

The dashboard and Analytics pages count your orders, payments and saved designs. See The dashboard and Analytics.

Order API

Integrations can read orders (including the approved price and production details), download machine files and move an order's status with an API key from Settings → API Keys. The API can't create orders. How to use it, every error and the changelog of breaking changes are in API and Integrations; the full reference is at /api/docs.

When a webhook delivery fails

Webhooks (events, bodies, headers and how to check the signature) have their own article: Webhooks. ThreadReady sends each one after the order action has finished, so a slow receiver never holds up the kiosk or the counter. If a delivery fails, it is tried twice more at once, then again after 1 minute, 5 minutes, 30 minutes, 2 hours and 6 hours, and then marked failed. Meanwhile it appears under Failed deliveries on Settings → Webhooks for 7 days, with the error, the next try and a Resend button (owners and admins). Resend sends the original event again to the webhook's current address with the same x-threadready-delivery id, so your system can ignore a delivery it already handled. A paused webhook has to be turned back on first, and a deleted one can't be resent.

Breaking change: webhook headers and signature (November 5, 2026)

If you built a webhook receiver before this date, update it:

  • The signature now covers a timestamp. x-threadready-signature is the HMAC-SHA256 (hex) of x-threadready-timestamp, a full stop and the raw body (it was the raw body alone). Check the timestamp is within 5 minutes of your clock. See Verify the signature.
  • New headers: x-threadready-delivery (one id per event per webhook, the same on every retry and Resend: use it to ignore repeats), x-threadready-event and x-threadready-timestamp.
  • Retries over hours. A failed delivery is now retried in the background for about 9 hours, so the same delivery id can arrive more than once and after later events.
  • Status changes are order.status.changed. Order Status Changed webhooks were sent as order.stage.changed, with the statuses in stage and previousStage. They are now order.status.changed, with the same status objects in status and previousStatus. Your existing webhooks were moved over; order.stage.changed is no longer sent or accepted.

The rest of the body didn't change.

Breaking changes

Changes to the API and webhooks that could break an integration, such as the Ready for pickup step (October 27, 2026), are listed newest first in the changelog in API and Integrations.

Next
The Order Queue and CSV Export

More in Orders & Fulfillment

  • The Order Queue and CSV Export
  • Order Statuses and Telling the Customer
  • Correcting an Order After Approval
  • Labels and work orders
  • Appliqué cut files