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

Submit Gift Box Page

Saves the gift box selection to the pre-order with the provided note and video preferences, then proceeds to the next checkout step.

All fields are optional. Submitting without any fields creates a gift box with no note and no video.

Required Fields:

  • None — all fields are optional

Validation:

  • note: maximum 160 characters; null and empty string are accepted

State Update:

  • pre_order.gift_box is populated with the submitted note, gift_video, and gift_video_notification_sent values. The gift box product is resolved from GIFT_BOX_CONFIGURATIONS.sku.

Backward Navigation:

  • Navigating back to GiftBoxIndexPage clears pre_order.gift_box, resetting the selection

Next Pages:

  • Proceeds to the next applicable checkout step

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
notestring · max: 160 · nullableOptional

An optional personal message to include with the gift box. Maximum 160 characters. Accepts null and empty string.

Example: Happy Birthday! Wishing you all the best.
gift_videobooleanOptional

When true, a gift video is requested for this order.

Example: true
gift_video_notification_sentbooleanOptional

Indicates whether the gift video notification has already been sent. Passed through from the client after the notification is dispatched.

Example: false
Responses
200

Gift box saved, proceeding to next checkout step

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

"note='Happy Birthday! Wishing you all the best.'&gift_video=true&gift_video_notification_sent=false"
200

Gift box saved, proceeding to next checkout step

{
  "context_list": [
    {
      "page_name": "GiftBoxPage",
      "page_slug": "giftboxpage",
      "page_context": {
        "price": "5.00"
      }
    }
  ],
  "pre_order": {
    "user_email": "user@akinon.com",
    "gift_box": {
      "note": "Happy Birthday!",
      "gift_video": true,
      "gift_video_notification_sent": false
    }
  },
  "errors": {},
  "template_name": "orders/checkout.html"
}

Last updated

Was this helpful?