Abandoned basket API

This API returns incomplete or “abandoned” baskets.

What is the typical user flow interacting with a Limio Basket?

The following diagram represents the flow of data from the call-to-action click (also called 'add offers to basket' or 'add to cart action') to an order completed. The customer abandoned the checkout if they are after the "Authenticated?" step but before the “Complete Checkout“ step.

How Abandoned Basket are generated in Limio

When a customer adds an offer within a Limio Page, Limio will immediately create a basket. This will usually be done by clicking a 'Subscribe' call-to-action on a product, pricing, or offer page (often called add offers to basket or add to cart action).

At that stage, the basket will include the offer added but not user information. It will have a unique ID, such as "id": "b2525b37-708c-4c5c-86cc-b5c4b1e8d775".At this stage, it is not yet possible to retarget this basket with an abandoned basket email campaign, as it is missing user information and it will not be provided by the Limio Abandoned Basket API.

Once the customer has been authenticated, Limio will automatically update the basket with the user details. At this stage, sufficient information has been collected to retarget this user but we now need to know whether they complete their purchase or not. Two things can happen from here:

1. If the user then complete that order, the basket will be incompleted status.

2. If the user does not complete the basket, the basket will remain in an active status.

In scenario 2, Limio will mark those baskets as abandoned ( "completed": false). At this stage and only if the previous conditions are met, you will be able to retrieve those baskets through the Limio Abandoned Basket API

API Reference

Purpose of this API

The aim of the API is to provide a single endpoint to find abandon baskets that have user data populated.

Customer can then integrate this API into their Email Service Provider (or other marketing channel such as Push Notification) to send Abandon Basket campaigns.

Use of this API

Once you have retrieve abandoned baskets via this API, you can use the basket-id to redirect users into the checkout they have abandoned. For example, you can send them a link to /checkout?basket=id.The checkout will be populated with the same offer as the one they abandoned.

Alternatively, you can use purchase links if you'd like to send them to an alternative offer, for example an offer with 10% off.

You can identify the user either from the identities objects present on the response, where the identity includes an email, or from the customerDetails object from the response. This object contains an email field which is populated with the user's email, if they are authenticated, and gets updated with the value of the email field from the checkout form they abandoned, if they filled it in.

Get Abandoned Baskets

This API allows you to get a list of abandoned baskets in Limio and filter the results by the date the basket was created. An abandoned basket is one where a basket was started on the Limio checkout but the order was never completed.

You can use the Abandoned Baskets API for actions such as:

• Obtaining marketing information on customers who have abandoned their checkout.
• Gathering information that can be used to remarket to abandoned checkout customers.
• Understanding customer behaviour.
• Tracking abandoned checkouts over time.
• Viewing abandoned checkout items.

GEThttps://your-environment.prod.limio.com/api/checkout/abandoned

Authorization

bearerAuth

Query parameters

Response

200401502

OK

Body

application/json

itemsarray of object

The list of baskets retrieved

queryMorequeryMore (object)

query more object used for pagination

Request

JavaScriptCurlPython

const response = await fetch('https://your-environment.prod.limio.com/api/checkout/abandoned', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200401502

{
  "items": [
    {
      "id": "basket-8cf72b2a-eb57-462d-8e55-981c3b5e5364",
      "created": "2024-03-26T15:44:54.975Z",
      "customerDetails": {
        "email": "[e-mail]"
      },
      "orderItems": [
        {
          "name": "The Offer",
          "path": "/offers2/The Offer",
          "products": [
            {
              "path": "/products/Digital All Access",
              "productCode": "SKU-00000001"
            }
          ]
        }
      ],
      "identities": [
        {
          "sub": "[e-mail]",
          "iss": "https://issuer.domain",
          "service": "salesforce",
          "type": "account"
        }
      ],
      "entry": "/checkout",
      "completed": false
    }
  ],
  "queryMore": {
    "from": "DnF1ZXJ5VGhlbkZldGNoBQAAAAAAGH_TFnZndVVMaWN4VFZDbnVIbGpRRDFaaUEAAAAAABh_1BZ2Z3VVTGljeFRWQ251 SGxqUUQxWmlBAAAAAAAYf9YWdmd1VUxpY3hUVkNudUhsalFEMVppQQAAAAAAGH_XFnZndVVMaWN4VFZDbnVIbGpRRDFa aUEAAAAAABh_1RZ2Z3VVTGljeFRWQ251SGxqUUQxWmlB",
    "alias": "catalog_test.test0.dev.limio.com"
  }
}