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

Get Reward Selection Page context

Returns the list of available rewards fetched in the preceding RewardListPage step. The user selects how much of each reward type to apply to the order. This is an independent page — submitting it does not advance the checkout flow.

Preconditions:

  • Basket must not be empty

  • Reward data must have been fetched (i.e., rewards must not be null in pre-order)

Skip Conditions:

  • Page is skipped if rewards have already been selected (i.e., selected_rewards is not null)

Next Pages:

  • No further checkout page — this is a terminal reward 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

Reward Selection Page context retrieved

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

Reward Selection Page context retrieved

{
  "context_list": [
    {
      "page_name": "RewardSelectionPage",
      "page_slug": "rewardselectionpage",
      "page_context": {
        "rewards": [
          {
            "amount": "50.00",
            "type": "general"
          },
          {
            "amount": "30.00",
            "type": "special"
          }
        ]
      }
    }
  ],
  "pre_order": {
    "user_email": "user@akinon.com",
    "rewards": [
      {
        "amount": "50.00",
        "type": "general"
      },
      {
        "amount": "30.00",
        "type": "special"
      }
    ],
    "selected_rewards": null
  },
  "errors": [],
  "template_name": "orders/checkout.html"
}

Last updated

Was this helpful?