Get Checkout Provider Agreement List Page context

Returns the list of agreements (e.g. Preliminary Information Form, Distance Sales Agreement) that the customer must accept via the checkout provider's hosted form.

Preconditions:

• Basket must not be empty

• A checkout provider must be selected

Skip Conditions:

• Page is skipped if selected_agreement is already set in pre-order data

Page Context:

• agreements — list of agreement objects, each with code and text (available codes: info, sales)

Previous Page: CheckoutProviderShippingOptionPage

Next Page: CheckoutProviderNotificationPage

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

Agreement List Page context retrieved

application/json

errorsone of · nullableOptional

or

string[]Optional

template_namestringOptional

get/orders/checkout/?page=CheckoutProviderAgreementListPage

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

200

Agreement List Page context retrieved

{
  "context_list": [
    {
      "page_name": "CheckoutProviderAgreementListPage",
      "page_slug": "checkoutprovideragreementlistpage",
      "page_context": {
        "agreements": [
          {
            "code": "info",
            "text": "Preliminary Information Form"
          },
          {
            "code": "sales",
            "text": "Distance Sales Agreement"
          }
        ]
      }
    }
  ],
  "pre_order": {
    "user_email": "[e-mail]"
  },
  "errors": [],
  "template_name": "orders/checkout.html"
}