Get Retail Store Selection Page context

Returns available retail stores for click-and-collect orders. Only displayed when delivery option type is retail store.

Preconditions:

• Delivery option must be selected and must be retail store type (is_retail_store())

• Basket must not be empty

Retail Store Filtering:

• If CHECKOUT_LIST_RETAIL_STORES is False, no stores are listed

• If CHECKOUT_RETAIL_STORE_FILTERS.by_stock is True, only stores with available stock for basket items are shown

• Otherwise, all active retail stores with click_and_collect=True are displayed

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

Retail store selection page context retrieved

application/json

errorsone of · nullableOptional

or

string[]Optional

template_namestringOptional

get/orders/checkout/?page=RetailStoreSelectionPage

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

200

Retail store selection page context retrieved

{
  "context_list": [
    {
      "page_name": "RetailStoreSelectionPage",
      "page_slug": "retailstoreselectionpage",
      "page_context": {
        "addresses": [
          {
            "pk": 10,
            "first_name": "John",
            "last_name": "Doe"
          }
        ],
        "retail_stores": [
          {
            "pk": 5,
            "name": "Downtown Store",
            "erp_code": "STORE001",
            "click_and_collect": true,
            "is_active": true,
            "township": {
              "pk": 1,
              "name": "Manhattan"
            }
          },
          {
            "pk": 6,
            "name": "Uptown Store",
            "erp_code": "STORE002",
            "click_and_collect": true,
            "is_active": true,
            "township": {
              "pk": 2,
              "name": "Brooklyn"
            }
          }
        ],
        "country": {
          "pk": 1,
          "code": "US",
          "name": "United States"
        }
      }
    }
  ],
  "pre_order": {
    "delivery_option": {
      "pk": 2,
      "name": "Store Pickup",
      "delivery_option_type": "retail_store"
    },
    "billing_address": {
      "pk": 10
    },
    "shipping_address": null,
    "retail_store": null
  },
  "errors": [],
  "template_name": "orders/checkout.html"
}