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.

Looking to manually inspect abandoned baskets in Limio Commerce? This guide covers automating abandoned basket campaigns via the API. If you are a business user or RevOps team looking to manually review and follow up on abandoned baskets, see Guide: Inspect and Follow Up on Abandoned Baskets.

How Abandoned Baskets 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.

How user details get onto the basket depends on the authentication model:

• Authenticated flows (SSO / identity provider): When the customer logs in, Limio links the identity to the basket and the checkout form pre-fills customerDetails (including email) from the identity provider's claims.

• Anonymous flows (no login required): customerDetails.email is saved when the customer fills in the email field on the checkout form (on blur, since Release 104). No external login is required.

Once user details are present on the basket, two things can happen:

1. If the customer completes the order, the basket will be in completed status.

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

In scenario 2, the basket is considered abandoned ("completed": false). You will be able to retrieve these baskets through the Limio Abandoned Basket API.

API Reference

Get Abandoned Baskets

get

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.

Authorizations

bearerAuth

AuthorizationstringRequired

To create a Bearer token, see How to get an OAuth Bearer Token?.

Usage format: Bearer <token>

Query parameters

limitnumberRequired

The number of objects to return.

Example: 10

createdAfterstring · date-timeRequired

Filter items created after the provided ISO date-time string

Example: 2020-12-01T16:00:00Z

queryMorestringOptional

Retrieves the next page of results. Use the queryMore returned in the previous response.

Example: DnF1ZXJ5VGhlbkZldGNoBQAAAAAAGH

Responses

200

OK

application/json

queryMorestringOptional

Cursor for the next page of results

Example: eyJ2IjoiMSIsImMiOiJjYjY0ZDY1YS1iYzQwLTQ3YjItODI5Ny1mN2E4ZGEyYjA0M2UiLCJyIjoiMjAyNC0wMy0yNlQxNTowNDo1NC45NzVaIn0=

401

Unauthorized

application/json

502

Bad Gateway

application/json

get

/checkout/abandoned

HTTPcURLJavaScriptPython

GET /api/checkout/abandoned?limit=10&createdAfter=2020-12-01T16%3A00%3A00Z HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "basket-8cf72b2a-eb57-462d-8e55-981c3b5e5364",
      "created": "2024-03-26T15:44:54.975Z",
      "customerDetails": {
        "email": "[email protected]"
      },
      "orderItems": [
        {
          "name": "The Offer",
          "path": "/offers2/The Offer",
          "products": [
            {
              "path": "/products/Digital All Access",
              "productCode": "SKU-00000001"
            }
          ]
        }
      ],
      "tracking": {},
      "identities": [
        {
          "sub": "[email protected]",
          "iss": "https://issuer.domain",
          "service": "salesforce",
          "type": "account"
        }
      ],
      "entry": "/checkout",
      "completed": false,
      "recoveryLink": "/api/checkout/recover?basket=basket-8cf72b2a-eb57-462d-8e55-981c3b5e5364&recover=abc123"
    }
  ],
  "queryMore": "eyJ2IjoiMSIsImMiOiJjYjY0ZDY1YS1iYzQwLTQ3YjItODI5Ny1mN2E4ZGEyYjA0M2UiLCJyIjoiMjAyNC0wMy0yNlQxNTowNDo1NC45NzVaIn0="
}

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.

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.

Identifying the user

To identify the customer who abandoned a basket, use the customerDetails.email field from the API response. This is the canonical email field and is populated in both authentication models:

• Anonymous authentication flows: customerDetails.email is set when the customer fills in the email field on the checkout form. Since Release 104, this happens on blur (as soon as the customer moves to the next field), rather than waiting for form submission.

• Authenticated flows (SSO / identity provider): customerDetails.email is pre-filled from the identity provider's claims when the checkout page loads. The customer's email is available on the basket from the moment they reach the authenticated checkout.

The API response also includes an identities array, which contains identity metadata (provider, subject identifier). However, this does not always include a usable email address — particularly in anonymous flows, where the identity is a temporary session with no PII. Use customerDetails.email as the primary field for identifying and contacting the customer.

Since Release 104, the email address is saved to the basket as soon as the customer types it and moves to the next field (on blur), rather than only on order submission. This means the customerDetails.email field is now populated much earlier in the checkout process — significantly increasing the number of abandoned baskets that include a contactable email address.

This applies to the email field subcomponent of the Modular Checkout Form. For authenticated flows, customerDetails.email is pre-filled from the identity provider regardless.