Abandoned basket API

This API returns incomplete or “abandoned” baskets.

What is an incomplete basket?

An abandoned basket is one where a basket was started on the Limio checkout but was never completed, i.e. its status remains active rather than completed. This means the customer never completed the transaction:

The customer abandoned the checkout before the “Complete Checkout“ step and so the basket is incomplete.

The aim of the API is to provide a single endpoint to find abandon checkouts and do something about it such as Abandon Basket campaigns.

API Reference

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

ApiKey

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

JavaScriptCurl

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

Response

{
  "items": [
    {
      "id": "basket-8cf72b2a-eb57-462d-8e55-981c3b5e5364",
      "created": "2024-03-26T15:44:54.975Z",
      "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"
  }
}