Mulberry gives retailers the ability to offer a personalized remarketing experience to customers that do not attach a warranty to their sale during the on-site checkout process. We are able to tailor the customer’s landing page to the unique transaction, by providing information on what the customer bought (driving higher attachment rates for you).
For example, by sending a POST request to our /api/carts endpoint with the following information, we can return URL to you that can then be integrated into your Mulberry remarketing materials.
Post Purchase Link Endpoint
HTTP method: POST
Authentication: Private Bearer Token
Staging Endpoint: https://partner-staging.getmulberry.com/api/carts
Production Endpoint: https://partner.getmulberry.com/api/carts
{
"order_id": "7689dde5c0f64fffa7ad217f6f73",
"line_items": [
{
"product_title": "Apple Macbook Pro 2019",
"product_id": "123456",
"product_price": "1500.00",
"meta": {
"breadcrumbs": [
{
"category": "Electronics"
},
{
"category": "Consumer Electronics"
}
]
},
"detail": {
"images": [
{
"src": "https://www.apple.com/v/macbook-pro/af/images/overview/hero_13__d1tfa5zby7e6_large_2x.jpg"
}
]
}
}
],
"billing_address": {
"first_name": "Josephine",
"last_name": "Clark",
"address1": "123 Mint St. Apt 3F",
"phone": "",
"email": "[email protected]",
"city": "Brooklyn",
"zip": "11231",
"state": "NY",
"country": "United States",
"address2": "",
"country_code": "US",
"province_code": "NY"
}
}
Providing additional information such as imagery and product metadata helps Mulberry identify and classify the product more accurately.
Parameter | Description | Required | Type |
|---|---|---|---|
order_id | Unique order ID from your ecommerce platform (Must be a non-sequential / UUID) | yes |
|
line_items | List of products to offer protection plans for | yes |
|
product_id | Product SKU | yes |
|
product_price | Product price | yes |
|
product_title | Product title | yes |
|
meta | Product metadata | no |
|
images | Product images | no |
|
billing_address | Customer address | yes |
|
first_name | First name | yes |
|
last_name | Last name | no |
|
address1 | Address Line 1 | no |
|
phone | Phone number | no |
|
Email Address | yes |
| |
city | City | no |
|
state | State | yes |
|
country | Country | yes |
|
address2 | Address Line 2 | no |
|
Staging Response
{
"success": true,
"url": "https://staging.getmulberry.com/carts/3af6dd3b/checkout/7689dde5c0f64fffa7ad217432f6f73",
"warrantable_products": true
}
Production Response
{
"success": true,
"url": "https://app.getmulberry.com/carts/3af6dd3b/checkout/7689dde5c0f64fffa7ad217432f6f73",
"warrantable_products": true
}
If any of the purchased products are eligible for a warranty, then warrantable_products will be returned as true. Then, the response URL can then be used on Thank You pages, marketing email campaigns etc.
Building the URL
You don't need to store the URL that the
cartsAPI responds with. You can build it by using the values below.
Landing Page URL Structure
The structure of the Post Purchase landing page is as follows:
Staging
https://staging.getmulberry.com/carts/[retailer_uuid]/checkout/[order_id]
Production
https://app.getmulberry.com/carts/[retailer_uuid]/checkout/[order_id]
Parameter | Definition |
|---|---|
retailer_uuid . | This is the unique ID that Mulberry has assigned to you and will not change. You can find it within the Settings tab within the Partner Dashboard |
order_id | This is the order ID from your ecommerce platform for this particular customer's order. |