---
title: "Kustom integration"
canonical: "https://ingrid-support.refined.site/space/KB/583565331/Kustom%20integration"
format: markdown
---
## What is it?

The **Kustom integration** connects Ingrid's delivery intelligence directly into the Kustom Checkout experience. When a shopper reaches checkout, Kustom calls Ingrid's headless API to retrieve dynamic delivery options, accurate ETAs, and carrier-optimized pricing — and renders them natively inside the Kustom checkout flow.

The integration is built on Ingrid's new headless API. Configuration ownership lives in the Ingrid portal: retailers control delivery options, naming, translations, sorting, pricing, and filter rules from one place, and the configured experience is reflected directly in the checkout.

---

## Key benefits

- **One unified checkout flow** — shoppers pick delivery and payment in a single experience. Delivery options render inline in Kustom's checkout via Ingrid's headless API, with no redirects or external embeds.
- **Full configuration control in Ingrid** — delivery option names, translations, categories, sorting, delivery times, prices, and filter rules are managed in the Ingrid portal. What you configure is what shoppers see.
- **Real-time delivery intelligence** — dynamic options, accurate ETAs, and carrier-optimized pricing returned through the headless API as the shopper enters their address.
- **One integration project** — retailers activate Kustom and Ingrid through a single joint onboarding. No separate delivery integration build.
- **Cross-market scaling** — supports broader markets through Kustom's 170+ market coverage and Ingrid's 350+ carriers.

---

## How it works

### Integration architecture

Kustom owns the checkout UI and the address capture. Ingrid powers all delivery logic through its headless API. The shopper sees one seamless flow.

| Step | What happens |
| --- | --- |
| 1. Cart created | Kustom creates a checkout session |
| 2. Address captured | Kustom passes address + cart data (line items, weight, dimensions, tags) to Ingrid |
| 3. Delivery options returned | Ingrid's headless API returns delivery categories, options, ETAs, and prices |
| 4. Option selected | Shopper selects a delivery option in Kustom's UI; Kustom calls Ingrid to confirm the selection |
| 5. Payment | Kustom handles the payment step |
| 6. Order completed | Order data is forwarded to the e-commerce platform with the Ingrid order reference (TOS ID). |

### Data exposed at order completion

At order completion, two Ingrid references are available on the order:

- **TOS ID** — the order-level Ingrid reference. Use this for all post-purchase and downstream processing (fulfillment, WMS, support lookups).
- **Session ID** — exposed as `tms_reference` for backwards compatibility. It references the checkout session and is intended for logging and troubleshooting only — **it should not be used for post-purchase processing**.

Kustom also stores details of the selected shipping option (carrier, service, price, delivery details). The Ingrid delivery option carrier **product ID** is mapped to Kustom's `selected_shipping_option.delivery_details.product.identifier`.

### Preview functionality

If a shopper enters the checkout without a known address, Ingrid can return a preview list of delivery options based on minimal data — typically the market or zip code — so shoppers see options even before completing the address step. Final delivery options are confirmed once the full address is entered.

### Split shipments and delivery groups

Split shipments and multiple delivery groups are **supported** in this integration. For implementation details, refer to [Kustom's Ingrid integration documentation](https://docs.kustom.co/contents/partners/tms-partners/ingrid).

### Configuration ownership

The new integration moves all configuration to the Ingrid portal:

| What you configure in Ingrid portal | Effect in Kustom checkout |
| --- | --- |
| Delivery option names | User-facing names shown to shoppers |
| Translations | Multi-language support per market |
| Categories | How delivery options are grouped (pickup, parcel locker, home delivery, etc.) |
| Sorting | Order in which options appear |
| Filter rules | Business rules (price thresholds, SKU-based delivery, time-based rules) |
| Carrier products | Which carriers and services are available per market |

---

## Use cases

**Multi-market e-commerce** — A Nordic retailer running Kustom Checkout across Sweden, Norway, Denmark, and Finland connects Ingrid for delivery intelligence. Each market has its own carrier mix (Bring across all, PostNord in Sweden, custom carriers per country). Configuration is set up per market in Ingrid; the same Kustom integration serves all markets.

**Parcel locker and pickup point experience** — A retailer separates Bring parcel lockers from regular pickup points so shoppers see them as distinct delivery categories. The separation is configured in the Ingrid portal and reflected directly in the Kustom checkout — no UI changes needed in Kustom.

**SKU-based delivery rules** — A retailer with mixed stock availability sets up filter rules in Ingrid that adjust delivery promises based on the SKUs in the cart. Shoppers see accurate delivery times reflecting real availability.

---

## Configuration guide

### Onboarding requirements

To activate the Kustom integration, you'll need:

- An active Kustom Checkout subscription
- An active Ingrid account with the carriers and delivery options you want to offer
- **A signed Data Processing Agreement (DPA)** — contact your CSM or create a ticket via [support.ingrid.com](https://support.ingrid.com/) if you don't have one in place
- Site IDs and credentials per market (managed via Kustom's Merchant Portal)
- Access to the Ingrid backoffice for configuration

### Setup steps (high-level)

1. **In Kustom Merchant Portal:** set up Ingrid as the TMS (Transport Management System) for each market. Configure the TMS name, TMS reference, and TMS URL. Refer to [Kustom's Ingrid integration documentation](https://docs.kustom.co/contents/partners/tms-partners/ingrid) for detailed instructions.
2. **In Ingrid portal:** configure your delivery options, categories, translations, sorting, and filter rules per market.
3. **Verify in QA:** confirm that the Kustom QA environment is connected to the Ingrid QA environment. Send test orders to validate the end-to-end flow (selection → booking → fulfillment).
4. **Rollout per market:** enable the integration market by market, starting with smaller markets. Confirm that orders flow through to your warehouse management system correctly.

### What lives where

| Configuration area | Location |
| --- | --- |
| Checkout UI behavior | Kustom Merchant Portal |
| Delivery option names + translations | Ingrid portal |
| Categories, sorting, pricing rules | Ingrid portal |
| Filter rules (SKU, time, threshold-based) | Ingrid portal |
| Carrier connections | Ingrid portal |
| TMS connection (URLs, credentials) | Kustom Merchant Portal |

---

## FAQ

**Q: Do I need to make changes to my checkout UI?**    
A: No. The change is on the API side. Ingrid's delivery options render natively inside Kustom's existing checkout UI.

**Q: What about my warehouse management system?**    
A: WMS compatibility depends on the data fields available through the integration and whether you're also booking with Ingrid TA.

**Q: Can I support multiple languages?**    
A: Yes. Translations for delivery option names and category labels are configured in the Ingrid portal per market.

**Q: Does the integration support split shipments?**    
A: Yes, split shipments and multiple delivery groups are supported.

**Q: What if I need a delivery feature not yet supported in the headless API?**    
A: There are currently no known limitations in the Kustom integration. If you need a specific delivery feature, check with your CSM.

**Q: How long does setup take?**    
A: With Kustom and Ingrid both activated, the integration setup is a joint onboarding — typically faster than running two separate integration projects. Specific timeline depends on the number of markets and the complexity of your delivery rules.

**Q: Can I test before going live?**    
A: Yes. Connect Kustom QA to Ingrid QA for end-to-end order testing.

---

## Getting started

To connect Kustom Checkout with Ingrid:

1. Confirm both your Kustom and Ingrid contracts are active.
2. **Sign a new DPA agreement** — contact your CSM or create a ticket via [support.ingrid.com](https://support.ingrid.com/).
3. Gather your Site IDs and credentials per market from the Kustom Merchant Portal.
4. Follow [Kustom's Ingrid integration documentation](https://docs.kustom.co/contents/partners/tms-partners/ingrid) to configure Ingrid as the TMS in the Kustom Merchant Portal.
5. Fetch your private key (non base-64) from the Ingrid Merchant Portal and add it to the Kustom Merchant Portal.

The documentation above is intended to be sufficient for self-serve configuration. If you run into issues, reach out to your onboarding manager (during onboarding) or your CSM (post-go-live).