Get Gift Box Page context

Presents the gift box selection form. The user may add an optional personal note, request a gift video, and confirm whether a gift video notification has been sent.

The page_context exposes the price of the gift box product so the storefront can display it to the user before confirmation.

Preconditions:

• GIFT_BOX_CONFIGURATIONS.is_active must be true

• pre_order.user_email must be set

Skip Conditions:

• Page is auto-processed when a gift box selection already exists on the pre-order (i.e., pre_order.gift_box is not null)

Configuration:

• GIFT_BOX_CONFIGURATIONS: Must have is_active: true. The sku field identifies the gift box product used to resolve the displayed price. When sku is null, the price is 0.00.

Next Pages (determined dynamically):

• Proceeds to the next applicable checkout step once gift box selection is complete

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

Gift box page context retrieved

application/json

errorsone of · nullableOptional

or

string[]Optional

template_namestringOptional

get/orders/checkout/?page=GiftBoxPage

GET /orders/checkout/?page=GiftBoxPage HTTP/1.1
Host: sandbox.akinon.com
x-requested-with: XMLHttpRequest
Accept: */*

200

Gift box page context retrieved

{
  "context_list": [
    {
      "page_name": "GiftBoxPage",
      "page_slug": "giftboxpage",
      "page_context": {
        "price": "5.00"
      }
    }
  ],
  "pre_order": {
    "user_email": "[e-mail]",
    "gift_box": null
  },
  "errors": {},
  "template_name": "orders/checkout.html"
}