Get Checkout Provider Address Selection Page context

Returns the redirect URL for the checkout provider's hosted address selection form. The customer is redirected to or shown the provider's form to enter their shipping and billing addresses.

Preconditions:

• Basket must not be empty

• A checkout provider must be selected

• redirection_started must be true in pre-order data

Skip Conditions:

• Page is skipped if both billing_address and shipping_address are already set on the pre-order

Page Context:

• redirect_url — URL of the provider's hosted address form

• is_iframe — optional boolean indicating if the form should be embedded as an iframe

Previous Page: CheckoutProviderSelectionPage

Next Page: CheckoutProviderShippingOptionPage

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=CheckoutProviderAddressSelectionPage

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

200

Address Selection Page context retrieved

{
  "context_list": [
    {
      "page_name": "CheckoutProviderAddressSelectionPage",
      "page_slug": "checkoutprovideraddressselectionpage",
      "page_context": {
        "redirect_url": "https://akifast.example.com/checkout/abc123",
        "is_iframe": false
      }
    }
  ],
  "pre_order": {
    "user_email": "[e-mail]"
  },
  "errors": [],
  "template_name": "orders/checkout.html"
}