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

Get Pickup Location Selection Page context

Returns context for pickup location selection. Only displayed when delivery option type is pickup location.

Preconditions:

  • Delivery option must be selected and must be pickup location type (is_pickup_location())

  • Basket must not be empty

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

Pickup location selection page context retrieved

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

Pickup location selection page context retrieved

{
  "context_list": [
    {
      "page_name": "PickupLocationSelectionPage",
      "page_slug": "pickuplocationselectionpage",
      "page_context": {
        "addresses": [
          {
            "pk": 10,
            "first_name": "John",
            "last_name": "Doe"
          }
        ],
        "country": {
          "pk": 1,
          "code": "US",
          "name": "United States"
        }
      }
    }
  ],
  "pre_order": {
    "delivery_option": {
      "pk": 3,
      "name": "Pickup Location",
      "delivery_option_type": "pickup_location"
    },
    "billing_address": {
      "pk": 10
    },
    "shipping_address": null
  },
  "errors": [],
  "template_name": "orders/checkout.html"
}

Last updated

Was this helpful?