Ecommerce wishlist in Go

What it does

Configuration

Nothing is required. One Go setting bounds a list; the Plugins screen holds the page heading and whether the storefront asks for an email.

The module reads its Config struct, not the environment. The variable names are the ones the package’s own example or the reference binary uses; in your own main() you choose where each value comes from. Where a setting has a panel label, the admin’s settings drawer can hold it too, and a value typed there wins over Config.

Setting it up

1. Install the modulePass wishlist.New to gocommerce.New, as below, or start the reference binary with -wishlist. It adds two tables, and the plugin starts switched on.
2. Keep the tokenPOST /x/wishlist, with an email or with no body at all, answers with the new list and its token. The storefront stores the token as it does a cart’s; it is the only key to that list.
3. Save and showPOST /x/wishlist/{token}/items with a product_id, and a variant_id if the shopper chose one. GET /x/wishlist/{token} draws the page, stock included.
4. Read the demandThe Wishlists screen, or GET /api/admin/x/wishlist/wanted?out_of_stock=1, lists the most-wanted products the store cannot sell right now.

import (
	"github.com/itswadesh/gocommerce/core"
	"github.com/itswadesh/gocommerce/ext/wishlist"
)

app, err := gocommerce.New(cfg, wishlist.New(wishlist.Config{}))

How it works

• A token, like a cart’s

  32 bytes from crypto/rand, written as hex: the only credential a guest holds. Every storefront route takes it in the path, and a token nobody has answers 404.

• Once per product and variant

  A unique index on the list, the product and the variant, with a whole-product save counted as one, makes a repeated save a no-op answered with the list as it stands.

• Checked before it is saved

  The product has to exist, and a named variant has to belong to it, or the save answers 404. Otherwise, in the code’s words, a list fills with rows that can never be drawn.

• Stock as the store sells it

  Available is on hand less reserved, summed over the active variants an item covers. A variant that does not track inventory counts as always in stock.

• A deleted product still counts

  The product id is deliberately not a foreign key. A product deleted since stays in the ranking, and the shopper’s list marks it deleted rather than losing the row.

• The token stays off the admin

  The admin’s list of wishlists shows the id, email, item count and dates, never the token, “the shopper’s credential”. On a demo store or for an agent key the email is masked and searching by it matches nothing.

What it does not do

Read these before an order depends on it. No store is known to run GoCommerce in production yet, so these come from the code, not from anyone’s experience.

• Kept by token, not by accountA list has no customer column. It follows a shopper only as far as the storefront keeps its token; nothing in the module joins two lists or ties one to a sign-in.
• It sends nothingThe module counts who is waiting and keeps their emails, and stops there. No restock mail is sent and no event is emitted when a wished-for product comes back.
• Consent is the storefront’sAn email is stored as given, with no confirmation and no record of consent. The collect_email switch only tells the storefront whether to ask.
• The token is the whole keyAnyone holding a list’s token can read and change it. There is no read-only link for sharing a list.
• Lists are never clearedThere is no route to delete a list and no expiry. A shopper can remove items one at a time and clear the email by sending an empty one; an operator can remove neither.
• Products, not variants, in the rankingThe ranking groups by product: which variant was wished for is on the list but not in the count, and out of stock means no active variant has any to sell. It reads as JSON pages; there is no CSV export.

Related modules

Each is a directory under ext/, imported the same way. Where this one fits in the store: What modules add to a direct-to-consumer store.

• Abandoned cart emails in Go Remind shoppers about baskets they left in a GoCommerce store: a sequence of emails per kind of basket, a counted link back, and the order each one brings back.
• Google Merchant Center and Meta feeds in Go Publish a GoCommerce catalogue as a Google Merchant Center RSS feed and a Meta catalogue CSV: one item per variant, built live from the catalogue.
• IndexNow in Go Tell Bing, Yandex, Seznam and Naver the moment a GoCommerce product or collection changes, over IndexNow: the setup, the key file, and why Google is not in it.
• Klaviyo API in Go Send a GoCommerce store’s orders and abandoned carts to Klaviyo as events, under the metric names Klaviyo’s flows know. The key, the delays, the limits.