# Mulberry Platform Documentation

> Documentation for Mulberry Platform

## Guides: Get Started
- [Welcome to Mulberry](https://docs.getmulberry.com/docs/introduction.md): Embed extended protection plans into your checkout and earn commission on every plan sold.
- [How Mulberry works](https://docs.getmulberry.com/docs/how-mulberry-works.md): The integration spine — connect, offer, present, attach, register, service, settle — and the artifact you can observe at each stage.
- [Concepts and key terms](https://docs.getmulberry.com/docs/concepts.md): The vocabulary you need before you integrate — offers, warranties, claims, tokens, and environments.
- [Choose your integration](https://docs.getmulberry.com/docs/choose-your-integration.md): Pick the path that matches your platform — each one leads straight to its setup guide.
- [Get your credentials](https://docs.getmulberry.com/docs/get-credentials.md): The Retailer ID and tokens you need before you write any integration code.

## Guides: Shopify
- [Install the Shopify app](https://docs.getmulberry.com/docs/shopify-install.md): Add Mulberry Product Protection from the Shopify App Store and connect your store to Mulberry — the first step of every Shopify integration.
- [Show offers on product pages](https://docs.getmulberry.com/docs/offers-on-product-pages.md): Wire Mulberry warranty offers into your Shopify product pages — fetch an offer with the SDK, render it, and attach the chosen plan to the cart.
- [Show offers at checkout](https://docs.getmulberry.com/docs/offers-at-checkout.md): Present Mulberry protection offers natively inside the Shopify checkout.
- [Shopify POS](https://docs.getmulberry.com/docs/shopify-pos.md): Sell and manage warranty plans during in-store transactions.
- [Sell via draft orders](https://docs.getmulberry.com/docs/shopify-draft-orders.md): Add Mulberry warranty plans and package protection to a draft order from the Shopify Admin.
- [Shipping insurance on Shopify](https://docs.getmulberry.com/docs/shopify-shipping-insurance.md): Offer Package Protection in your checkout and on your cart page.
- [Shipping insurance on Shopify: developer notes](https://docs.getmulberry.com/docs/shopify-shipping-insurance-developers.md): How the Package Protection checkout block and cart button work, for the developer looking after your store.
- [Automatic warranty start date](https://docs.getmulberry.com/docs/automatic-warranty-start-date.md): Start warranty coverage on the ship date instead of the order date — automatically.
- [Hide warranties from search results](https://docs.getmulberry.com/docs/hide-mulberry-warranties-from-search-results.md): Stop Mulberry protection-plan products from appearing in your storefront search.
- [Sell Mulberry Unlimited subscriptions](https://docs.getmulberry.com/docs/subscriptions.md): Offer recurring Mulberry Unlimited protection on your Shopify store.

## Guides: Custom
- [Custom integration overview](https://docs.getmulberry.com/docs/custom-integration.md): Build offers and sale registration yourself with the Mulberry SDK and REST API — no platform app required.
- [Initialize the SDK and show offers](https://docs.getmulberry.com/docs/initialize-the-sdk.md): Load the browser SDK on your own site, fetch warranty offers for a product, and render them.
- [Add the warranty to the order](https://docs.getmulberry.com/docs/add-warranty-to-order.md): Capture the selected offer and carry its ID through your own cart and order.
- [Register the sale](https://docs.getmulberry.com/docs/register-the-sale.md): POST the completed order to Mulberry to create the warranty contract.
- [Add shipping insurance](https://docs.getmulberry.com/docs/add-shipping-insurance.md): Quote package protection with the SDK, then register the policy with one server-to-server call.
- [Test and go live](https://docs.getmulberry.com/docs/test-and-go-live.md): Validate your custom integration end to end against staging, then cut over to production.

## Guides: Magento 2.x
- [Install on Magento](https://docs.getmulberry.com/docs/magento-install.md): Install the Mulberry extension on Magento 2.x via Composer, configure it in the admin, and start showing warranty offers — registration runs automatically.

## Guides: BigCommerce
- [Integrate on BigCommerce](https://docs.getmulberry.com/docs/bigcommerce-integrate.md): Edit your Stencil theme to render Mulberry offers and attach the chosen warranty to the BigCommerce cart.
- [Show Unlimited offers after checkout](https://docs.getmulberry.com/docs/bigcommerce-post-purchase-unlimited.md): Add the Mulberry Unlimited post-purchase component to your BigCommerce Order Confirmation page so customers can activate or subscribe.

## Guides: WooCommerce
- [Install on WooCommerce](https://docs.getmulberry.com/docs/woocommerce-install.md): Install the Mulberry extension on WooCommerce, configure your credentials, and offers, checkout, and cancellations run automatically.

## Guides: Shipping Insurance
- [Shipping Insurance](https://docs.getmulberry.com/docs/shipping-insurance.md): Let shoppers protect their order against loss, damage, or theft in transit.

## Guides: Claims
- [How claims work](https://docs.getmulberry.com/docs/how-claims-work.md): The claim lifecycle from a partner's point of view — who files, how Mulberry adjudicates, and why there's nothing for you to build.
- [File a claim](https://docs.getmulberry.com/docs/file-a-claim.md): How a claim gets filed with Mulberry — the customer path, and the gated retailer-on-behalf path.
- [React to claim updates](https://docs.getmulberry.com/docs/react-to-claim-updates.md): Keep your records in sync with every claim status change using the CLAIM_UPDATE webhook.

## Guides: Cancellations & Refunds
- [Cancel a warranty](https://docs.getmulberry.com/docs/cancel-a-warranty.md): How a warranty gets cancelled — automatically with its order, from your dashboard after a return, via the API, or by the customer — and what a cancellation does to claims and refunds.
- [How refunds work](https://docs.getmulberry.com/docs/how-refunds-are-calculated.md): When a warranty is cancelled, the customer's refund comes back through your store — not from Mulberry.

## Guides: Billing
- [Billing](https://docs.getmulberry.com/docs/billing.md): How Mulberry bills and settles the warranties you sell — and who to talk to about it.

## API examples: SDK Reference
- [Mulberry SDK reference](https://docs.getmulberry.com/reference/sdk-overview.md): Contracts for the browser SDK — window.mulberry namespaces, methods, and the offer object

## API examples: Webhooks
- [Webhook catalog](https://docs.getmulberry.com/reference/webhook-catalog.md): The outbound webhooks Mulberry sends, their payloads, and how to verify their signatures.

## API examples: Mulberry API
- [Warranty Claims Customer Status](https://docs.getmulberry.com/reference/warranty-claims-customer-status.md)

## API examples: Display Offers via Mulberry SDK
- [Inline Offers](https://docs.getmulberry.com/reference/in-line-offers.md)

## API examples: mulberry-api
- /api/shipping-insurance/fulfill
  - [Record a package (original path)](https://docs.getmulberry.com/reference/shipping-insurance-fulfill.md): Identical to **Record a package** at `/api/v2/shipping-insurance/shipments` — same request, same responses, same handler. Both paths are current and neither is scheduled for removal; Mulberry's own…
- /api/shipping-insurance/quote
  - [Quote shipping insurance](https://docs.getmulberry.com/reference/shipping-insurance-quote.md): Price shipping-insurance coverage for a cart. Authenticate with your **public** token, so this is safe to call from the storefront. The returned `offer_id` is a signed token valid for 30 days; spend…
- /api/shipping-insurance/rates
  - [Get shipping insurance rates](https://docs.getmulberry.com/reference/shipping-insurance-rates.md): Return the shipping-insurance rates configured for your account. Authenticate with your **private** API token — the wholesale rate is not exposed to the storefront. Rates are decimal fractions, so…
- /api/shipping-insurance/void
  - [Cancel a policy (original path)](https://docs.getmulberry.com/reference/shipping-insurance-void.md): Identical to **Cancel a policy** at `/api/v2/shipping-insurance/cancellations` — same request, same responses, same handler. Both paths are current and neither is scheduled for removal; Mulberry's…
- /api/v2/shipping-insurance/cancellations
  - [Cancel a policy](https://docs.getmulberry.com/reference/shipping-insurance-cancellations.md): Cancel shipping-insurance coverage on an order, before or after its packages are recorded; every recorded package is also voided with the insurer. A policy with a claim with the insurer (`Claimed`)…
- /api/v2/shipping-insurance/orders
  - [Register an insured order](https://docs.getmulberry.com/reference/shipping-insurance-orders.md): Register an order for shipping-insurance coverage, spending the `offer_id` returned by a quote. The offer token is single-use, and Mulberry derives the insured value from the order breakdown rather…
- /api/v2/shipping-insurance/shipments
  - [Record a package](https://docs.getmulberry.com/reference/shipping-insurance-shipments.md): Record one package of an insured order with the insurer. Send one call per package, each with its own tracking number: an order that ships as one FedEx and two USPS parcels is three calls, days apart…