Customers Template

The Customers template for the import/export tools describes your customer accounts and contact information. This data is used to manage orders, subscribed messages, promotional emails, newsletters, and so on. If you are preparing your initial data import for a new Kibo eCommerce tenant, import customers first.

Merchants can also import/export customers with associated customer segments. An option at the top of the attribute selection dropdown will allow you to specify filtering on customer segment information. The export action exports all segments to a file when “customer segment” is selected. The import action updates existing segments and adds any new segments to the Customer Segment page within admin.

Access the Tools

With the Kibo eCommerce Import-Export Application (2.0) installed and enabled, go to Main > Customers > Import/Export in Kibo eCommerce Admin.

Supported File Formats

Note: Microsoft Excel limits both total file size and cell size. A single worksheet can contain a maximum of 1,048,576 rows and 16,384 columns. A single cell can contain up to 32,767 characters.

Template Key

For each sheet, we define each column and describe valid values for the column. Some values are not required for an import, but are required Kibo eCommerce data. For example, you do not have to specify a customer's FirstName every time you modify the customer account, but all customer accounts require a FirstName when they are created. For additional context about the process of building out Kibo eCommerce data, refer to the topics in Guides. If you have questions or concerns specific to your data, please contact your integration partner or Kibo eCommerce Support.

Information Provided for Each Sheet of the Template
Corresponding REST API Resource Every column in a sheet corresponds to a property in the Kibo eCommerce REST API. For each sheet, we provide a link to any API resources that contain properties in the sheet.
Column Name The name of the column in the sheet.
Description A description of the data a column contains.
Valid Values Lists valid values for the column.

Sheets

Best Practices

Use the Kibo eCommerce API to Export > 50,000 Records

For optimal performance, Kibo eCommerce recommends only using the import/export tool if you are working with fewer than 50,000 customer records. If you need to export or import more than 50,000 records, refer to Customer Import Code Samples for more information about using the Kibo eCommerce API to import your customer records.

Customer Import Code Samples

The following sample code demonstrates how to import customers using the Kibo eCommerce API. These samples were implemented using the Kibo eCommerce .NET SDK, but the general implementation is the same across all the Kibo eCommerce SDKs.

Required Behaviors

Any application that implements code to import or update customers must have the following behaviors enabled:

Import Customers

The following code sample organizes various calls to import customers to Kibo eCommerce:

Add a Customer Account

The following code sample is a unit test that demonstrates the uses of various customer import methods:

Add Account Login

The following code sample maps customer account login information to a customer object in Kibo eCommerce:

Get Account Test Data

The following code sample retrieves test data for customer accounts that you can then map to a customer object in Kibo eCommerce:

Map Account Data

The following code sample maps customer account data to a customer object:

Get Contact Test Data

The following code sample retrieves test data for customer contacts that you can then map to a customer object in Kibo eCommerce:

Map Contact Data

The following code sample maps customer contact data to a customer object: