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

Get Delivery Option Selection Page context

Returns available delivery options for selection. This page is automatically skipped if only one active delivery option exists.

Preconditions:

  • User email must be set

  • Basket must not be empty

Skip Conditions:

  • Page is skipped if only one active delivery option exists

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

Delivery options retrieved

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

Delivery options retrieved

{
  "context_list": [
    {
      "page_name": "DeliveryOptionSelectionPage",
      "page_slug": "deliveryoptionselectionpage",
      "page_context": {
        "delivery_options": [
          {
            "pk": 1,
            "name": "Home Delivery",
            "delivery_option_type": "customer",
            "is_active": true
          },
          {
            "pk": 2,
            "name": "Store Pickup",
            "delivery_option_type": "retail_store",
            "is_active": true
          },
          {
            "pk": 3,
            "name": "Pickup Location",
            "delivery_option_type": "pickup_location",
            "is_active": true
          }
        ]
      }
    }
  ],
  "pre_order": {
    "user_email": "user@akinon.com",
    "delivery_option": null
  },
  "errors": [],
  "template_name": "orders/checkout.html"
}

Last updated

Was this helpful?