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.

📘

Subscription

If the customer attached to checkout has an active subscription with us, any eligible item not associated with a warranty will be added to the subscription.

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"
  }
}
ParameterDefinitionRequiredType
line_itemsList of warranty line items for each Mulberry warranty purchased by the customer.yeslist
billing_addressThe billing address of the customer purchasing the warrantyyesobject
shipping_addressThe shipping address of the customer purchasing the warrantynoobject
idThe unique ID of the order in your ecommerce platformyesstring
emailCustomer Emailyesstring
phoneCustomer Phonenostring
merchant_idOptional Merchant ID - only used in specific integrations where instructed to do so.nostring

📘

Merchant IDs

Merchant IDs are used when an integration has multiple merchants under a single integration point. Merchant IDs in checkout help link the orders to individual merchants.

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.

ParameterDefinitionRequiredType
warranty_offer_idUUID for a warranty offer provided in the /api/warranty-offer API response when fetching offersyesstring
quantityquantity of warranties purchasednonumber
mfw_duration_monthsDuration (in months) of the manufacturer warranty.

This is to be used when providing aftermarket or extended warranty offers through Mulberry.
nonumber
mfw_start_dateManufacture 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.
nostring

Customer Address fields:

ParameterDefinitionRequiredType
address1Customer Address Line 1yesstring
address2Customer Address Line 2nostring
first_nameCustomer first nameyesstring
last_nameCustomer last nameyesstring
cityCustomer Address Cityyesstring
stateCustomer Address Stateyesstring
zipCustomer Address Zip Codeyesstring
countryCustomer Address Countryyesstring
country_codeCustomer Address Country Code. 2 char code.yesstring