For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get current checkout state

Returns the current checkout state and determines which page should be displayed. The response includes a list of completed pages and the current page context.

If the page query parameter is provided, it forces the display of that specific page. Otherwise, the system automatically determines the appropriate page based on checkout progress.

get
Query parameters
pagestring · enumOptional

Optional page name to force display a specific page

Possible values:
Header parameters
x-requested-withstring · enumRequired

Required header for AJAX requests. Must be set to XMLHttpRequest for all checkout requests.

Default: XMLHttpRequestPossible values:
CookiestringOptional

Session cookie header (e.g. sessionid=abc123 or osessionid=<session_id>)

Responses
200

Checkout state retrieved

application/json
errorsone of · nullableOptional
or
string[]Optional
template_namestringOptional
get/orders/checkout/
GET /orders/checkout/ HTTP/1.1
Host: sandbox.akinon.com
x-requested-with: XMLHttpRequest
Accept: */*
{
  "context_list": [
    {
      "page_name": "IndexPage",
      "page_slug": "indexpage",
      "page_context": {
        "is_user_logged_in": false,
        "can_guest_purchase": true,
        "has_gift_box": false
      }
    }
  ],
  "pre_order": {
    "basket": {
      "pk": 123,
      "total_amount": "150.00"
    },
    "user_email": null,
    "shipping_address": null,
    "billing_address": null
  },
  "errors": [],
  "template_name": "orders/index.html"
}

Last updated

Was this helpful?