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 Endpoint

HTTP method: POST

Authentication: Private Bearer Token

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

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

📘

If you've previously requested a warranty offer from our /warranty-offers endpoint, you can simply reference it during checkout by passing the warranty_offer_id as shown below.

curl --request POST \
     --url https://partner-staging.getmulberry.com/api/checkout \
     --header 'Accept: application/json' \
     --header 'Authorization:: Bearer [insert private token]' \
     --header 'Content-Type: application/json' \
     --data '
{
  "id":"41073793335",
  "email":"[email protected]",
  "phone":"13334445525",
  "line_items":[
    {
      "warranty_offer_id":"1df1b252-3301-4192-bcde-1ab2f1f4fe43",
       "mfw_start_date": "2022-02-22",
       "mfw_duration_months": 36,
       "quantity": 2
    }
  ],
  "billing_address":{
    "first_name": "John",
    "last_name": "Doe",
    "address1": "123 Broadway",
    "address2": "",
    "city": "New York",
    "state": "NY",
    "zip": "10001",
    "country": "United States",
    "country_code": "US"
  },
  "shipping_address":{
    "first_name": "John",
    "last_name": "Doe",
    "address1": "456 Eighth Avenue",
    "address2": "",
    "city": "New York",
    "state": "NY",
    "zip": "10011",
    "country": "United States",
    "country_code": "US"
  }
}
{
  "id":"41073793335",
  "email":"[email protected]",
  "phone":"13334445525",
  "line_items":[
    {
      "warranty_offer_id":"1df1b252-3301-4192-bcde-1ab2f1f4fe43",
      "mfw_start_date": "2022-02-22",
      "mfw_duration_months": 36,
      "quantity": 2
    }
  ],
  "billing_address":{
    "first_name": "John",
    "last_name": "Doe",
    "address1": "123 Broadway",
    "address2": "",
    "city": "New York",
    "state": "NY",
    "zip": "10001",
    "country": "United States",
    "country_code": "US"
  },
  "shipping_address":{
    "first_name": "John",
    "last_name": "Doe",
    "address1": "456 Eighth Avenue",
    "address2": "",
    "city": "New York",
    "state": "NY",
    "zip": "10011",
    "country": "United States",
    "country_code": "US"
  }
}

Parameter

Definition

Required

Type

line_items

List of warranty line items for each Mulberry warranty purchased by the customer.

yes

list

billing_address

The billing address of the customer purchasing the warranty

yes

object

shipping_address

The shipping address of the customer purchasing the warranty

no

object

id

The unique ID of the order in your ecommerce platform

yes

string

email

Customer Email

yes

string

phone

Customer Phone

no

string

Warranty line item fields:

🚧

Manufacturer Warranty Parameters

MFW fields are only required/used when you are running an aftermarket or extension program with Mulberry. If you wish to begin doing so, contact Mulberry to begin the setup process.

Parameter

Definition

Required

Type

warranty_offer_id

UUID for a warranty offer provided in the /api/warranty-offer API response when fetching offers

yes

string

quantity

quantity of warranties purchased

no

number

mfw_duration_months

Duration (in months) of the manufacturer warranty.

This is to be used when providing aftermarket or extended warranty offers through Mulberry.

no

number

mfw_start_date

Manufacture warranty start date. This is most often the order date.

YYYY-MM-DD

This is to be used when providing aftermarket or extended warranty offers through Mulberry.

no

string

Customer Address fields:

Parameter

Definition

Required

Type

address1

Customer Address Line 1

yes

string

address2

Customer Address Line 2

no

string

first_name

Customer first name

yes

string

last_name

Customer last name

yes

string

city

Customer Address City

yes

string

state

Customer Address State

yes

string

zip

Customer Address Zip Code

yes

string

country

Customer Address Country

yes

string

country_code

Customer Address Country Code. 2 char code.

yes

string