Get Checkout Provider Shipping Option Page context

Returns the available shipping options for the delivery address provided by the checkout provider. The customer's device (via the provider's hosted form) selects a shipping option and submits it back.

Preconditions:

• Basket must not be empty

• A checkout provider must be selected

Skip Conditions:

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

Page Context:

• shipping_options — list of available options, each with name, slug, logo_url, shipping_amount, description, key

Previous Page: CheckoutProviderAddressSelectionPage

Next Page: CheckoutProviderAgreementListPage

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

Shipping Option Page context retrieved

application/json

errorsone of · nullableOptional

or

string[]Optional

template_namestringOptional

get/orders/checkout/?page=CheckoutProviderShippingOptionPage

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

200

Shipping Option Page context retrieved

{
  "context_list": [
    {
      "page_name": "CheckoutProviderShippingOptionPage",
      "page_slug": "checkoutprovidershippingoptionpage",
      "page_context": {
        "shipping_options": [
          {
            "name": "Standard Shipping",
            "slug": "standard-shipping",
            "logo_url": "https://cdn.example.com/shipping-logo.png",
            "shipping_amount": "9.90",
            "description": "Delivery in 3-5 days",
            "key": 1
          }
        ]
      }
    }
  ],
  "pre_order": {
    "user_email": "[e-mail]"
  },
  "errors": [],
  "template_name": "orders/checkout.html"
}