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

Set Remote Delivery Option

Sets the selected remote delivery option. Validates that the selected option is available from the remote service.

Configuration:

  • Requires REMOTE_DELIVERY_OPTION_PROVIDER dynamic setting to be configured

  • The provider fetches delivery options from an external service based on the configuration

  • Used when CHECKOUT_DELIVERY_OPTION_SELECTION_PAGE is set to RemoteDeliveryOptionSelectionPage

post
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>)

Body
delivery_optionintegerRequired

Primary key of the selected delivery option

clearbooleanOptional

If true, clears shipping and billing addresses when changing delivery option

Default: false
Responses
200

Remote delivery option set successfully

application/json
errorsone of · nullableOptional
or
string[]Optional
template_namestringOptional
post/orders/checkout/?page=RemoteDeliveryOptionSelectionPage
POST /orders/checkout/?page=RemoteDeliveryOptionSelectionPage HTTP/1.1
Host: sandbox.akinon.com
x-requested-with: XMLHttpRequest
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 35

"delivery_option=1&clear=false"
200

Remote delivery option set successfully

{
  "context_list": [
    {
      "page_name": "text",
      "page_slug": "text",
      "page_context": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "pre_order": {
    "basket": {
      "pk": 1,
      "total_amount": "text"
    },
    "shipping_address": {
      "pk": 1,
      "email": "text",
      "phone_number": "text",
      "first_name": "text",
      "last_name": "text",
      "country": {
        "pk": 1,
        "code": "text",
        "name": "text"
      },
      "city": {
        "pk": 1,
        "name": "text"
      },
      "line": "text",
      "title": "text",
      "township": {
        "pk": 1,
        "name": "text"
      },
      "district": {
        "pk": 1,
        "name": "text"
      },
      "postcode": "text",
      "notes": "text",
      "company_name": "text",
      "tax_office": "text",
      "tax_no": "text",
      "e_bill_taxpayer": true,
      "is_corporate": true,
      "primary": true,
      "identity_number": "text"
    },
    "billing_address": {
      "pk": 1,
      "email": "text",
      "phone_number": "text",
      "first_name": "text",
      "last_name": "text",
      "country": {
        "pk": 1,
        "code": "text",
        "name": "text"
      },
      "city": {
        "pk": 1,
        "name": "text"
      },
      "line": "text",
      "title": "text",
      "township": {
        "pk": 1,
        "name": "text"
      },
      "district": {
        "pk": 1,
        "name": "text"
      },
      "postcode": "text",
      "notes": "text",
      "company_name": "text",
      "tax_office": "text",
      "tax_no": "text",
      "e_bill_taxpayer": true,
      "is_corporate": true,
      "primary": true,
      "identity_number": "text"
    },
    "shipping_option": {
      "pk": 1,
      "name": "text",
      "slug": "text",
      "logo": "https://example.com",
      "shipping_amount": "text",
      "description": "text",
      "kwargs": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    },
    "billing_and_shipping_same": true,
    "payment_option": {
      "pk": 1,
      "name": "text",
      "slug": "text",
      "payment_type": "credit_card",
      "payment_type_label": "text"
    },
    "notifications": [
      {}
    ],
    "shipping_amount": "text",
    "total_amount": "text",
    "unpaid_amount": "text",
    "loyalty_money": "text",
    "currency_type_label": "text",
    "installment": {
      "pk": 1,
      "installment_count": 1,
      "label": "text",
      "price_with_accrued_interest": "text",
      "monthly_price_with_accrued_interest": "text"
    },
    "card_info": {
      "bin_number": "text",
      "card": {
        "pk": 1,
        "name": "text"
      }
    },
    "redirect_to_three_d": true,
    "delivery_option": {
      "pk": 1,
      "name": "text",
      "delivery_option_type": "customer",
      "is_active": true
    },
    "retail_store": {
      "pk": 1,
      "name": "text",
      "erp_code": "text",
      "township": {
        "pk": 1,
        "name": "text"
      },
      "click_and_collect": true,
      "is_active": true
    },
    "funds_transfer_bank": {
      "pk": 1,
      "bank_name": "text",
      "account_holder": "text",
      "iban": "text",
      "currency": "text",
      "is_active": true
    },
    "number": "text",
    "order": {
      "pk": 1,
      "number": "text",
      "status": "text"
    },
    "payment_choice": {
      "value": "text",
      "label": "text",
      "price": "text"
    },
    "user_email": "text",
    "phone_number": "text",
    "user_phone_number": "text",
    "gift_box": {
      "note": "text",
      "gift_video": true,
      "gift_video_notification_sent": true,
      "price": "text"
    },
    "delivery_range": {
      "lower": "2026-01-01T00:00:00.000Z",
      "upper": "2026-01-01T00:00:00.000Z"
    },
    "total_amount_with_interest": "text",
    "is_guest": true,
    "is_post_order": true,
    "data_source_shipping_options": [
      {
        "pk": 1,
        "shipping_amount": "text",
        "shipping_option_name": "text",
        "shipping_option_logo": "https://example.com",
        "data_source": {
          "pk": 1,
          "title": "text"
        },
        "description": "text"
      }
    ],
    "attribute_based_shipping_options": [
      {
        "pk": 1,
        "shipping_option_name": "text",
        "shipping_option_logo": "https://example.com",
        "shipping_amount": "text",
        "product_ids": [
          1
        ],
        "attribute_value": "text",
        "attribute_key": [
          "text"
        ]
      }
    ]
  },
  "errors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "template_name": "text"
}

Last updated

Was this helpful?