Install on WooCommerce

The Mulberry WooCommerce extension is a self-contained plugin: install it, paste in your credentials, and it handles the rest. On a standard WooCommerce theme it fetches offers and renders them on product pages, registers each warranty sale at checkout, and cancels coverage when an order or item is cancelled — all automatically, with no SDK code to write.

🚧

The extension won't show offers until it's configured

Installing the plugin is not enough. Offers stay hidden until you save all six settings — including your Retailer ID, API Token, and Public Token. See Configure the extension below.

Prerequisites

Before you start, make sure:

1. You have your Mulberry credentials — Retailer ID, API Token, and Public Token. See Get your credentials.
2. You can sign in to WordPress admin (www.yourdomain.com/wp-admin) with permission to install plugins.
3. You know whether you're configuring production or staging — the host URLs differ.

Download the extension

Download the latest extension .zip from the GitHub repository: github.com/MulberryHQ/woo-commerce-extension.

• You should now have the extension .zip saved locally. Don't unzip it — WordPress installs the archive directly.

Install the plugin

In WordPress admin:

1. From the left nav, go to Plugins → Add New Plugin.
2. Click Upload Plugin at the top of the page.
3. Click Choose file, select the .zip you downloaded, then click Install Now.
   • WordPress uploads and unpacks the archive. You should now see an Activate Plugin button.
4. Click Activate Plugin.
   • You should now see WooCommerce Mulberry Warranty Integration in your Plugins list, marked active.

Configure the extension

The plugin can't reach Mulberry until you save your credentials and host URLs.

1. From the left nav, go to Plugins.

2. Find WooCommerce Mulberry Warranty Integration and click Settings beneath its name.

3. Enter each field:

   Field	Value
   Mulberry API URL	Production: https://www.getmulberry.com · Staging: https://staging.getmulberry.com
   Mulberry Partner Base URL	Production: https://partner.getmulberry.com · Staging: https://partner-staging.getmulberry.com
   Platform Domain Name	Leave empty.
   Mulberry Retailer ID	From Get your credentials.
   Mulberry API Token	From Get your credentials.
   Mulberry Public Token	From Get your credentials.

4. Click Save changes.

   • You should now see a saved confirmation, and the extension is connected to Mulberry.

📘

Two tokens, two jobs

The Public Token initializes the in-browser SDK that fetches and renders offers (it's client-safe). The API Token authenticates the extension's server-side calls to Mulberry and never reaches the browser. Both are required. See Get your credentials.

What runs automatically

On a standard WooCommerce theme you don't write any SDK code. Once configured, the extension wires up the full lifecycle for you:

• Offers on product pages. When a shopper opens a product page, the extension reads the product details, fetches an offer from Mulberry, and renders it on the page — inline and/or as a modal. There's nothing to call by hand. The extension uses the shared Mulberry browser SDK under the hood; for the underlying contracts (the getWarrantyOffer call, the offer object, inline vs. modal rendering), see the Mulberry SDK reference.
• Sale registration. When a customer buys a plan, the extension automatically calls Mulberry's checkout endpoint (POST /api/checkout) to register the sale, using the hosts you configured above. Registration is automatic — you do nothing.
• Cancellations. When an order or item is cancelled, the extension automatically calls Mulberry's cancellation endpoint (POST /api/order_cancelled) and the associated warranty is cancelled. See Cancel a warranty.

👍

No checkout or cancellation code to write

Unlike a custom integration, you never register sales or post cancellations yourself on WooCommerce. The extension hits both endpoints for you. Claims and refunds are handled the same cross-cutting way — see How claims work.

Offer placement (inline vs. modal)

Whether offers render inline on the product page or in a modal is driven by your account's placement settings, configured in your Mulberry dashboard. The extension reads those settings at request time and renders accordingly — you don't set them in WordPress.

📘

Not sure where placements are set?

If you need to change inline vs. modal placement and don't see the controls, contact your Mulberry Partner Success manager — they'll confirm where your account's placements are configured.

Custom themes

The extension auto-renders offers for standard WooCommerce theme structures. If your theme is heavily customized and offers don't appear on the product page, you may need to extend or modify the extension's product-page.js so it can locate your product details and Add to Cart area.

🚧

Advanced — only if auto-rendering fails

Editing product-page.js is an advanced step for non-standard themes only. On a standard theme, leave it alone — offers render without any changes. If you're building a fully custom or headless storefront instead of using this extension, see Custom integration.

Next steps

• Get your credentials — where to find your Retailer ID, API Token, and Public Token.
• Mulberry SDK reference — the offer object and rendering contracts the extension uses internally.
• Cancel a warranty and How claims work — what happens after the sale.