# Integrating Jane Gold

Jane Gold is our program to rewards consumers with brand-sponsored cash back on in-stock\
product at no cost to stores or shoppers. You can find more information about it [here](https://customer-support.iheartjane.com/s/article/Jane-Gold-FAQs). You will need to opt your stores into this program before integrating it into your menu. Please contact your partner success representative for more info.

*Note: In order to integrate with Jane Gold, you will need to be using our* [*embedded checkout*](/jane-docs/implementing-roots/embedding-checkout.md) *flow. There is key functionality in our checkout that it is not currently possible to replicate within our checkout APIs.*

## Brand Guidelines

Jane Gold requires certain guidelines be followed to ensure the experience for shoppers to earn cash back is consistent across all surfaces in Jane's ecosystem. Please adhere to the items listed below when integrating Jane Gold:

* Jane Gold is a cash back program, not a traditional discount, and requires shoppers to pay full price before receiving cash deposited directly into their bank account. As such, please phrase any shopper communications accordingly (e.g., buy this item and get \[discount label] deposited to your linked bank account)
* Any sales badge, filter, or other identifier of products eligible for Jane Gold should be branded using one of the following options. For more file types or guidance, please reach out to your partner success representative

  * The Jane Gold icon\
    ![](/files/N83L17ciAVMguVN3Fm8q)
  * The Jane Gold logo

  <div align="left"><figure><img src="/files/7hkNUw8SCP5JStGiJnwY" alt=""><figcaption></figcaption></figure></div>

  * The Jane Gold color (#FFC220)
* Jane offers an [educational site](https://www.iheartjane.com/janegold?utm_source=website\&utm_medium=Jane) and user-facing [FAQs](https://customer-support.iheartjane.com/s/article/Jane-Gold-FAQs) to answer questions about the program, feel free to link to either or both site on your website

## Implementation Details

### Integrating with Facets/Filters

You will want to allow customers to filter by products including Jane Gold discounts. On our menus, we show a filter on the top nav.

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

You can determine the number of products eligible for discounts by looking at the facets, and identifying the number of products that have `has_brand_discount` set to `true`.

You can then filter by this to get a list of these products.

### Integrating with Product Listings

You will want to show the appropriate discount when displaying the product card and product detail page to the customer. Here is what we display on the product card and product detail page for our own menus

<figure><img src="/files/gIfCbLKXhIzw3e8TBkXj" alt="" width="187"><figcaption><p>Product Cart</p></figcaption></figure>

<figure><img src="/files/QZOqCkR0KK5mvXWue4JS" alt=""><figcaption><p>Product Detail Page</p></figcaption></figure>

In order to display these discounts, you will want to show the `brand_special_prices` field from Algolia or the Store Operation API. You should display the `discount_label` field, which represents the offer as it should be relayed to the customer.

### Integrating with Checkout

In order for customers to receive Jane Gold rewards discounts, they will need to be signed in and complete a step to link their bank account. Jane will take care of the bank account linking, but you will need to make sure they are logged in.

#### If you are using Jane Auth

If you are using Jane Auth, which lets users sign in from the cart, you don't need to do anything. So long as `disableAuthFeatures` is set to `false` in the [embedded checkout config object](/jane-docs/implementing-roots/embedding-checkout.md#cart-parameters), the sign-in link should show up within the cart. Here is a screenshot of what this looks like.

<figure><img src="/files/7BypXK3xmPp1DDU691YV" alt=""><figcaption></figcaption></figure>

#### If you are using Cognito Auth

First of all, you must be using the v2 version of our [embedded checkout](/jane-docs/implementing-roots/embedding-checkout.md#adding-the-script).

If the cart contains any products eligible for Jane Gold discounts, the cart page will show a section with Gold details and a link to log in or connect a bank account.&#x20;

If the user has not been logged in by providing a valid Cognito token in the `fetchCart` [payload](/jane-docs/implementing-roots/embedding-checkout.md#checkout-with-a-pre-existing-cart), they will see the following Sign In button, which will link to the `loginUrl` in the `fetchCart` options object.&#x20;

<figure><img src="/files/OWKqsJufDz8kq8aal9gr" alt=""><figcaption><p>guest view</p></figcaption></figure>

After the user successfully logs in, re-send the `fetchCart` postmessage with the Cognito token. The user should now see a prompt to link a bank account. Account linking is handled entirely by Jane; you do not need to implement anything.

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

Once the user has linked their account, the prompt to link an account should be replaced with details of the account. The user can now proceed through checkout and the discounts will be awarded once the order is complete.

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

If the user does not complete these steps on the cart page, they can still do it on the checkout page. For authenticated users, bank account linking works the same as on the cart page. For guest users, be aware that when the user navigates away to login, you will need to re-send the `fetchCart` postmessage and the user will need to restart the checkout form. We do not support saving the progress of the checkout form.


---

# Agent Instructions: 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:

```
GET https://docs.iheartjane.com/jane-docs/implementing-roots/integrating-jane-gold.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
