Skip to main content

Kustom Shipping Assistant (KSA)

A comprehensive guide to Kustom Shipping Assistant (KSA): how it displays shipping options, the four parties involved, shipping method components, and step-by-step instructions for setting up profiles and credentials in the Kustom Portal.

Updated over a week ago

Overview

This guide covers everything you need to know about Kustom Shipping Assistant (KSA)—from understanding how it displays shipping options in your checkout to setting up the technical integration. You'll learn about the four parties involved (your platform, Kustom, your Transport Management System (TMS), and carriers), the components of a shipping method (shipping method type, carrier ID, and optional badges), and how to create profiles and credentials in the Kustom Portal. The guide also includes links to technical documentation and support resources.

Note: KSA setup also requires backend configuration. Please read more here before you begin.

What is Kustom Shipping Assistant (KSA)?

Kustom Shipping Assistant (KSA) is a feature within Kustom Checkout (KCO) that displays shipping options to your customers during checkout. If you've never heard of KSA before, think of it as the bridge between your shipping provider and your checkout—it makes sure your customers see the right delivery options at the right time, with all the details they need to make their choice.

KSA handles what your customers see (the user interface), while your Transport Management System (TMS) controls which shipping options are available based on factors like destination, cart value, or product type.

How KSA works

Four parties work together to display shipping methods in your checkout:

  • Your e-commerce platform (such as WooCommerce or Magento)

  • Kustom (provides the checkout interface)

  • Transport Management System (TMS) (such as nShift, Ingrid, LogTrade, or a custom-built solution)

  • Carriers (the logistics companies that actually deliver the orders, such as PostNord, Budbee, or DHL)

Here's the flow: Your TMS determines which shipping methods are available based on your business rules. It then sends this information to KSA through an API. KSA displays these options in a user-friendly format in your checkout, complete with carrier logos and any special features like express delivery or eco-friendly options.

What customers see in the checkout

When a customer reaches the shipping step in checkout, they'll see a list of available delivery options. Each option includes:

  • The shipping method type (such as home delivery or pickup point)

  • The carrier name and logo (such as PostNord or Budbee)

  • The estimated delivery time

  • The shipping cost

  • Optional badges highlighting features like "Express" or "Eco-friendly"

If the option is a pickup point, customers can search for and select their preferred location directly in the checkout.

Components of a shipping method

Each shipping method is made up of three main parts:

Shipping method (required)

  • Predefined types such as home delivery, pickup point, or store pickup

  • Controlled by KSA and includes specific supported features for each type

  • Examples: "Home delivery" allows customers to receive packages at their address, while "Pickup point" lets them choose a nearby location

Carrier ID (required)

  • Identifies which logistics company will fulfill the delivery

  • Kustom manages the list of supported carriers and their logos

  • Examples: PostNord, Budbee, DHL, UPS

Badges (optional)

  • Highlights special features such as "Express," "Eco-friendly," or "Climate neutral"

  • Only badges that KSA supports can be displayed

  • Your TMS determines when to apply these badges based on your business rules

Key things to know

  • KSA works with both Klarna-powered checkouts and Kustom-powered checkouts

  • Available globally—you can use it regardless of where your customers are located

  • Kustom controls the carrier names and logos to ensure consistency and quality

  • Your TMS controls all the business logic—which shipping methods appear, when they appear, and what they cost

  • You maintain full control over your shipping rules through your DMS configuration

How to add shipping credentials in the Kustom Portal

Before you start

  • Only users with Admin or Super Admin roles can access the Integrations section in the Kustom Portal

  • You'll need API credentials from your Transport Management System (TMS) provider that will be integrated with Kustom Checkout

Add a shipping profile (API credentials)

Use this process when you need to add API credentials that you've generated in your TMS to connect your shipping integration to Kustom.

How to access integrations

  1. Log in to the Kustom Portal

  2. Select Integrations from the left menu

  3. Select Shipping

  4. Choose the relevant Store from the dropdown

Steps to add a profile

  1. Click Create profile

  2. Enter a Profile name (choose a descriptive name like "Production TMS" or "Test Environment")

  3. Select the TMS ID from the dropdown (this is your Transport Management System)

  4. Enter your API ID (generated in your TMS)

  5. Enter your API Secret (generated in your TMS)

  6. Enable Long titles if you want the carrier name to appear at the end of the shipping option name

  7. Click Create profile

This adds the credentials that allow your TMS to connect to Kustom's KSA API and send shipping options to your checkout.

Add a market to a profile

  1. Click anywhere on the newly created profile

  2. Add a market by selecting either:

    • Global (to include all countries)

    • Specific countries (you can add as many countries as you need—there is no limit)

Delete a profile

  1. Click the three dots on the far left of the profile you want to delete

  2. If you have an active country added to the profile:

    • Click anywhere on the profile

    • Remove the country

    • Then you can delete the profile

Note: You cannot delete a profile if it has an active country associated with it.

Create an internal TMS

Use this process if you need to add a new Transport Management System (TMS) to the Kustom Portal. This is typically only needed if you're using a custom-built TMS or a provider that isn't already listed.

Steps to create a TMS

  1. Click Create TMS

  2. Enter the TMS name (the name of your Delivery Management System)

  3. Enter the TMS ID (a unique identifier for this system)

  4. Enter the TMS URL

    • Must use a secure connection (https://)

    • This is the endpoint where Kustom will communicate with your DMS

  5. Click Create TMS

Did this answer your question?