API DocsSubmit a Support Request

Abandoned Basket API

Retrieve abandoned baskets

A full guide on how to implement abandon basket campaigns is available:

Guide: Abandoned Basket CampaignsThis API returns incomplete or “abandoned” baskets.

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
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
queryMorestringOptional

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

Example: DnF1ZXJ5VGhlbkZldGNoBQAAAAAAGH
Responses
200

OK

application/json
get
/checkout/abandoned
GET /api/checkout/abandoned?limit=10&createdAfter=2020-12-01T16%3A00 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="
}
PreviousObject APINextBuild and Publish API

Last updated

Was this helpful?