ReceiptKit for WooCommerce
| 开发者 | receiptkit |
|---|---|
| 更新时间 | 2026年9月5日 06:51 |
| PHP版本: | 7.4 及以上 |
| WordPress版本: | 7.1 |
| 版权: | GPLv2 or later |
| 版权网址: | 版权信息 |
详情介绍:
- Build print rules: when an order event happens (status change, refund, order created, or a manual button), if conditions on the order data are met, then print to the bridge, printer and template you choose.
- Manage all your rules from one overview table — each with an enable/disable toggle and a live health indicator — and edit them in a focused pop-up.
- See live status for every bridge and printer on your account, right on the settings screen, so you know a rule can actually reach its printer.
- Print refund receipts automatically when an order is refunded (full or partial).
- Route different receipts to different printers — add one rule for a counter receipt and another for a kitchen ticket on the same event.
- Add conditions on order data: total, payment method, coupons, item SKUs/categories, country, refund amount, and more — with is / is not / greater than / less than / contains operators. Money like
$12.01is compared numerically automatically. - Print item variations and product add-ons ("Size: Large", "No onions") under each line item, plus the customer's note — so kitchen tickets never miss a modifier.
- Include data other plugins attach to orders — delivery/pickup dates and times, tips, gift flags — by listing the meta keys you want in settings. Only the keys you choose are sent, never an all-or-nothing dump of hidden fields.
- Print the order's fulfillment method (shipping vs. local pickup), status, coupon codes, fees, and a per-rate tax breakdown for VAT/GST tax-invoice receipts.
- Open a cash drawer before/after printing, and print multiple copies.
- Add any rule to the order screen's Print actions menu for on-demand (re)printing.
- Test a rule against a recent order to see exactly which conditions pass before you enable it.
- Send a test print from any rule's row to confirm that rule's printer end-to-end.
- Design branded receipts, refund slips, packing slips, and kitchen tickets in ReceiptKit.
- Design a receipt template in your ReceiptKit dashboard (or clone a "WooCommerce Order" or "WooCommerce Refund" template from the gallery).
- Install the free ReceiptKit bridge on a computer on the same network as your printer.
- Install this plugin, paste your ReceiptKit public key, and click Connect.
- Add a print rule (or start from a recipe) — choose when it runs, any conditions, and what to print. Changes save automatically.
- Orders print automatically.
- An active ReceiptKit account and public API key.
- The ReceiptKit bridge running next to a supported thermal printer (Star Micronics, Epson, or ESC/POS-compatible).
- WooCommerce 8.0+ (High-Performance Order Storage supported).
安装:
- Upload the plugin to
/wp-content/plugins/receiptkit-for-woocommerce, or install it from the Plugins screen. - Activate it through the Plugins menu in WordPress.
- Go to WooCommerce → ReceiptKit.
- Paste your public API key (starts with
rk_pub_) and click Connect. - Add a print rule (or start from a recipe): pick when it runs, add any conditions, and choose the bridge, printer and template. Rules save automatically.
- Click Test print on the rule's row to confirm, then enable it with the toggle.
屏幕截图:
常见问题:
Do I need a specific printer?
You need a thermal printer that speaks StarPRNT, Star Raster, or ESC/POS — that covers Star Micronics, Epson, Rongta, Munbyn, and most generic ESC/POS-compatible models. Tested end-to-end: the Star mC-Print3 and TSP100/TSP143 series, the Epson TM-T88 series, the Rongta RP326, and Munbyn 80mm models. Check your exact model in the printer compatibility matrix. If your printer doesn't work — an impact/dot-matrix model, or a brand that doesn't follow ESC/POS — use the Request printer support form on the settings screen to tell us the make and model, and we will email you when yours is supported.
Where do I get an API key?
In your ReceiptKit dashboard under Settings → API Keys. Use your public key (rk_pub_…) — it is safe to store here and can only print and read status.
How do print rules work?
Each rule is a When / If / Then automation. When an order event happens (a status change, a refund, an order being created, or a manual click), the rule checks if your conditions match the order's data, and if so runs the then — one or more print actions (template + printer + optional cash drawer + copies). Add as many rules as you like; for example one for order receipts on Processing and another for a refund receipt when an order is refunded. Use the Test button on a rule to check it against your most recent order before enabling it.
Can I print refund receipts?
Yes. Add a rule whose event is Order is refunded and point it at a refund template (clone the "WooCommerce Refund" template from the gallery). It prints on both full and partial refunds, once per refund.
Can I print delivery times, tips, or other fields added by another plugin?
Yes. Many plugins (delivery-slot pickers, tip add-ons, gift options) store their data as order meta. In WooCommerce → ReceiptKit → Settings → Extra order fields, list the meta keys you want on your receipts — one per line, with an optional label after a | (for example _delivery_time | Delivery time). Each order then sends those values to your templates two ways: a repeatable metaFields list (label + value) you can drop into any template, and an individual field per key (_delivery_time becomes {{deliveryTime}}) for prominent placement — like a big pickup time at the top of a kitchen ticket. Only the keys you list are sent.
Do item variations and add-ons print?
Yes. Each line item includes a meta field with its variations and product add-on selections ("Size: Large", "No onions"), one per line. The WooCommerce gallery templates render it under the item name; on kitchen tickets it's bold so modifiers never get missed.
Is High-Performance Order Storage (HPOS) supported?
Yes. The plugin reads orders through WooCommerce's standard order APIs and declares HPOS compatibility.
Will it print old orders when I activate it?
No. Each rule prints an order (or refund) once, when its event happens after the rule is configured — never retroactively.
更新日志:
- Fixed: the WordPress.org listing banner now says "Auto-print receipts" instead of "Auto-print orders".
- Improved: links from the plugin to receiptkit.io are now tagged so we can see which customers arrived through the plugin.
- Improved: the rules table now shows a clear "Off" status for switched-off rules instead of the printer-health chip, so a disabled rule can't read as "Ready".
- Improved: the rule editor notes that newly added blank rules start switched off (rules created from a recipe start on).
- Fixed: the status chip now refreshes immediately when a rule is toggled on or off.
- Documentation: "External services" is now its own top-level readme section and fully documents the live-status WebSocket connection (the AWS IoT Core endpoint used by the settings screen) alongside the print API and the printer-request form, with terms and privacy links for both ReceiptKit and AWS.
- Copy: settings-screen text updated to say "receipt printer" rather than "Star printer" — reflecting all supported brands.
- Clarified in code that the AWS IoT hostname in the live-status module is a WebSocket data endpoint (documented under "External services") — no remote scripts, styles, or images are loaded; the MQTT client library is bundled with the plugin.
- Tested up to WordPress 7.1 (verified on a live 7.1 + WooCommerce 10.9 store).
- Docs: printer compatibility notes now name the tested Epson TM-T88 series, Rongta RP326, and Munbyn 80mm models, and link to the full model-by-model compatibility matrix.
- Improved: the rule editor now refreshes your bridges, printers and templates from ReceiptKit every time it opens, so renames made in the dashboard show up immediately.
- Changed: new rules default to appearing in the order screen's "Print" actions menu (uncheck the option in the rule editor to opt out).
- First stable release.
- New: line items now include their variations and product add-ons (
meta), so kitchen tickets can print every modifier. - New: "Extra order fields" setting — list order meta keys (delivery/pickup times, tips, gift flags from other plugins) to include on receipts, selectively. Each key is sent as a labeled
metaFieldsrow and as its own template field (e.g._delivery_time→deliveryTime). - New: order payload now includes fulfillment method (
shippingMethod), order status, coupon codes, fees, and a per-rate tax breakdown (taxLines) for VAT/GST tax-invoice templates. - New: gallery starter templates for a Delivery/Pickup ticket, a Gift Receipt (prices hidden), and a Tax Invoice (VAT/ABN header with per-rate tax breakdown); the Customer Receipt now prints item options and the customer's note.
- Maintenance release: build/packaging refresh. No functional changes.
- New: rules that point at a template which has since been archived or deleted in ReceiptKit now show a clear "Template unavailable" warning instead of silently blanking the selection, and the saved template is preserved so you can review it before choosing a current one.
- New: rule-based printing (When / If / Then). Each rule prints to one destination — a bridge, printer and template you choose.
- New: print rules overview table with a per-rule enable/disable toggle and a live health indicator, plus a modal editor.
- New: bridge-first rule editor — pick a bridge (auto-selected when you have only one), see its live status, then pick a printer on it and a template.
- New: live device status — a Devices panel shows every bridge and printer on your account and whether each is online, out of paper, etc.
- New: automatic refund receipts (full and partial refunds) via a "WooCommerce Refund" template.
- New: one-click recipes, per-field hints, autosave (no page reloads), and a "Test against a recent order" check.
- New: add any rule to the order screen's Print actions menu.
- Conditions compare money strings numerically and never error on empty/invalid values; a print failure can never interrupt an order.
- Initial release: auto-print WooCommerce orders to a Star Micronics printer via ReceiptKit, with printer/template selection, cash-drawer control, and a test print.