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",
      "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",
      "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_offer_id that customer purchased

yes

array

quantity

Used for multiples of the same item

no

integer

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

first_name

Customer First Name

yes

string

last_name

Customer Last Name

no

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