Abandoned Baskets API

Back-office API for listing abandoned checkout baskets — baskets that were started but where the order was never completed. Returns abandoned baskets of any checkout type. Use it for remarketing, abandoned-cart recovery campaigns, and customer behaviour analysis.

List 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. Abandoned baskets of every checkout type are returned — new subscription, update subscription, and renewal. 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

OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.

Obtain a token via the OAuth flow described in OAuth Bearer Token.

Pass the token in the Authorization header: Bearer <token>

Query parameters

limitintegerRequired

Maximum number of objects to return. Defaults to 50 if not specified.

Default: 50Example: 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 — the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.

application/json

502

Bad Gateway — an upstream service returned an unexpected response. This typically indicates an issue with the request payload (e.g. invalid field values, missing required fields) or a transient infrastructure error. Retry the request, and if the issue persists, verify the request body matches the expected schema.

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": "[e-mail]",
        "firstName": "John",
        "lastName": "Doe",
        "companyName": "Limio LLC"
      },
      "orderItems": [
        {
          "name": "The Offer",
          "path": "/offers2/The Offer",
          "products": [
            {
              "path": "/products/Digital All Access",
              "productCode": "SKU-00000001"
            }
          ]
        }
      ],
      "customFields": {
        "customFieldName": "value"
      },
      "tracking": {
        "offers": [
          "/offers2/UK Annual digital",
          "/offers2/UK Monthly digital"
        ],
        "campaign": "/pages2/Pricing Direct",
        "tag": "/direct-checkout"
      },
      "identities": [
        {
          "sub": "[e-mail]",
          "iss": "https://issuer.domain",
          "service": "salesforce",
          "type": "account"
        }
      ],
      "entry": "/direct-checkout?purchase=%2Foffers2%2FHero%20Plan&utm_source=email&utm_medium=cpc&utm_campaign=spring_promo",
      "completed": false,
      "recoveryLink": "/api/checkout/recover?basket=basket-8cf72b2a-eb57-462d-8e55-981c3b5e5364&recover=abc123"
    }
  ],
  "queryMore": "eyJ2IjoiMSIsImMiOiJjYjY0ZDY1YS1iYzQwLTQ3YjItODI5Ny1mN2E4ZGEyYjA0M2UiLCJyIjoiMjAyNC0wMy0yNlQxNTowNDo1NC45NzVaIn0="
}