Documentation

Headless Checkout API - Advanced Topics


The Headless Checkout API is a backend solution designed to enable the creation of a custom checkout experience, eliminating the need for direct frontend integration.

In this article, we offer more in depth information about advanced topics related to the Headless Checkout API.

Split Checkout

What is Split Checkout?

In certain situations, a retailer may need to divide an order into multiple deliveries. The primary reasons for this include:

A split can occur at different stages of the order lifecycle:

How does Split Checkout work in Headless Checkout API?

In Headless Checkout API, the split checkout is represented by multiple deliveries within a single session. Each delivery can have its own set of delivery options, allowing customers to choose how they want each part of their order delivered.

{
  "deliveries": [
    {
      "id": "1",
      "delivery_categories": [
        {
          "id": "home-delivery-1384f5e83e3b4143a1c2475214a1de2c",
          "delivery_type": "DELIVERY",
          "display_name": "Home Delivery",
          "delivery_options": [
            {
              "id": "0196f224-1037-7aff-a6aa-972b631188a2",
              "carrier": {
                "name": "InPost",
                "product_id": "inpost-d2d"
              }
            }
          ]
        }
      ]
    },
    {
      "id": "2",
      "delivery_categories": [
        {
          "id": "home-delivery-9a7f6b5c2d3e4f7a9281b0987654c321",
          "delivery_type": "DELIVERY",
          "display_name": "Home Delivery",
          "delivery_options": [
            {
              "id": "82d5f0a3-d598-45fc-9b63-3e05adc0a084",
              "carrier": {
                "name": "DHL",
                "product_id": "dhl-eww"
              }
            }
          ]
        }
      ]
    }
  ]
}

How Ingrid Widget displays Split Checkout?

Here is an example of how the Ingrid Widget displays split checkout when different products are delivered in separate packages due to product restrictions:

Ingrid Checkout Widget

Here is an example of how the Ingrid Widget displays split checkout when each delivery comes from a different warehouse, allowing the customer to choose delivery options for each package:

Ingrid Checkout Widget

Last updated: Fri, Aug 08, 06:15 AM