Checkout & Baskets

Create, update, and retrieve checkout baskets. Includes initiating checkout sessions, renewal checkouts, applying promo codes, updating baskets, and retrieving abandoned baskets.

Update Checkout Basket

put

Update an existing checkout basket with order item actions — add items, remove items, or change quantities. The basket ID is read from the landing state cookie. Returns the updated order and action results.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
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>

Header parameters
CookiestringRequired

Landing state cookie containing the basketId.

Body
Responses
chevron-right
200

Basket updated successfully.

application/json
idstringRequired

The basket ID.

orderobjectRequired

The updated order.

put
/checkout/update

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

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
chevron-right
200

OK

application/json
queryMorestringOptional

Cursor for the next page of results

Example: eyJ2IjoiMSIsImMiOiJjYjY0ZDY1YS1iYzQwLTQ3YjItODI5Ny1mN2E4ZGEyYjA0M2UiLCJyIjoiMjAyNC0wMy0yNlQxNTowNDo1NC45NzVaIn0=
get
/checkout/abandoned

Retrieve existing subscription checkout basket

get

Fetch existing basket by basketId from landing state cookie. Used to retrieve current checkout state after page refresh or navigation.

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

Header parameters
CookiestringRequired

Landing state cookie containing basketId

Responses
chevron-right
200

Basket retrieved successfully

application/json
completedbooleanOptional

Whether the checkout is completed

get
/checkout/subscription

Initiate update subscription checkout

post

Create a new basket for update subscription with available upgrade/downgrade options. This is the first step in updating a subscription - it creates a basket and returns available actions.

Returns:

  • Checkout & Baskets with available upgrades, downgrades, cross-sells, and add-ons

  • Sets landing state cookie with basketId for subsequent requests

Status 423: Subscription has pending change (locked until date passes)

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

Header parameters
X-Limio-RecaptchastringRequired

reCAPTCHA token for bot prevention

X-Forwarded-ForstringOptional

Client IP address

RefererstringOptional

Referrer URL for journey tracking

Body
trackingobjectOptional

Optional tracking data for analytics and reporting

Responses
chevron-right
200

Checkout basket created successfully

application/json
post
/checkout/subscription

Update subscription checkout basket

put

Update existing basket with order items (add/remove offers and add-ons).

Business Logic:

  • Only 1 add offer allowed per request

  • System auto-adds remove action for current subscription offer when adding new offer

  • System auto-removes incompatible add-ons when switching subscription offers

  • System calculates prices, line items, and effective dates

  • Cross-sells are recalculated based on updated basket

Requirements:

  • basketId must be present in landing state cookie (from POST response)

  • Checkout & Baskets must belong to authenticated user

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

Header parameters
X-Limio-RecaptchastringRequired

reCAPTCHA token for bot prevention

CookiestringRequired

Landing state cookie containing basketId

Body
Responses
chevron-right
200

Basket updated successfully

application/json
completedbooleanOptional

Whether the checkout is completed

put
/checkout/subscription

Create Checkout Session

post

Create a basket on behalf of a customer. Used for server-side checkout flows, assisted sales, and programmatic order initiation. Returns a recovery link for the customer to resume the checkout, and optionally an assisted checkout link when the basket has an owner.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
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>

Body

Create a new basket

Responses
chevron-right
200

Admin checkout session created successfully.

application/json
idstringRequired

The unique ID of the created basket.

Example: basket-a1b2c3d4e5f6
recoveryLinkstringRequired

URL path for the customer to recover and resume this checkout session. Includes a signed token valid for 30 days.

Example: /api/checkout/recover?basketId=basket-a1b2c3d4e5f6&recover=eyJ...
assistedCheckoutLinkstringOptional

URL path for assisted checkout (on-behalf-of flow). Only present when the basket has an identified owner. Includes a signed token valid for 30 days.

Example: /api/checkout/assisted?basketId=basket-a1b2c3d4e5f6&cl=eyJ...
post
/admin/checkout/initiate

Create Renewal Checkout Session

post

Create a checkout session for renewing an existing subscription. Looks up the subscription by ID or reference, retrieves the customer's renewal details, and creates a basket pre-populated with the renewal context.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
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>

Body
Responses
chevron-right
200

Renewal checkout session created successfully.

application/json
idstringRequired

The unique ID of the created renewal basket.

Example: basket-a1b2c3d4e5f6
segmentsstring[]Optional

Customer segments applicable to the renewal.

post
/admin/checkout/initiate/renew

Apply Promo Code to Basket

post

Apply a promotional code to an existing checkout basket. Validates the code, applies applicable discounts, and returns the updated order with recalculated pricing.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
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>

Body
codestringRequired

The promotional code to apply.

Example: SUMMER20
basketIdstringRequired

The basket ID to apply the promo code to.

Example: basket-a1b2c3d4e5f6
Responses
chevron-right
200

Promo code applied successfully.

application/json
idstringRequired

The basket ID.

post
/admin/v2/promo_code

Last updated

Was this helpful?