logo

Basket

APIs related to retrieving Limio Baskets

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.
SecuritybearerAuth
Request
query Parameters
limit
required
number

The number of objects to return.

Example: limit=10
createdAfter
required
string <date-time>

Filter items created after the provided ISO date-time string

Example: createdAfter=2020-12-01T16:00:00Z
queryMore
string

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

Example: queryMore=DnF1ZXJ5VGhlbkZldGNoBQAAAAAAGH
Responses
200

OK

401

Unauthorized

502

Bad Gateway

get/checkout/abandoned
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "queryMore": "eyJ2IjoiMSIsImMiOiJjYjY0ZDY1YS1iYzQwLTQ3YjItODI5Ny1mN2E4ZGEyYjA0M2UiLCJyIjoiMjAyNC0wMy0yNlQxNTowNDo1NC45NzVaIn0="
}
Create or update a checkout session
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.


SecuritybearerAuth 
Request 
Request Body schema: application/json
required
required
object
 
required
Array of objects
 
 Array 
object (OfferPayload) 
Details of a published Limio Offer


 
quantity
number
 
external_id
required
string
external order reference - becomes the checkoutId of the order


 
object (Tracking) 
 
offers
Array of strings
 
purchaseCountryCode
string
 
accountId
string
 
contactId
string
 
userId
string
 
country
required
string
the country code of the customer's purchase location


 
source
required
string
source of the order


 
order_type
required
string
 Enum: "new" "renew"  
Responses 
200
OK


401
Unauthorized


502
Bad Gateway


post/checkout/initiate
Request samples 
application/json
{
  • "order": {
    }
}
Response samples 
application/json
{
  • "id": "string"
}
➔ Next to Session