Guides

Static Check Out Overview

🚧

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 Table sold for $1200 had a 24-month warranty associated with it.

{
  "line_items":[
    {
      "warranty":{
        "warranty_price":"100.00",
        "warranty_id":"WTY-233",
        "warranty_duration":24
      },
      "products":[
        {
          "product_price":"1200.00",
          "product_id":"123456",
          "product_title":"Dining Table",
          "meta": {
          "breadcrumbs": [
           {"category": "All Products", "url": "https://yoursite.com/products"},
           {"category": "Kitchen & Dining", "url": "https://yoursite.com/products/kitchen-and-dining"},
           {"category": "Kitchen & Dining Furniture", "url": "https://yoursite.com/products/kitchen-and-dining-furniture"},
           {"category": "Dining Tables", "url": "https://yoursite.com/products/dining-chairs"}
            ]
           }
        }
      ]
    }
  ],
  "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_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

retailer categories

Product categorization assigned by the retailer

no

object

images

Product images

no

string

meta

Product metadata

no

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