Guide: Abandoned Basket Campaigns

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 in completed 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 retrieved 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.

BETA

From Release 108 onwards, we have introduced a new field into the abandoned checkout API response called recoveryLink.

This field returns a specific link that can be used to recover a user's basket and will be returned in the following format:

recoveryLink: /api/checkout/recover?basketId={basket-id}&recover={token}

It should be shared only with the intended user who should recover the basket and includes a token which will be used by Limio to verify that the correct basket is being recovered.

It should be provided to users with the following pattern:

https://{shopDomain}/api/checkout/recover?basketId={basket-id}&recover={token}

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.

Error while loading OpenAPI operation — Failed to fetch OpenAPI file