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

Save or clear the order note

Accepts an optional note for the order and stores it in pre_order.data['notes']. Submitting a blank or null value removes any previously stored note. This is an independent page — submitting it does not advance the checkout flow.

Fields:

  • notes: Free-text note for the order. Maximum 320 characters. null or empty string clears the note.

State Update:

  • If notes is a non-empty string: stored in pre_order.data['notes'].

  • If notes is null or empty: notes key is removed from pre_order.data.

Backward Navigation:

  • When navigating backward, notes is removed from pre_order.data.

Next Pages:

  • No further checkout page (EmptyPage)

post
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>)

Body
notesstring · max: 320 · nullableRequired

Free-text note to attach to the order. Maximum 320 characters. Submitting null or an empty string clears any previously stored note.

Example: Please leave at the door.
Responses
200

Note saved or cleared

application/json
errorsone of · nullableOptional
or
string[]Optional
template_namestringOptional
post/orders/checkout/?page=OrderNotePage
POST /orders/checkout/?page=OrderNotePage HTTP/1.1
Host: sandbox.akinon.com
x-requested-with: XMLHttpRequest
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 37

"notes='Please leave at the door.'"
200

Note saved or cleared

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

Last updated

Was this helpful?