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.

Options

Abandoned Basket API takes in 3 queryParams:

createdAfter : an ISO datetime string. If this is set, it will only return incomplete baskets after this timedate.

limit: number of results that will be returned

queryMore: queryMore parameter to fetch more results

It is Authenticated via API Token.

get
Retrieve Abandon Baskets

https://{{tenant}}.limio.com/api/checkout/abandoned?limit=1000&createdAfter=2021-03-12T13:44
Return abandon baskets
Request
Response
Request
Query Parameters
createdAfter
optional
string
an ISO datetime string. If this is set it will only return incomplete baskets after this timedate.
limit
optional
string
number of results that will be returned
queryMore
optional
string
queryMore parameter to fetch more results
Response
200: OK
{
"items": [
{
"id": "basket-f52fc5bf-4fa4-41a1-ba76-71cae69d52b6",
"created": "2021-03-12T16:23:30.962Z",
"orderItems": [
{
"name": "Quarterly",
"path": "/offers/The Economist Digital 50 off - CE-EU/Quarterly",
"products": [
{
"path": "/products/Economist/Digital Premium",
"name": "Digital Premium",
"productCode": "TE.DIGITAL"
}
]
}
],
"tracking": {},
"completed": false
},
{
"id": "basket-600a3aac-eab6-4e7a-9e43-548c6b875cda",
"created": "2021-03-12T16:23:27.828Z",
"orderItems": [
{
"name": "Annual",
"path": "/offers/The Economist Digital 50 off - NA-US/Annual",
"products": [
{
"path": "/products/Economist/Digital Premium",
"name": "Digital Premium",
"productCode": "TE.DIGITAL"
}
]
}
],
"tracking": {
"accountId": "0013z00002dZ1C6AAK",
"contactId": "0033z00002xJS5KAAW"
},
"completed": false
},
{
"id": "basket-3cb4d8b2-f3cd-4ce1-87de-a07d425de446",
"created": "2021-03-12T16:23:11.080Z",
"orderItems": [
{
"name": "Annual",
"path": "/offers/The Economist Digital 50 off - NA-US/Annual",
"products": [
{
"path": "/products/Economist/Digital Premium",
"name": "Digital Premium",
"productCode": "TE.DIGITAL"
}
]
}
],
"tracking": {
"accountId": "0013z00002eaxuTAAQ",
"contactId": "0033z00002y0rePAAQ"
},
"completed": false
},
{
"id": "basket-664f836e-faf5-4e05-add6-a5f1a2f05c1b",
"created": "2021-03-12T16:20:28.958Z",
"orderItems": [
{
"name": "Annual",
"path": "/offers/The Economist Digital 50 off - NA-US/Annual",
"products": [
{
"path": "/products/Economist/Digital Premium",
"name": "Digital Premium",
"productCode": "TE.DIGITAL"
}
]
}
],
"tracking": {
"accountId": "0013z00002dZ1C6AAK",
"contactId": "0033z00002xJS5KAAW"
},
"completed": false
},
{
"id": "basket-66d7a766-633e-42ee-9db5-3e8e95c2bcb9",
"created": "2021-03-12T16:19:27.695Z",
"orderItems": [
{
"name": "Quarterly",
"path": "/offers/The Economist Digital 50 off - NA-US/Quarterly",
"products": [
{
"path": "/products/Economist/Digital Premium",
"name": "Digital Premium",
"productCode": "TE.DIGITAL"
}
]
}
],
"tracking": {},
"completed": false
},
{
"id": "basket-349bea4e-60e5-4caf-a884-ce68aa54f718",
"created": "2021-03-12T16:16:23.908Z",
"orderItems": [
{
"name": "Quarterly",
"path": "/offers/The Economist Digital Student 50 off - CE-CH/Quarterly",
"products": [
{
"path": "/products/Economist/Digital Premium",
"name": "Digital Premium",
"productCode": "TE.DIGITAL"
}
]
}
],
"tracking": {
"accountId": "0013z00002eaxkGAAQ",
"contactId": "0033z00002y0rSzAAI"
},
"completed": false
},
{
"id": "basket-d6e2d519-636f-4535-bad6-937453009081",
"created": "2021-03-12T16:16:04.809Z",
"orderItems": [
{
"name": "Annual",
"path": "/offers/The Economist Digital 50 off - CE-EU/Annual",
"products": [
{
"path": "/products/Economist/Digital Premium",
"name": "Digital Premium",
"productCode": "TE.DIGITAL"
}
]
}
],
"tracking": {
"accountId": "0013z00002eaxkTAAQ",
"contactId": "0033z00002y0rTCAAY"
},
"completed": false
},
{
"id": "basket-0641098b-b596-496c-8335-b5f3832b184d",
"created": "2021-03-12T16:15:34.664Z",
"orderItems": [
{
"name": "Annual",
"path": "/offers/The Economist Digital Student 50 off - CE-CH/Annual",
"products": [
{
"path": "/products/Economist/Digital Premium",
"name": "Digital Premium",
"productCode": "TE.DIGITAL"
}
]
}
],
"tracking": {},
"completed": false
}
]
}