> For the complete documentation index, see [llms.txt](https://uxsmart.gitbook.io/velare/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://uxsmart.gitbook.io/velare/buy-and-install/create-required-metafields/metafields/custom-product-badge.md).

# Custom Product Badge

The **Custom product badge** metafield lets you write your own badge text on a single product, for example `Velare`, `Limited edition`, or `Handmade`. Vélare reads that text and shows it as a badge next to the automatic **Sale**, **New**, and **Sold out** badges. It appears on the product page, on the product's card wherever that product is listed (such as a collection page or the homepage), and in Quickview. Because the text lives on the product itself, you can highlight one product without editing the theme or touching any other product.

{% embed url="<https://www.youtube.com/watch?v=0ENRi6hqDz4>" %}

### When you need this <a href="#when-you-need-this" id="when-you-need-this"></a>

* You want a badge that says something **only you decide**, not one of the automatic badges.
* The text is **different from product to product**, so a fixed theme setting would not work.
* You want to add or remove the badge later by editing one field on the product.

### Before you start <a href="#before-you-start" id="before-you-start"></a>

* You can access **Settings > Custom data** in your Shopify admin. (Staff accounts need the matching permission.)
* You know which products should carry a badge, and you have the wording ready. Keep it short so it fits the badge.

### Step 1: Create the Custom product badge metafield <a href="#step-1-create-the-metafield" id="step-1-create-the-metafield"></a>

{% hint style="success" %}
**Steps:**

1. Go to **Shopify admin > Settings > Custom data > Products** (**Custom data** is shown as **Metafields and metaobjects** in some admin versions).
2. Click **Add definition**.
3. Fill in:
   * Name: `Custom product badge`
   * Namespace and key: `custom.custom_product_badge`
   * Type: **Single line text - One value**
4. Click **Save**.
   {% endhint %}

*Result:* **Custom product badge** is now part of your product data and appears as an empty field on every product.

<figure><img src="/files/M2FFHG7iyUj20xWZhY1x" alt=""><figcaption></figcaption></figure>

### Step 2: Write the badge text on each product <a href="#step-2-write-the-badge-text" id="step-2-write-the-badge-text"></a>

{% hint style="success" %}
**Steps:**

1. Go to **Shopify admin > Products**.
2. Select the product you want to badge.
3. Scroll down to the product's **Metafields** area.
4. Type the badge wording into the **Custom product badge** field.
5. Click **Save**.
6. Repeat for every other product that needs a badge. Leave the field empty on products that should not show one.
   {% endhint %}

*Result:* each product carries its own badge wording, and products with an empty field show no custom badge.

<figure><img src="/files/WWroFbRxoIzo1tP3wCQZ" alt=""><figcaption></figcaption></figure>

### Step 3: Enable the custom badge in the theme <a href="#step-3-enable-the-custom-badge" id="step-3-enable-the-custom-badge"></a>

The badge only shows on the storefront once you turn it on in the theme.

{% hint style="success" %}
**Steps:**

1. Go to **Shopify admin > Online Store > Themes > Customize**.
2. Open **Theme settings > Badges > Custom badge**.
3. Turn the **Custom badge** on.
4. Click **Save**.
   {% endhint %}

*Result:* products that have text in the **Custom product badge** field now show their badge on the storefront.

### What you should see <a href="#what-you-should-see" id="what-you-should-see"></a>

On the product page, the badge appears with the exact text you typed, using the badge colors set in the theme. Every product shows its own wording through the same block, and products with an empty field simply show nothing.

<figure><img src="/files/Aiik4IqWm3UqRrft2zQO" alt=""><figcaption></figcaption></figure>

### If something goes wrong <a href="#if-something-goes-wrong" id="if-something-goes-wrong"></a>

* **No badge appears on any product.** Check the definition from Step 1. A namespace and key other than `custom.custom_product_badge` creates a different metafield that the theme does not read.
* **The badge appears on some products only.** That is expected. Only products with text in the field show a badge, so fill in the field on the remaining products.
* **The badge text is cut off.** Shorten the wording. Badges are sized for a word or two.
* **The badge is there but hard to read.** Adjust the text and background colors in **Theme settings > Badges > Custom badge**.

### Related pages <a href="#related-pages" id="related-pages"></a>

* [Metafields](/velare/buy-and-install/create-required-metafields/metafields.md): the full list of metafields to create
* [Short Description](/velare/buy-and-install/create-required-metafields/metafields/short-description.md): another per-product metafield, set up the same way
* [Complementary products](/velare/buy-and-install/create-required-metafields/metafields/complementary-products.md): the next metafield in this section
* [Badges](/velare/customize-your-pages/badges.md): colors and visibility for the Sale, New, Sold out, and Custom badges
* [Product information](/velare/customize-your-pages/product-page/page-template-sections/product-information.md): the product page section that holds the **Badges** block


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://uxsmart.gitbook.io/velare/buy-and-install/create-required-metafields/metafields/custom-product-badge.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.