🚧

Static integration only

Do not follow this guide if you are dynamically fetching warranties.

Once the customer has completed a purchase, you must notify Mulberry of the sale in order to initiate coverage by hitting our /api/checkout endpoint. Upon notification, Mulberry will send a welcome email to the customer, with instructions to access the customer portal (where the customer can manage their warranty details and file claims).

Checkout Call

HTTP method: POST

Authentication: Private Bearer Token

Staging Endpoint: https://partner-staging.getmulberry.com/api/checkout

Production Endpoint: https://partner.getmulberry.com/api/checkout

The example below would notify Mulberry that a Sofa sold for $1200 had a 24 month warranty associated with it.

{
  "line_items":[
    {
      "warranty":{
        "warranty_price":"100.00",
        "warranty_program_id":"35b8bf78",
        "warranty_id":"WTY-233",
        "warranty_duration":24
      },
      "products":[
        {
          "product_price":"1200.00",
          "product_id":"123456",
          "product_title":"Sofa",
          "product_meta":[
            {
              "field_name": "brand",
              "field_value": "Chesterfield"
            }, {
              "field_name": "orderItemId",
              "field_value": "39849975"
            }, {
              "field_name": "orderId",
              "field_value": "34674608"
            }, {
              "field_name": "po_number",
              "field_value": "38440112"
            }
          ]
        }
      ]
    }
  ],
  "billing_address":{
    "city":"Brooklyn",
    "first_name":"Josephine",
    "last_name":"Clark",
    "zip":"11231",
    "address1":"123 Mint St. Apt 3F",
    "address2":"",
    "phone":"6462223345",
    "state":"New York",
    "country_code":"US",
    "country":"United States"
  },
  "id":1455353616,
  "phone":"1234567890",
  "email":"[email protected]"
}

Parameter

Definition

Required

Type

line_items

Line items / products to add warranty coverage for

yes

array

warranty

The warranty details

yes

object

warranty_price

The price the customer purchased the warranty for (excluding tax)

yes

string

warranty_program_id

The warranty program ID (can be found in your dashboard) that this type of product maps to.

no

string

warranty_id

The SKU representing a warranty in your product catalog

yes

string

warranty_duration

The duration of the warranty sold in months

yes

integer

products

List of products covered by a warranty

yes

array

product_price

The price the customer paid for the product (excluding tax)

yes

string

product_id

The SKU of the product being purchased

yes

'string'

product_title

The title of the product sold

yes

string

product_meta

Any additional custom metadata you'd like to attach to the product.

no

array

field_name

The name/key of your custom metafield

yes

string

field_value

The value of the custom metafield

yes

string

billing_address

The address of the customer purchasing the warranty

yes

object

first_name

Customer First name

yes

`string

last_name

Customer Last name

yes

string

address1

Customer Address Line 1

yes

string

address2

Customer Address Line 2

no

string

phone

Customer Phone number

yes

string

state

Customer State

yes

string

country_code

Customer Country Code

yes

string

country

Customer Country

yes

string

id

The unique ID of the order in your ecommerce platform

yes

string

email:

Customer Email

yes

string

📘

Handling quantity

To checkout with more than 1 of the same product, you must repeat the line item in the line_items array

🚧

Program ID

The warranty_program_id is a way to tell Mulberry explicitly which insurance category a product belongs to and are provided to you by your Partner Success Manager.

Checkout (Bundles) POST

Some insurance categories (warranty_program_id) allow bundling of multiple products under one warranty. Below you can find an example of a furniture bundle containing two sofas tied to one warranty.

{
  "line_items":[
    {
      "warranty":{
        "warranty_price":"100.00",
        "warranty_program_id":"35b8bf78",
        "warranty_id":"WTY-233",
        "warranty_duration":24
      },
      "products":[
        {
          "product_price":"1200.00",
          "product_id":"123456",
          "product_title":"Sofa",
          "product_meta":[
            {
              "field_name": "brand",
              "field_value": "Chesterfield"
            }, {
              "field_name": "orderItemId",
              "field_value": "39849975"
            }, {
              "field_name": "orderId",
              "field_value": "34674608"
            }, {
              "field_name": "po_number",
              "field_value": "38440112"
            }
          ]
        },
        {
          "product_price":"1200.00",
          "product_id":"123457",
          "product_title":"Another Sofa",
          "product_meta":[
            {
              "field_name": "brand",
              "field_value": "Chesterfield"
            }, {
              "field_name": "orderItemId",
              "field_value": "39849976"
            }, {
              "field_name": "orderId",
              "field_value": "34674608"
            }, {
              "field_name": "po_number",
              "field_value": "38440112"
            }
          ]

        }
      ]
    },
    {
      "warranty":{
        "warranty_price":"25.00",
        "warranty_program_id":"35b8bf78",
        "warranty_id":"WTY-245",
        "warranty_duration":24
      },
      "products":[
        {
          "product_price":"1500.00",
          "product_id":"123458",
          "product_title":"Rug"
        }
      ]
    }
  ],
  "billing_address":{
    "city":"Brooklyn",
    "first_name":"Josephine",
    "last_name":"Clark",
    "zip":"11231",
    "address1":"123 Mint St. Apt 3F",
    "address2":"",
    "phone":"6462223345",
    "state":"New York",
    "country_code":"US",
    "country":"United States"
  },
  "id":1455353616,
  "phone":"1234567890",
  "email":"[email protected]"
}

Parameter

Definition

Required

Type

line_items

Line items / products to add warranty coverage for

yes

array

warranty

The warranty details

yes

object

warranty_price

The price the customer purchased the warranty for (excluding tax)

yes

string

warranty_program_id

The warranty program ID (can be found in your dashboard) that this type of product maps to.

yes

string

warranty_id

The SKU representing a warranty in your product catalog

yes

string

warranty_duration

The duration of the warranty sold in months

yes

integer

products

List of products covered by a warranty

yes

array

product_price

The price the customer paid for the product (excluding tax)

yes

string

product_id

The SKU of the product being purchased

yes

'string'

product_title

The title of the product sold

yes

string

product_meta

Any additional custom metadata you'd like to attach to the product.

no

array

field_name

The name/key of your custom metafield

yes

string

field_value

The value of the custom metafield

yes

string

billing_address

The address of the customer purchasing the warranty

yes

object

first_name

Customer First name

yes

`string

last_name

Customer Last name

yes

string

address1

Customer Address Line 1

yes

string

address2

Customer Address Line 2

no

string

phone

Customer Phone number

yes

string

state

Customer State

yes

string

country_code

Customer Country Code

yes

string

country

Customer Country

yes

string

id

The unique ID of the order in your ecommerce platform

yes

string

email:

Customer Email

yes

string