Basket

APIs related to retrieving Limio 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

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="
}

Create or update a checkout session

post

Create or update a basket in Limio for the basket to be tracked and used in order submission. This is the first step in the checkout process. The basket will be created or updated based on the provided data. The basket ID will be returned in the response.

Required scopes

This endpoint requires the following scopes:

Authorizations

bearerAuth

AuthorizationstringRequired

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

Usage format: Bearer <token>

Body

application/json

Create a new basket

Responses

200

OK

application/json

idstringOptional

The ID of the created or updated basket.

401

Unauthorized

application/json

502

Bad Gateway

application/json

post

/checkout/initiate

HTTPcURLJavaScriptPython

POST /api/checkout/initiate HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 440

{
  "order": {
    "orderItems": [
      {
        "offer": {
          "id": "8a512ee55befaea0f7fa962cea9982d0e84f0098",
          "version": "4dd34671f26fdbbf240560b78f7f2f54654cde72"
        },
        "quantity": 1
      }
    ],
    "external_id": "1234567890",
    "tracking": {
      "offers": [
        "/offers2/$75 for 52 weeks then $31.96 every 4 weeks autorenew"
      ],
      "purchaseCountryCode": "GB",
      "accountId": "0017x00000Q9O9qAAF",
      "contactId": "0037x00000F58M9AAJ",
      "userId": "0057x0000088Oh3AAE"
    },
    "country": "GB",
    "source": "shop",
    "order_type": "new"
  }
}

{
  "id": "text"
}