Partner Checkout

Partner endpoints for checkout flows — initiate, update, and validate checkout baskets within the partner organisation context.

Create Partner Checkout Session

post

Create or update a checkout basket using partner credentials. Uses the same checkout flow as the public endpoint but authenticated via partner token. The basket is associated with the partner organisation context.

Required scopes

This endpoint requires the following scopes:

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>

Body

application/json

Responses

200

Basket created or updated successfully.

application/json

idstringRequired

The unique ID of the created or updated basket.

Example: basket-a1b2c3d4e5f6

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

post/partner/checkout/initiate

HTTPcURLJavaScriptPython

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

{
  "order": {
    "orderItems": [
      {
        "offer": {
          "id": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2",
          "version": "f6e5d4c3b2a1f6e5d4c3b2a1f6e5d4c3b2a1f6e5"
        },
        "quantity": 1,
        "type": "offer"
      }
    ],
    "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": "basket-a1b2c3d4e5f6",
  "order": {
    "orderItems": [
      {}
    ]
  }
}

Update Partner Checkout Basket

put

Update an existing partner checkout basket with order item actions — add items, remove items, or change quantities. Uses partner authentication.

Required scopes

This endpoint requires the following scopes:

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>

Header parameters

CookiestringRequired

Landing state cookie containing the basketId.

Body

application/json

Responses

200

Basket updated successfully.

application/json

idstringRequired

orderobjectRequired

401

Unauthorized — the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.

application/json

404

Basket not found.

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

put/partner/checkout/update

HTTPcURLJavaScriptPython

PUT /api/partner/checkout/update HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Cookie: text
Content-Type: application/json
Accept: */*
Content-Length: 99

{
  "orderActions": [
    {
      "orderItemActionType": "add",
      "offerId": "text",
      "orderItemId": "text",
      "quantity": 1
    }
  ]
}

{
  "id": "text",
  "order": {},
  "orderActionResults": [
    {
      "id": "text",
      "actionType": "text"
    }
  ]
}

Validate Partner Checkout

post

Validate a partner checkout basket before order submission. Checks product availability, pricing validity, and returns any blocked products or validation errors.

Required scopes

This endpoint requires the following scopes:

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>

Path parameters

idstringRequired

The basket ID to validate (format basket-{uuid}).

Pattern: ^basket-[A-Za-z0-9\-_]{32,36}$

Responses

200

Validation result returned.

application/json

idstringRequired

The basket ID.

checkoutobjectRequired

The current basket state.

401

Unauthorized — the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.

application/json

404

Basket not found.

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

post/partner/checkout/validate/{id}

HTTPcURLJavaScriptPython

POST /api/partner/checkout/validate/{id} HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "checkout": {},
  "invalid": {
    "blockedProducts": [
      "text"
    ]
  }
}