> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sezzle.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Shopify Widgets

<Warning>
  Shopify has disabled the legacy `Sezzle` private/unpublished widget app. If you are currently using the `Sezzle` app, please update to the `Sezzle Widget` public app now.
</Warning>

<iframe width="560" height="315" className="rounded-xl" src="https://www.youtube.com/embed/8lcd7N6HJxY?si=c8HDzSUBjOQdH0oB" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen />

## Purpose

Increase AOV and conversions by promoting Sezzle on your storefront. Easily install assets to product and cart pages with the Sezzle Widget app at no additional cost!

## Prerequisites

1. You should have a Sezzle merchant account
   * Please visit our [signup page](https://dashboard.sezzle.com/merchant/signup) if you don't have an account
2. [Install and configure](https://docs.sezzle.com/docs/plugins/shopify-payments/) the Sezzle Payments App

## Getting Started

1. Log in to your website's Shopify admin
2. Install the [Sezzle Widget app](https://apps.shopify.com/sezzle-widget)
   * Alternatively, click the `Get the Widgets App` button under the `Add Sezzle to your product and cart pages` step of the Sezzle Merchant Dashboard Setup Checklist
3. Click `Install`

   <Frame>
     <img src="https://mintcdn.com/sezzle/WWvtQJ-zXjzjnMaw/images/docs/plugins/shopify/widgets/1-install-auth.png?fit=max&auto=format&n=WWvtQJ-zXjzjnMaw&q=85&s=c1a09acd0b8a8433ab3ddb9d846c6c73" alt="1 Install Auth Pn" width="586" height="407" data-path="images/docs/plugins/shopify/widgets/1-install-auth.png" />
   </Frame>
4. Within the Sezzle Widget app, enter your Public API Key and click `Link Sezzle Account`
   * For most merchants, we are able to pre-fill the public API key based on the Shopify store URL
   * To enter the API key manually, copy from the API Keys page within the [Sezzle Merchant Dashboard Settings](https://dashboard.sezzle.com/merchant/settings/apikeys)

     <Frame>
       <img src="https://mintcdn.com/sezzle/WWvtQJ-zXjzjnMaw/images/docs/plugins/shopify/widgets/2-api-key.png?fit=max&auto=format&n=WWvtQJ-zXjzjnMaw&q=85&s=43830cb5159679f35df43e4a9f8d7809" alt="2 Api Key Pn" width="1000" height="197" data-path="images/docs/plugins/shopify/widgets/2-api-key.png" />
     </Frame>

## Installation

Please select ONE of the following installation methods:

<CardGroup cols={1}>
  <Card title="Installation Wizard" icon="wand-magic-sparkles" horizontal>
    [Jump to section](#installation-wizard)
  </Card>

  <Card title="Embed Blocks (manual)" icon="block-brick" horizontal>
    [Jump to section](#installing-as-embed-blocks-manual)
  </Card>

  <Card title="App Blocks (2.0 themes only)" icon="block-brick-fire" horizontal>
    [Jump to section](#installing-as-app-blocks)
  </Card>
</CardGroup>

### Installation Wizard

1. Select the theme you wish to edit, then click `Next`

   <Warning>
     This field does not default to your live theme - you must make a selection
   </Warning>

   <Frame>
     <img
       src="https://mintcdn.com/sezzle/WWvtQJ-zXjzjnMaw/images/docs/plugins/shopify/widgets/3-select-theme.png?fit=max&auto=format&n=WWvtQJ-zXjzjnMaw&q=85&s=e597bd61301f31eb2f64eaa4f43886ee"
       alt="3 Select Theme
   Pn"
       width="1002"
       height="247"
       data-path="images/docs/plugins/shopify/widgets/3-select-theme.png"
     />
   </Frame>
2. Select the asset you wish to install, then click `Next`

   <Frame>
     <img src="https://mintcdn.com/sezzle/WWvtQJ-zXjzjnMaw/images/docs/plugins/shopify/widgets/4-select-product.png?fit=max&auto=format&n=WWvtQJ-zXjzjnMaw&q=85&s=38ba95ba80889d900bed447efa75fa17" alt="4 Select Product Pn" width="1002" height="195" data-path="images/docs/plugins/shopify/widgets/4-select-product.png" />
   </Frame>
3. Select the page you wish to install on, then click `Finish`

   <Frame>
     <img src="https://mintcdn.com/sezzle/WWvtQJ-zXjzjnMaw/images/docs/plugins/shopify/widgets/5-select-page.png?fit=max&auto=format&n=WWvtQJ-zXjzjnMaw&q=85&s=488cc63c10d6506d90be21b6f2dae772" alt="5 Select Page Pn" width="1002" height="171" data-path="images/docs/plugins/shopify/widgets/5-select-page.png" />
   </Frame>
4. Click the `Activate` button

   <Warning>
     You must click Activate for changes to take effect
   </Warning>
5. [Customize](#customizations) as desired, then click `Save`

<Note>
  Widgets not rendering correctly? [Request Help](#request-help)
</Note>

### Installing as Embed Blocks (manual)

If you are not already in the app, you can alternatively enable the Sezzle products directly from your theme customizer window.

1. Within Shopify Admin, go to `Sales Channels` then `Online Store`
2. Under `Themes`, click `Customize` for the theme you wish to edit

   <Frame>
     <img src="https://mintcdn.com/sezzle/WWvtQJ-zXjzjnMaw/images/docs/plugins/shopify/widgets/7-theme-customize.png?fit=max&auto=format&n=WWvtQJ-zXjzjnMaw&q=85&s=0f7ac79c968a1fc853b26bab1da1e59e" alt="7 Theme Customize Pn" width="791" height="294" data-path="images/docs/plugins/shopify/widgets/7-theme-customize.png" />
   </Frame>
3. In the upper-left corner, click the third icon `App Embeds`
4. Search for Sezzle and activate the product(s) you wish to install
   * [Customize](#customizations) as desired and click `Save`

     <Frame>
       <img src="https://mintcdn.com/sezzle/WWvtQJ-zXjzjnMaw/images/docs/plugins/shopify/widgets/8-pdp-embed.png?fit=max&auto=format&n=WWvtQJ-zXjzjnMaw&q=85&s=e99d4bcc90cf17c0ae64eade7e979dff" alt="8 Pdp Embed Pn" width="805" height="592" data-path="images/docs/plugins/shopify/widgets/8-pdp-embed.png" />
     </Frame>

### Installing as App Blocks

App blocks allow merchants to control product placement. Compatible with 2.0 themes only.

1. Within `Shopify Admin`, go to `Sales Channels` then `Online Store`
2. Under `Themes`, click `Customize` for the theme you wish to edit

   <Frame>
     <img src="https://mintcdn.com/sezzle/WWvtQJ-zXjzjnMaw/images/docs/plugins/shopify/widgets/7-theme-customize.png?fit=max&auto=format&n=WWvtQJ-zXjzjnMaw&q=85&s=0f7ac79c968a1fc853b26bab1da1e59e" alt="7 Theme Customize Pn" width="791" height="294" data-path="images/docs/plugins/shopify/widgets/7-theme-customize.png" />
   </Frame>
3. In the top toolbar, ensure the third icon `Activate Inspector` is activated

#### Installing Widget App Block on Product Page

1. Navigate to a product page
2. Hover over the area where you wish to display the widget
3. If app blocks can be placed there, `+` or `Add block` will appear. Click, then select `Sezzle Widget` under the `Apps` tab
   * Alternatively, open the `Sections` tab and click `Add Block`
   * Under the `Apps` tab, select `Sezzle Widget`
   * Drag & drop the block to the desired location in the contents menu

     <Frame>
       <img src="https://mintcdn.com/sezzle/WWvtQJ-zXjzjnMaw/images/docs/plugins/shopify/widgets/10-pdp-block.png?fit=max&auto=format&n=WWvtQJ-zXjzjnMaw&q=85&s=a16ad41919d5944999d5cfea02c234fd" alt="10 Pdp Block Pn" width="1212" height="1256" data-path="images/docs/plugins/shopify/widgets/10-pdp-block.png" />
     </Frame>
4. [Customize](#customizations) as desired, then click `Save`

#### Installing Widget App Block and Checkout Button on Cart Page

1. Add a product to the cart
2. Navigate to the cart page
3. Hover over the area where you wish to display a Sezzle product
4. If app blocks can be placed there, `+` or `Add block` will appear
   * Click, then under the `Apps` tab, select the product
   * Alternatively, open the `Sections` tab and click `Add Block`
     * Under the `Apps` tab, select `Sezzle Widget`
     * Drag & drop the block to the desired location in the contents menu
5. Repeat the previous two steps for the other product, if desired

   <Frame>
     <img src="https://mintcdn.com/sezzle/WWvtQJ-zXjzjnMaw/images/docs/plugins/shopify/widgets/11-cart-block.png?fit=max&auto=format&n=WWvtQJ-zXjzjnMaw&q=85&s=0513e1a16a2d98960b26953d0c9a7363" alt="11 Cart Block Pn" width="1286" height="950" data-path="images/docs/plugins/shopify/widgets/11-cart-block.png" />
   </Frame>
6. [Customize](#customizations) as desired, then click `Save`

### Customizations

The following section covers customization options that are available through the app.

#### Widget Customization Options

| **Property** | **Default** | **Range/Options** | **Step** |
| :----------- | :---------- | :---------------- | :------- |
| Font Size    | `14px`      | `9px` - `18px`    | `0.5`    |
| Font Family  | inherit     | (see dropdown)    | -        |

<Frame>
  <img
    src="https://mintcdn.com/sezzle/WWvtQJ-zXjzjnMaw/images/docs/plugins/shopify/widgets/12-widget-customize.png?fit=max&auto=format&n=WWvtQJ-zXjzjnMaw&q=85&s=39e0de824645345965eee10b3715b71e"
    alt="12 Widget Customize
Pn"
    width="1488"
    height="696"
    data-path="images/docs/plugins/shopify/widgets/12-widget-customize.png"
  />
</Frame>

#### Checkout Button Customization Options

| **Property**                      | **Default**            | **Range/Options**     | **Step** |
| :-------------------------------- | :--------------------- | :-------------------- | :------- |
| Template                          | `Checkout with Sezzle` | `Pay with Sezzle`     | -        |
| Theme                             | `Light`                | `Dark`                | -        |
| Padding (left and right only)     | `9px`                  | `0px` - `30px`        | `0.5`    |
| Margins (controlled individually) | `0`                    | `-20` - `20`          | `0.5`    |
| Width                             | `auto`                 | `fit-content`, `100%` | -        |

<Frame>
  <img
    src="https://mintcdn.com/sezzle/WWvtQJ-zXjzjnMaw/images/docs/plugins/shopify/widgets/13-button-customize.png?fit=max&auto=format&n=WWvtQJ-zXjzjnMaw&q=85&s=0f5b15fb562e4567d7d4b55ff4a1cb65"
    alt="13 Button Customize
Pn"
    width="306"
    height="790"
    data-path="images/docs/plugins/shopify/widgets/13-button-customize.png"
  />
</Frame>

### Default Placement

**If Checked**

* The Sezzle Checkout Button will be placed after the native checkout button and inherit page styles

**If Unchecked**

* The button will be placed as indicated by the app block placement
* Styles may also be affected, based on the placement selected

#### Custom CSS

If you are familiar with CSS and would like additional style customizations, you can write them directly to your theme.

1. In the upper-left corner, click the second icon `Theme Settings`
2. Expand Custom CSS section and write your custom snippet, then click `Save`

   <Frame>
     <img src="https://mintcdn.com/sezzle/WWvtQJ-zXjzjnMaw/images/docs/plugins/shopify/widgets/14-button-customize-css.png?fit=max&auto=format&n=WWvtQJ-zXjzjnMaw&q=85&s=b1e300b01decd03a60825f60ea86598f" alt="14 Button Customize Css Pn" width="300" height="211" data-path="images/docs/plugins/shopify/widgets/14-button-customize-css.png" />
   </Frame>

### Troubleshooting

<AccordionGroup>
  <Accordion title="Need to update API key">
    You will need to uninstall and re-install the app.
  </Accordion>

  <Accordion title="Widgets duplicating">
    If you are using app blocks and there are multiple price elements on the page, all the corresponding widgets will cluster at the app block placement.

    <Tip>
      Consider switching to embed blocks, or [contact Sezzle support](#request-help) to update the config override.
    </Tip>
  </Accordion>

  <Accordion title="Cannot see widget">
    * Widgets will only show for IP addresses in US and CA. If you are viewing from a different country, please use a VPN.
    * By default, widgets only show on products up to \$2500.
    * Confirm that only one installation method is in use. Additionally, only use one app block of each product per page.

    <CardGroup cols="1">
      <Card title="If you are using app blocks" icon="block-brick-fire">
        Check that the widget was not placed further down on the page.
      </Card>

      <Card title="If you are using a custom theme or pagebuilder" icon="hammer">
        * App blocks might work where embed blocks do not.
        * Otherwise, [contact Sezzle support](#request-help) for a custom configuration.
        *
      </Card>

      <Card title="If you previously had widgets implemented with a config override" icon="code">
        * Please [contact Sezzle support](#request-help) to update the override.
      </Card>

      <Card title="If you have ever added custom CSS or Javascript to hide or remove the Sezzle widget" icon="wand-magic-sparkles">
        * Remove these snippets from your theme.
      </Card>
    </CardGroup>
  </Accordion>

  <Accordion title="Cannot see checkout button">
    <CardGroup cols="1">
      <Card title="If the Shopify native checkout button does not have the expected attribute" icon="face-confused">
        * App blocks with `Default Placement` unchecked may work.
      </Card>

      <Card title="All other cases" icon="code">
        * We usually resort to installing a [manual code snippet](#checkout-button-manual-theme-code-snippet-installation).
        * [Contact Sezzle support](#request-help) if you would like assistance.
      </Card>
    </CardGroup>
  </Accordion>

  <Accordion title="Content or placement issues">
    If you have noticed a bug in the widget or checkout button, please [contact Sezzle support](#request-help) to notify us of the issue. We can then determine whether this is an issue for all merchants or your specific theme and work to resolve accordingly.
  </Accordion>
</AccordionGroup>

#### Customization

* We offer a few select customization options. Please [contact Sezzle support](#request-help) to request any of the following:
  * Grayscale logo
  * Reflect checkout minimum in widget
  * Reflect Sezzle/Afterpay dual widget
  * Style & position changes
    * For position changes, you must use the embed block option.
  * Conditional rendering for subscription, gift cards, etc.
  * Conditional rendering above a certain price threshold

<Note>
  Implementing customizations may prevent widgets from showing on unpublished
  themes and will require help from the Sezzle team to update widgets when a
  new theme is published.
</Note>

### Request Help

If the `Sezzle Widget` app is not able to automatically install the Sezzle widget or checkout button on your storefront, please use the Request Help form within the app to contact the Sezzle Merchant Integrations team.

The Request Help form in the `Sezzle Widget` app is for widget and checkout button help only. For questions regarding your account or issues with the Sezzle payment option at checkout, please reach out to [merchantsupport@sezzle.com](mailto:merchantsupport@sezzle.com).

<Note>
  The Sezzle Merchant Integrations team does not respond to inquiries. If you
  request a response or if we need to contact you regarding your request, we
  will forward the response through our Merchant Support team.
</Note>

<Frame>
  <img
    src="https://mintcdn.com/sezzle/WWvtQJ-zXjzjnMaw/images/docs/plugins/shopify/widgets/15-request-help.png?fit=max&auto=format&n=WWvtQJ-zXjzjnMaw&q=85&s=15ae26ee0a57f9f19c73a9c0c401fb6b"
    alt="15 Request Help
Pn"
    width="876"
    height="364"
    data-path="images/docs/plugins/shopify/widgets/15-request-help.png"
  />
</Frame>

### Manual Theme Code Snippet Installation

Installations that require code changes directly to the theme are not recommended unless your site uses a headless CMS, and should be used as a last resort.

#### Widget Manual Theme Code Snippet Installation

1. Within `Shopify Admin`, go to `Sales Channels` then `Online Store`
2. Under Themes, click `...` then `Edit Code` for the theme you wish to edit

   <Frame>
     <img src="https://mintcdn.com/sezzle/WWvtQJ-zXjzjnMaw/images/docs/plugins/shopify/widgets/6-activate.png?fit=max&auto=format&n=WWvtQJ-zXjzjnMaw&q=85&s=d218abe2a5fded86f7087062f1b2b7f7" alt="6 Activate Pn" width="2634" height="626" data-path="images/docs/plugins/shopify/widgets/6-activate.png" />
   </Frame>
3. In the `Code Explorer`, go to the `Layout` folder and select the `theme.liquid` file
4. Copy and paste the script to the very bottom of the file
   * Script template to be inserted into your webpage:

     ```
     <script src="https://widget.sezzle.com/v1/javascript/price-widget?uuid={sezzle_merchant_uuid}"></script>
     ```
5. Replace `{sezzle_merchant_uuid}` (including the curly brackets) in the script template with your site’s Merchant ID
   * This can be found in the [Sezzle Merchant Dashboard Business Settings](https://dashboard.sezzle.com/merchant/settings/business)
   * Example with Merchant ID value updated:

     ```
     <script src="https://widget.sezzle.com/v1/javascript/price-widget?uuid=12a34bc5-6de7-890f-g123-4hi5678jk901"></script>
     ```
6. Click `Save`

#### Checkout Button Manual Theme Code Snippet Installation

To install the checkout button directly to your theme code, please refer to the documentation and snippet on [GitHub](https://github.com/sezzle/static-widgets/tree/production/src/sezzle-checkout-button#install-as-html).

## Uninstalling

### Uninstalling Embed Blocks

1. Within `Shopify Admin`, go to `Sales Channels` then `Online Store`
2. Under `Themes`, click `Customize` for the theme you wish to edit

   <Frame>
     <img src="https://mintcdn.com/sezzle/WWvtQJ-zXjzjnMaw/images/docs/plugins/shopify/widgets/7-theme-customize.png?fit=max&auto=format&n=WWvtQJ-zXjzjnMaw&q=85&s=0f7ac79c968a1fc853b26bab1da1e59e" alt="7 Theme Customize Pn" width="791" height="294" data-path="images/docs/plugins/shopify/widgets/7-theme-customize.png" />
   </Frame>
3. In the upper-left corner, click the third icon `App Embeds`
4. Toggle the desired embed block(s) to the `OFF` position, then click `Save`

   <Frame>
     <img src="https://mintcdn.com/sezzle/WWvtQJ-zXjzjnMaw/images/docs/plugins/shopify/widgets/18-uninstall-embed.png?fit=max&auto=format&n=WWvtQJ-zXjzjnMaw&q=85&s=53e36bad9d25cb7c9364fa0c6942ffdc" alt="18 Uninstall Embed Pn" width="356" height="261" data-path="images/docs/plugins/shopify/widgets/18-uninstall-embed.png" />
   </Frame>

### Uninstalling App Blocks

1. Within `Shopify Admin`, go to `Sales Channels` then `Online Store`
2. Under `Themes`, click `Customize` for the theme you wish to edit

   <Frame>
     <img src="https://mintcdn.com/sezzle/WWvtQJ-zXjzjnMaw/images/docs/plugins/shopify/widgets/7-theme-customize.png?fit=max&auto=format&n=WWvtQJ-zXjzjnMaw&q=85&s=0f7ac79c968a1fc853b26bab1da1e59e" alt="7 Theme Customize Pn" width="791" height="294" data-path="images/docs/plugins/shopify/widgets/7-theme-customize.png" />
   </Frame>
3. Navigate to a product page
4. In the upper-left corner, click the first icon `Sections`
5. Next to the `Sezzle Widget` block, click the `Delete` trash can icon, then click `Save`
6. Navigate to the cart page, and repeat the previous step for each product, then click `Save`

   <Frame>
     <img src="https://mintcdn.com/sezzle/WWvtQJ-zXjzjnMaw/images/docs/plugins/shopify/widgets/20-uninstall-block.png?fit=max&auto=format&n=WWvtQJ-zXjzjnMaw&q=85&s=fca3aad15485e3d5161292309e4f0e6f" alt="20 Uninstall Block Pn" width="512" height="956" data-path="images/docs/plugins/shopify/widgets/20-uninstall-block.png" />
   </Frame>

### Uninstalling Manual Theme Code Snippet

<Note>
  You should only need to perform this step if you had the old `Sezzle` private app installed, or if you installed products manually
</Note>

1. Within `Shopify Admin`, go to `Sales Channels` then `Online Store`
2. Under `Themes`, click `...` then `Edit Code` for the theme you wish to edit

   <Frame>
     <img src="https://mintcdn.com/sezzle/WWvtQJ-zXjzjnMaw/images/docs/plugins/shopify/widgets/7-theme-customize.png?fit=max&auto=format&n=WWvtQJ-zXjzjnMaw&q=85&s=0f7ac79c968a1fc853b26bab1da1e59e" alt="7 Theme Customize Pn" width="791" height="294" data-path="images/docs/plugins/shopify/widgets/7-theme-customize.png" />
   </Frame>
3. Review the layout/theme.liquid file for any Sezzle code snippets
   1. Remove them, then click `Save`
   2. Repeat for any files containing product and cart in the name
4. Once all references are removed, search for files containing sezzle in the name, and delete

### Uninstalling the App

1. Go to `Apps` then `Sezzle Widget`
2. In the top-right corner, click the `Menu` icon, then select `App Settings`
3. Click `Delete App`

   <Warning>
     Deleting the app will automatically remove all app blocks and embed blocks from all themes. Any code change installations will not be removed automatically.
   </Warning>
