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

Get Address Selection Page context

Returns available addresses for selection (billing and shipping). Supports both authenticated users (shows saved addresses) and anonymous users (shows addresses stored in session).

Preconditions:

  • User email must be set

  • Delivery option must be selected and must be customer type (is_customer())

  • Basket must not be empty

Address Sources:

  • Authenticated users: Addresses from their account, ordered by primary status and modification date

  • Anonymous users: Addresses stored in session via AnonymousUserAddressService

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

Address selection page context retrieved

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

Address selection page context retrieved

{
  "context_list": [
    {
      "page_name": "AddressSelectionPage",
      "page_slug": "addressselectionpage",
      "page_context": {
        "addresses": [
          {
            "pk": 10,
            "first_name": "John",
            "last_name": "Doe",
            "email": "john@akinon.com",
            "phone_number": "+15551234567",
            "line": "123 Main St",
            "country": {
              "pk": 1,
              "code": "US",
              "name": "United States"
            },
            "city": {
              "pk": 1,
              "name": "New York"
            },
            "township": {
              "pk": 1,
              "name": "Manhattan"
            },
            "primary": true
          },
          {
            "pk": 11,
            "first_name": "John",
            "last_name": "Doe",
            "email": "john@akinon.com",
            "phone_number": "+15551234567",
            "line": "456 Oak Ave",
            "country": {
              "pk": 1,
              "code": "US",
              "name": "United States"
            },
            "city": {
              "pk": 1,
              "name": "New York"
            },
            "township": {
              "pk": 2,
              "name": "Brooklyn"
            },
            "primary": false
          }
        ],
        "country": {
          "pk": 1,
          "code": "US",
          "name": "United States"
        }
      }
    }
  ],
  "pre_order": {
    "user_email": "john@akinon.com",
    "delivery_option": {
      "pk": 1,
      "name": "Home Delivery",
      "delivery_option_type": "customer"
    },
    "shipping_address": null,
    "billing_address": null
  },
  "errors": [],
  "template_name": "orders/checkout.html"
}

Last updated

Was this helpful?