See related

Integrate an order system with Kustomer

Last Update: Sep 2024 • Est. Read Time: 2 MIN
To check plan availability, see the pricing page.

You can integrate your order system with Kustomer in any one of these 3 ways:

  1. Install an ecommerce integration from the Kustomer App Directory.
  2. Use the Kustomer API
  3. Use a Kustomer webhook and workflow

In this article, we'll cover these options to help you understand which approach might work best for your system.

Who can access this feature?
User typesAdmins can access these settings.


In this article

Install from the Kustomer App Directory

Installing an integration from the Kustomer App Directory is the easiest method for integrating with external products and services.

Select Apps > Explore Directory to find ready-to-use integrations with a wide variety of third-party services. We'd recommend this integration method if you use a popular order system like Shopify, Magento, or BigCommerce.

Use the Kustomer API

If you have access to developer resources and can make updates to your order system's program, the Kustomer API is another great way to integrate with Kustomer. By making direct calls to the Kustomer API, you can create and update orders in Kustomer as soon as orders are created and updated in your system.

When you're ready to create an order in Kustomer, you'll first want to find or create a customer. To find a customer, you can look them up by email, phone number, or an external ID. If the customer is not found by any of those lookups, you should create a new customer. With the customer's Kustomer ID, you can now create an order on their timeline using the Create Customer KObject endpoint. We recommend setting an external ID for every order that links the order back to your order system. This way, if you'd like to an update an order after it's been created, you can find the order by its external ID using the Get KObjects endpoint followed by the query externalId={{externalId_here}}. Then, you can update the order using the Update KObject endpoint.

Note: Before creating an order on a customer's timeline, you'll need to create a new klass to represent orders in Kustomer. Learn more about creating klasses in Define custom attributes in Kustomer.

Use a Kustomer webhook and workflow

If your access to developer resources is limited, using a Kustomer webhook and workflow is another alternative to integrating your system with Kustomer. By setting up webhook notifications whenever an order is created or updated in your system, you can notify Kustomer that an order is ready to be created or updated using a workflow.

To learn how to import data into Kustomer using workflows, see Using Workflows to import data.

For information on how to render nested objects or "sub-objects" in a Klass View (such as shipments or line items that would belong to an Order), refer to Manual Option A in Use Klass relationships to create nested Order objects.