> For the complete documentation index, see [llms.txt](https://help.pixfizz.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.pixfizz.com/personalization/custom-design-tools/setting-up-the-sticker-designer.md).

# Setting Up the Sticker Designer

The Sticker Designer lets a customer upload artwork, choose a shape and size, and get a die-cut sticker with a proper cut line. This article covers installing it on a store and configuring it for your production setup.

***

### Before you start

The tool itself is already installed on the platform — the asset and its snippets live centrally and your store inherits them. You do not upload any files.

What you do need:

* Admin access to the store you are installing on
* Your production specification: the sizes you sell, your bleed, your cutter's separation name, and whether your cutter can read a spot colour
* Somewhere to test. **Do not do a first install on a live storefront.**

***

### Step 1: Create the custom fields

**Do this before importing the template.** Custom field *values* travel inside a template export, but field *definitions* do not. If you import first, the values arrive set but invisible and uneditable in admin — which presents as "the tool is broken" with nothing to point at.

Go to **Admin > Settings > Custom Fields > Product** and create each of these:

| Field                     | Type   | What it does                                                                                 |
| ------------------------- | ------ | -------------------------------------------------------------------------------------------- |
| `sticker_width`           | number | Nominal width. The customer picks the real size in the tool, so this is a fallback only      |
| `sticker_height`          | number | Nominal height, same caveat                                                                  |
| `size_unit`               | text   | in or mm. One measurement system per product — a lab is entirely metric or entirely imperial |
| `sticker_max_file_mb`     | number | Upload size limit. Defaults to 50                                                            |
| `cut_spot_name`           | text   | The separation name the cut line is written on. Defaults to CutPath                          |
| `cut_stroke_width`        | number | Cut line weight in points. Defaults to 0.5                                                   |
| `cut_layer`               | text   | TRUE to wrap the cut line in its own optional content group                                  |
| `cut_overprint`           | text   | TRUE to set overprint so the cut line does not knock out artwork                             |
| `cut_split`               | text   | TRUE to deliver the artwork and the cut line as two separate PDFs. See Step 6                |
| `sticker_requires_design` | text   | Set to false to switch the tool-side Add to Cart gate off for this product                   |

> **This list is longer than it should be.** Custom field definitions do not inherit from a parent site to its child sites, so every field is a manual step on every store, forever. These are being consolidated into two shared fields that all the tools use. Until then, create the ones you actually need and leave the rest — every one has a working default.

***

### Step 2: Import the template

1. Download the template export at the bottom of this article.
2. Go to **Admin > Products > Templates** and choose **Import**.
3. Upload the `.tar.gz` file. Do not unpack it first.
4. Open the imported product.

**The prices in this export are all zero.** That is deliberate — a product priced at 0.00 is obviously not ready, whereas a product carrying somebody else's rates can reach a customer. Put your own rates in before publishing.

#### What the import brings with it

The template carries thirteen hidden options. You never edit them by hand, but it is worth knowing what they are for, because a missing one fails quietly:

| Option                                                               | Purpose                                                            |
| -------------------------------------------------------------------- | ------------------------------------------------------------------ |
| `sticker_artwork`                                                    | The print PDF. Also the option that mounts the tool                |
| `sticker_preview`                                                    | A flat PNG for the cart and order record                           |
| `sticker_original`                                                   | The customer's own uploaded file, so an edit can reopen the design |
| `sticker_cutfile`                                                    | The cut-line PDF, when split output is switched on                 |
| `sticker_source`                                                     | Whether the design came from the designer or a print-ready upload  |
| `sticker_cut_offset`, `sticker_smoothing`                            | Cut path settings, restored on edit                                |
| `sticker_bg_removed`, `sticker_bg_tolerance`                         | Background removal state, restored on edit                         |
| `sticker_zoom`, `sticker_pan_x`, `sticker_pan_y`, `sticker_rotation` | Artwork placement, restored on edit                                |

**Upgrading an existing store?** If your sticker product predates these options, add them or re-import. Without the last six, a customer who edits a saved sticker gets their artwork back with the background restored and the cut line reset — see "Editing a saved sticker" below. Without `sticker_cutfile`, split output is not available and the tool stays on a single combined file.

***

### Step 3: Check the product settings

The import brings the right settings with it, but confirm these three:

| Setting                      | Value                                                             | Why                                                                        |
| ---------------------------- | ----------------------------------------------------------------- | -------------------------------------------------------------------------- |
| `requires_design`            | **false**                                                         | See the warning below. The tool runs its own Add to Cart gate              |
| `btn_add_to_cart`            | true                                                              | Shows Add to Cart directly rather than routing to the standard design tool |
| The `sticker_artwork` option | `custom_script` set to `{% snippet 'product/sticker-designer' %}` | This is what places the tool on the page. Nothing else renders it          |

> **Leave `requires_design` off.** It is the platform's own gate, and it waits for a *design record*. This tool does not create one — it attaches *file uploads*. So the button greys out on page load and never comes back. The symptom is nasty: the tool completes, Add to Cart does nothing, and the order sticks on the product page with no error anywhere.
>
> The gate you want is the tool's own, which watches the artwork upload and releases the button when the file lands. It is on by default, and you switch it off per product with the `sticker_requires_design` custom field, never with `requires_design`.

If the tool does not appear on the product page at all, the `custom_script` field on the `sticker_artwork` option is the first thing to check.

***

### Step 4: Set your production values

Go to **Custom Admin > Tools > Sticker Settings**. Everything on that page applies to every sticker product on the store.

The page writes to these site checklist snippets, which you can also edit directly:

* `admin/checklist/sticker-cut-spot-name`
* `admin/checklist/sticker-cut-stroke-width`
* `admin/checklist/sticker-cut-layer`
* `admin/checklist/sticker-cut-overprint`
* `admin/checklist/sticker-cut-split`
* `admin/checklist/sticker-max-file-mb`

A product custom field from Step 1 overrides the site value for that product only.

> The two radio-backed snippets — `sticker-cut-layer`, `sticker-cut-overprint` and `sticker-cut-split` — must contain a value or neither option renders as selected. If a setting looks blank on the settings page, put `TRUE` or `FALSE` in the snippet by hand once and it will behave from then on.

#### Set the cut line separation name

This is the single most important setting to get right, and the only one that fails silently.

Your cutter looks for the cut line on a named spot colour. If the name does not match what your RIP expects, **the RIP treats it as an ordinary spot colour — so the line prints on the material and nothing cuts.** It looks correct in every proof and on screen. You only find out on the press.

Common names:

| Cutter      | Separation name |
| ----------- | --------------- |
| Roland      | `CutContour`    |
| Many others | `CutPath`       |

Set it once per site in **Sticker Settings**, or per product on the `cut_spot_name` custom field.

**Check which one is actually in use** before your first production run. Open the product page, open your browser console, and run:

```js
var r = document.getElementById('stk-root');
console.log(r.getAttribute('data-cut-spot-name'), r.getAttribute('data-cut-spot-source'));
```

A source of `default` means nobody has set it and the tool is using its built-in name. `site_checklist` or `product_custom` means it was set deliberately.

***

### Step 5: Decide how production receives the cut line

By default, production gets **one PDF per sticker**: the artwork at 300 ppi with a soft mask for transparency, plus the cut path as a vector stroke on a Separation colour space, overprinting, on its own optional content layer. The page carries a TrimBox and a BleedBox. That is what most RIPs want.

If your cutter cannot read a spot separation, switch **Sticker Settings > Split Cut File** to **Two separate files**. Production then receives:

| File                  | Contains                              |
| --------------------- | ------------------------------------- |
| `...-artwork-....pdf` | The artwork. No cut geometry anywhere |
| `...-cut-....pdf`     | The cut line only. No image           |

Both files are the same page at the same size with the same origin, so they register on the cutter. **Send both, and do not scale, crop or re-save either one** — that is what breaks registration.

Split output needs the `sticker_cutfile` option on the product. If it is missing, the tool stays on a single combined file rather than dropping the cut line, and logs a warning to the browser console. It will not quietly hand production artwork with no cut line.

> **Fulfillment: do not exclude the cut file.** The preview image is excluded from the production package because the press does not need it. The cut file is the opposite — it is a production artefact and must reach the press. Check your `_additional_files.json` when you turn split output on.

***

### Step 6: Place one real order

**This is the step people skip, and it is the only one that proves the install works.**

Not a preview. Not an add to cart. A completed order, followed through to the file that lands in production.

1. Open the product page and confirm Add to Cart is **disabled**.
2. Open the tool and complete a design.
3. Confirm Add to Cart becomes **enabled**. This transition is the actual test — a button that greys out is not proof that it un-greys.
4. Place the order.
5. Open the delivered file and check it as your press operator would.

Four things to measure on the delivered file, none of which are visible in a proof:

* **The format** — what the file actually is, not what it is named
* **Transparency** — the artwork PDF should carry a soft mask where your artwork has transparent areas
* **Pixel dimensions** — ordered size multiplied by 300
* **The cut line** — still vector, on the separation name you set, and cutting rather than printing

***

### How the cut line is produced

Useful context when a customer asks why their cut looks the way it does.

**Custom Shape traces the artwork's transparency.** The tool builds a mask from the transparent areas of the uploaded file, pushes it outward by the cut distance, smooths it, and writes the result as the cut path.

**A file with no transparency has nothing to trace.** A JPG, or a PNG with a solid white background, has no shape in it other than its own rectangle. The tool says so in the Cut Path panel and falls back to a rounded rectangle rather than inventing a shape. The customer's options are **Remove Background** in the toolbar, or one of the parametric shapes — Circle, Oval, Square, Rectangle.

**Cut distance is how far the cut sits from the graphic**, 0.06in to 0.40in. Raising it shrinks the artwork automatically if the cut line would otherwise run past the edge of the sticker. Lowering it again does not grow the artwork back — the customer's own sizing is left alone.

**Line smoothing** has three settings. None follows the traced outline closely. Smooth rounds tight corners. Extra rounds harder and also closes narrow gaps between separate parts of the artwork, which is what you want on a design with thin necks that would tear on the weed. All three behave the same way at every sticker size.

***

### Editing a saved sticker

A customer who reopens a sticker from their cart or saved projects gets their design back, not just their file: the artwork, whether the background was removed and at what tolerance, the traced cut path, the cut distance, the line smoothing, and the zoom, pan and rotation.

This works because the tool re-runs the background removal on the original file rather than storing a processed copy — so **Undo BG** still works after an edit, and the cut line comes back identical.

Two things to know:

* It needs the six state options listed in Step 2. Without them the artwork reloads at its fit position with the background back.
* Designs saved before those options existed have nothing to restore from, and will behave the old way. This only helps orders placed from the update onwards.

***

### Print-ready uploads

If a customer uploads a PDF that already contains a cut path on your separation name, the tool detects it and passes the file through to production exactly as uploaded. The designer controls are disabled, and the artwork panel says so.

The tool reports the PDF's page size in that message. **It does not check that page size against the sticker size the customer selected** — a 2.25in print-ready file will be accepted on a 3in product and sent to production at 2.25in. Check the page size in the message matches the ordered size before releasing the job.

***

### Troubleshooting

#### The tool does not appear on the product page

The `custom_script` custom field on the `sticker_artwork` template option is empty or misspelled. It must contain exactly `{% snippet 'product/sticker-designer' %}`.

#### Add to Cart never becomes available after the tool completes

First check `requires_design` on the product is **false** — see the warning in Step 3. That is the usual cause, and the button will never re-enable while it is on.

If it is already false, check the browser console for an error. If there is none, the tool completed but could not release the page's Add to Cart button. Report it — this is a platform-side problem, not a configuration one.

As an immediate workaround you can set `sticker_requires_design` to `false`, which switches the tool-side gate off. Note that this also allows a customer to buy the product without opening the tool, so treat it as temporary.

#### Custom Shape gives a rounded rectangle instead of tracing the artwork

The uploaded file has no transparency, so there is no shape to follow. See "How the cut line is produced". The tool shows a message in the Cut Path panel when this happens.

#### The review step sits on "Uploading your design… 0 of 0"

Fixed in a platform update. If you still see it, your store is running a pinned local copy of the tool asset rather than the current central one. Check the version in the browser console:

```js
console.log(window.StickerDesigner.version);
```

If that reports an older version than the one your other stores report, delete the local copy of `sticker-designer.js` from this store's assets so it inherits the current file.

#### Production received one file when I expected two

Split output needs the `sticker_cutfile` option on the product. The tool falls back to a single combined file when it is missing and logs the reason to the browser console. Add the option, or re-import the template.

#### Reopening a saved sticker loses the background removal and the cut line

The product is missing the six state options listed in Step 2, or the design was saved before they were added. See "Editing a saved sticker".

#### The tool appears but reads the wrong settings

Open the browser console on the product page and run:

```js
console.log(document.getElementById('stk-root').dataset);
```

Every setting the tool resolved is listed there, and the `*-source` entries tell you where each value came from — `product_custom`, `site_checklist`, or `default`. If something reads `default` that you thought you had set, the field name is wrong or the value did not save.

`data-product-seen` is worth a look too. If it reads `false`, the page did not hand the tool the product at all, and every product custom field has silently fallen back to its default.

#### Prices show as 0.00

Expected on a fresh import. See Step 2.

***

### Downloads

{% file src="/files/gyt9rlwxPJ4b0z2QxKAo" %}

* `pixfizz-stickers-template.tar.gz` — the template export, with rates zeroed

***

### Related

* Installing a custom design tool: shared concepts
* Setting up fulfillment for custom design tool products
