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

Get Order Note Page context

Returns the current order note stored in the pre-order. This page allows the user to add or update a free-text note attached to their order. This is an independent page — submitting it does not advance the checkout flow.

Preconditions:

  • Basket must not be empty

Skip Conditions:

  • Page is skipped if a note has already been entered (i.e., notes is set in pre_order.data)

Next Pages:

  • No further checkout page from this step (EmptyPage)

get
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

Order Note Page context retrieved

application/json
errorsone of · nullableOptional
or
string[]Optional
template_namestringOptional
get/orders/checkout/?page=OrderNotePage
GET /orders/checkout/?page=OrderNotePage HTTP/1.1
Host: sandbox.akinon.com
x-requested-with: XMLHttpRequest
Accept: */*
200

Order Note Page context retrieved

{
  "context_list": [
    {
      "page_name": "OrderNotePage",
      "page_slug": "ordernotepage",
      "page_context": {
        "notes": ""
      }
    }
  ],
  "pre_order": {
    "user_email": "user@akinon.com"
  },
  "errors": [],
  "template_name": "orders/checkout.html"
}

Last updated

Was this helpful?