Post Purchase Offers

Returns the warranty offers still available on an order after the original sale, together with the coverage that order already carries. It backs Mulberry's hosted post purchase experience, which reads it to render the landing page a customer lands on from a remarketing email.

Offers exist on an order because it was submitted to POST /api/carts without a warranty. Look one order up by an id that names it, or look up every order for a customer by email. Send both to look one order up by an id that is not the one it was created with. Either way only orders belonging to the retailer in the path are returned.

What is returned here is bought either by the customer, on the Mulberry landing page the order's link leads to, or by you, through Post Purchase Checkout once you have collected the payment yourself.

Post Purchase Offers Endpoint

HTTP method: GET

Authentication: None. This endpoint backs Mulberry's hosted post purchase experience and is not part of the partner integration surface.

Staging Endpoint: https://partner-staging.getmulberry.com/api/purchase-warranties/{retailer_uuid}

Production Endpoint: https://partner.getmulberry.com/api/purchase-warranties/{retailer_uuid}

* At least one of order_id or email is required; sending neither is a 400. Sending both looks up the one order order_id names — it does not also list the customer's other orders.

Which ids resolve

The id a customer or a retailer quotes is often not the one the order was created with, so order_id is matched against three spellings:

A customer who has no email address sends their phone number as email. Mulberry records one for them when you submit the order without an address, so their phone is the thing they can corroborate with.

The order's own id needs nothing to corroborate it: it is the id every post purchase link already carries, and the address a customer types on the landing page is not always the one you recorded. The other two are looser — one purchase order number can name several orders, and a line item can carry an id its own order does not — so on an endpoint with no authentication they resolve only when email matches the address recorded on the order — or, for a customer who has none, their phone number.

📘

An id that names several of that customer's orders returns all of them, in orders. The customer block describes the first.

Response

Each order carries two lists, and they answer different questions.

line_items is what is still purchasable. One entry per line item, carrying the offers the customer can choose between and every product that line item covers — more than one when the line item covers a bundle. An empty offers list means the purchase window has closed, which the landing page renders as protection expired; that is not the same as the order having no line item.

products is what is already protected and out of the checkout flow. There is one entry per coverage issued, so a product covered twice appears twice, and product_id is what to group on for display.

customer.tax_rate is only present for orders billed to New York. customer.has_subscription is only present when the customer has an active subscription with Mulberry.

Line item fields:

Covered product fields:

Purchased product fields:

{
  "customer": {
    "email": "[email protected]",
    "first_name": "John",
    "tax_rate": 0
  },
  "orders": [
    {
      "id": "testing1234567-33",
      "merchant": null,
      "merchant_logo": "",
      "line_items": [
        {
          "line_item_id": 91827,
          "warranty_offer_id": null,
          "offers": [
            {
              "cost": "100.00",
              "customer_cost": "100.00",
              "currency": "USD",
              "duration_months": "36",
              "expiration_date": "2022-05-01",
              "mb_category": "indoor_furniture",
              "policy_terms_url": "https://terms.getmulberry.com/20210305_fortegra_furniture_plus",
              "service_type": "Replacement",
              "warranty_offer_id": "0e2ac3d8-5965-45fd-9e8a-9aa6860829dc",
              "warranty_type": "regular"
            }
          ],
          "products": [
            {
              "product_id": "9393939",
              "product_title": "deluxe couch",
              "product_price": "179.99",
              "product_image": "",
              "is_subscription_eligible": false
            }
          ],
          "products_total": "179.99"
        }
      ],
      "products": [
        {
          "name": "deluxe couch",
          "product_id": "9393939",
          "product_image": null,
          "warranty": {
            "duration_months": "36"
          }
        }
      ]
    }
  ]
}