Install on Magento

Install the Mulberry extension on Magento 2.x and you get warranty offers on the Product Details Page (PDP) and automatic sale registration — the partner runs Composer, fills in a handful of admin fields, and Mulberry handles the rest. The extension auto-creates the warranty products it needs and notifies Mulberry on its own when a covered order is placed.

🚧

Never rename the placeholder warranty SKUs

Installing the module auto-creates a virtual Warranty Product plus placeholder SKUs (mulberry-warranty-product, mulberry-warranty-24-months, -36-months, -48-months, -60-months). The system matches a warranty to its product by SKU. If you rename, delete, or otherwise modify these SKUs, Mulberry can no longer attach coverage to your products and warranty offers stop working. Leave them exactly as created.

Prerequisites

Before you start, make sure:

1. You have a Magento 2.x store with shell/SSH access to run composer and ./bin/magento.
2. Composer is configured for your project (you can add repositories and require packages).
3. You have your Mulberry Retailer ID and API Token. See Get your credentials.
4. You know which environment you're wiring up — staging or production — so you pick the matching hosts below.

Install the extension

Run these from your Magento project root:

1. Add the Mulberry module repository to your Composer repositories (if it isn't already configured).
2. Require the extension:
   Bash

   composer require getmulberry/mulberry-m2-extension

3. Run the Magento upgrade so the module's setup scripts execute:
   Bash

   ./bin/magento setup:upgrade

   • You should now see the Mulberry module enabled, and the virtual Warranty Product plus its placeholder SKUs created in your catalog (see the gotcha above — don't touch them).

Configure the extension

Open the Mulberry configuration section in your Magento admin and set the following. Use the staging hosts while testing and the production hosts when you go live — don't mix environments.

📘

Where these values come from

The Retailer ID and API Token are issued to your account — see Get your credentials. This page won't repeat how to obtain them.

🚧

Match staging to staging, production to production

The Mulberry API URL and Mulberry Partner Base URL must point at the same environment. A staging API URL with a production partner URL (or vice versa) will fail to load offers. Use the *-staging hosts together, or the production hosts together.

After saving, load an eligible product page on your storefront. You should now see a Mulberry warranty offer render on the Product Details Page.

How offers render

Once the DOM finishes loading on the Product Details Page, the extension initializes a Mulberry iframe that displays the available warranty offers for that product. The offer's name and price are filled in on the fly from the live Mulberry offer and written onto the matching placeholder SKU — you don't manage offer copy or pricing in Magento.

📘

Magento renders offers in an iframe — not the inline/modal SDK

On Magento, offers are served as an embedded iframe on the PDP. This is different from the BigCommerce and Custom integrations, which drive the browser SDK directly (mulberry.inline / mulberry.modal). On Magento you don't call those SDK namespaces yourself. For the SDK surface those other integrations use, see the Mulberry SDK reference.

To set a custom image for a warranty product, use Magento's default product image functionality.

Sales register automatically

You do nothing to register a warranty sale. When a customer places an order that contains a warranty product, the extension's checkout_submit_all_after observer notifies Mulberry by calling POST /api/checkout (using the hosts you configured above). The call fires only when the order actually contains a warranty product. Once the order is placed, the warranty is registered — no manual entry, no CSV upload.

Cancellations and claims are likewise cross-cutting and largely automatic. See Cancel a warranty and How claims work.

📘

How it works under the hood

You don't need any of this to run the extension. Internally the module listens to three Magento event observers: checkout_cart_product_add_after (loads the placeholder by SKU, fetches the warranty's name/price/service type from Mulberry, and stores it under warranty_information on the quote item), sales_quote_item_set_product (updates the warranty quote item's display name), and checkout_submit_all_after (the sale-registration call above). The fetched details live in the quote_item_option table as warranty_information plus additional_options (the Service type and Duration Months shown on cart, checkout, and order pages).

Uninstall

To remove the extension, follow Magento's official module-uninstall flow.

The uninstall script cleans up after itself:

• Removes the module's config values from the core_config_data table.
• Removes the warranty product from the apply_to list for the price, cost, and weight attributes.
• Removes all products with type_id == warranty, which also clears warranty products out of any active quotes.

Next steps

• Get your credentials — find your Retailer ID, API Token, and public token.
• How Mulberry works — the lifecycle of an offer, sale, and claim.
• Cancel a warranty and How claims work — the cross-cutting flows after a sale.