B2B Template

The B2B template for the import/export tools describes B2B accounts, contacts, purchase order information, and individual users. It contains very similar data as to that found in the Customers Import/Export template.

B2B template file content with example data

Access the Tools

With the Mozu Import-Export Application installed and enabled, go to Main > B2B > Import/Export in Kibo eCommerce Admin.

Supported File Formats

CSV (.csv): Each sheet is a separate CSV file. For both imports and exports, sheets are compressed into a ZIP file. When importing, the ZIP file can have any file name but each individual CSV file name must match the export file name and the sheet. You can remove CSV files for data you do not want to import.

These CSV files should not be opened in Excel, as that may cause errors with their formatting. Instead, use a different CSV editing program to make changes to the data.

You should only use the default Windows zipper to zip the files, as using different software may cause errors. You can upload multiple files at once as long as they all are zipped.

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. If you have questions or concerns specific to your data, please contact your integration partner or Kibo 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

B2BAccounts

Corresponding REST API Resource: commerce/customer/b2baccounts

This sheet defines the B2B accounts within Kibo eCommerce, which each include an admin user account and may include purchaser and non-purchaser user accounts as detailed in the B2BUsers sheet. See the B2B user guide for more information about this feature and B2B accounts.

Column Name	Description	Valid Values
ExternalId	A unique identifier you can use to refer to the customer in import/export operations or the Kibo eCommerce API. Typically, this is a value that is used by an external program to identify a customer in Kibo eCommerce. This value is not exposed in Admin.	Any string that is unique among all customer accounts.
AccountId	The unique identifier for the customer account.	Any integer that is unique among all customer accounts. Can be the same or different than the Id.
Company Or Organization	The company or organization the customer works for.	Any string.
TaxId	The tax ID associated with the account.	Any string.
Tax Exempt	Specifies whether the account has tax exempt status.	A Boolean value, specified as `Yes` or `No`.
Customer Set	The customer set that the customer account belongs to. This field is optional. Note: Each unique customer account can only belong to one customer set. For more information, refer to the Customer Sets topic.	The name of the customer set you want to assign the customer account to. Note: The customer set must already exist. You cannot create new customer sets through the Kibo eCommerce Import-Export Application.
Customer Segments	The name of the customer segment as it appears in Admin.	Any string.
Total Order Amount	The total amount, in the currency specified by LocaleCode, of all orders that have been processed on this account. This value includes cancellations and refunds.	Any decimal value.
Total Orders	The total number of orders that have been processed on this account.	Any integer value.
Last Order Date	The date and time at which the last order was placed on this account.	A date and time in UTC format.
Last Modified Date	The date and time that the customer account was last edited, either by the customer or by the system.	A date and time in UTC format.
Price List	The code that uniquely identifies the price list in the master catalog.	Any string that is a valid price list code. Codes can be a maximum of 50 characters, and can contain only alphanumeric characters, hyphens, and underscores.

B2BContacts

Corresponding REST API Resource: commerce/customer/accounts/contacts

As in the Customers Import/Export template, this sheet defines the contacts for user accounts. Contacts include such information as telephone numbers, shipping and billing addresses, and so on. A single customer account can have multiple contacts associated with it.

Column Name	Description	Valid Values
ExternalId	A unique identifier you can use to refer to the customer in import/export operations or the Kibo eCommerce API. Typically, this is a value that is used by an external program to identify a customer in Kibo eCommerce. This value is not exposed in Admin.	Any string that is unique among all customer accounts.
AccountID	The unique identifier for the customer account.	Any integer that is unique among all customer accounts. Can be the same or different than the Id.
ContactId	The unique identifier for a specific contact within a customer account. This value is not exposed in Admin.	Any string that is unique among all contact IDs on the tenant. Typically, this will be a number. For accounts with only one contact, the ContactID usually matches the AccountID.
Type	The type of the contact.	A string matching one of the following: `Shipping` `Billing`
IsPrimary	Specifies whether the contact is the primary contact of the specified Type for the customer account.	A Boolean value, specified as `Yes` or `No`.
Company Or Organization	The company or organization associated with the contact. This can differ from the CompanyOrOrganization on the customer account. For example, a customer with an account from Company X might order a product and ship it to Company Y.	Any string.
First Name	The first name for the contact. This can differ from the name on the customer account.	Any string.
Middle Name	The middle name or initial for the contact.	Any string.
Last Name	The last name or surname for the contact.	Any string.
Email	The email address associated with the contact.	Any string. Kibo eCommerce does not validate email addresses.
Fax Number	The fax number associated with the contact.	Any string. You can include spaces and characters.
Home Phone	The home phone number associated with the contact.	Any string. You can include spaces and characters. For a contact to be valid in Kibo eCommerce, it must include at least one of the following: HomePhone, MobilePhone, or WorkPhone.
Mobile Phone	The mobile phone number associated with the contact.	Any string. You can include spaces and characters. For a contact to be valid in Kibo eCommerce, it must include at least one of the following: HomePhone, MobilePhone, or WorkPhone.
Work Phone	The work phone number associated with the contact.	Any string. You can include spaces and characters. For a contact to be valid in Kibo eCommerce, it must include at least one of the following: HomePhone, MobilePhone, or WorkPhone.
Address Type	The type of the address, such as Residential or Commercial.	A string matching one of the following: `Residential` `Commercial` `None`
Address1	The first line of the address.	Any string. Character limit: 200.
Address2	The second line of the address.	Any string. Character limit: 200.
Address3	The third line of the address.	Any string. Character limit: 200.
Address4	The fourth line of the address.	Any string. Character limit: 200.
City Or Town	The city or town name for the address.	Any string.
State Or Province	The state, province, or territory for the address, typically expressed as a two-letter code. For example, TX.	Any string. You can enter a location outside the US or Canada.
Postal Or ZipCode	The postal code or zip code for the address.	Any string. This can be a full 9-digit code with a dash or an international postal code.
Country Code	The 2-letter ISO country code for the address.	Any 2-letter country code.
Last Modified Date	The date and time that the contact was last edited, either by the customer or by the system.	A date and time in UTC format.

B2BPurchaseOrderAccounts

Corresponding REST API Resource: commerce/customer/accounts/purchaseOrder

This sheet defines purchase order accounts that are enabled on the B2B account.

Column Name	Description	Valid Values
ExternalId	A unique identifier you can use to refer to the customer in import/export operations or the Kibo eCommerce API. Typically, this is a value that is used by an external program to identify a customer in Kibo eCommerce. This value is not exposed in Admin.	Any string that is unique among all customer accounts.
AccountId	The unique identifier for the customer account.	Any integer that is unique among all customer accounts. Can be the same or different than the Id.
Enabled	Whether purchase orders are enabled as a payment method for the customer account.	`Yes` or `No`.
Credit Limit	The total the customer can spend using purchase orders.	Any decimal amount.
Overdraft Allowance Type	Specifies the type and units of the `overdraftAllowance` amount.	`Amount` — specifies that the overdraft allowance amount is a decimal amount. `Percent` — specifies that the overdraft allowance amount is a percentage amount.
Overdraft Allowance	The total monetary amount or percentage the customer can spend over their purchase order credit limit. The overdraft allowance type controls whether this value is an amount or a percentage.	Any decimal amount.
Available Balance	The available balance the customer has on their purchase order account. This balance is the result of the credit limit minus the customer's total amount due.	Any decimal amount.

B2BPurchaseOrderPaymentTerms

Corresponding REST API Resource: commerce/customer/accounts/purchaseOrder

This sheet allows you to assign payment terms within the B2B account to specific customer accounts.

Column Name	Description	Valid Values
ExternalId	A unique identifier you can use to refer to the customer in import/export operations or the Kibo eCommerce API. Typically, this is a value that is used by an external program to identify a customer in Kibo eCommerce. This value is not exposed in Admin.	Any string that is unique among all customer accounts.
AccountID	The unique identifier for the customer account.	Any integer that is unique among all customer accounts. Can be the same or different than the Id.
SiteId	The unique identifier for a site.	Any number. This number must be unique among your sites.
Site Name	The name of a site.	Any string.
Code	User-defined code that uniquely identifies the payment term.	Any string.

B2BPurchaseOrderTransactions

Corresponding REST API Resource: GetCustomerPurchaseOrderTransactions

This sheet defines purchase order transactions for B2B customer accounts.

Column Name	Description	Valid Values
AccountID	The unique identifier for the customer account.	Any integer that is unique among all customer accounts. Can be the same or different than the Id.
Site Name	The name of a site.	Any string.
Order Number	The order number that the customer sees on the storefront when they place the order.	Any integer that is unique among all order numbers.
Order Type	Specifies how the order was placed.	Either `Offline` or `Online`.
Purchase Order Number	A unique identifier for the purchase order.	Any alphanumeric string.
Transaction Amount	The amount of the purchase order transaction.	Any decimal value. A positive value increases the customer's available balance, while a negative number decreases the available balance.
Transaction Type Id	A number that identifies the type of transaction and displays it within the purchase orders transaction log.	The following list describes the types of transactions each number corresponds to: 1 — `Line of Credit Change` 2 — `Payment Requested` 3 — `Payment Collected` 4 — `Payment Voided` 5 — `Payment Refund` 6 — `Manual Adjustment`
Transaction Description	The string that describes the transaction type in the purchase orders transaction log.	This field is read-only and corresponds to the transaction type ID: 1 — `Line of Credit Change` 2 — `Payment Requested` 3 — `Payment Collected` 4 — `Payment Voided` 5 — `Payment Refund` 6 — `Manual Adjustment`
Author	The author of the purchase order transaction.	A string that corresponds to the Admin user name of the transaction author or to the name of the API version or application that created the transaction.
Transaction Date	The date the transaction took place.	A date. For example, `6/8/2016 7:35:23 PM`.
Additional Transaction Detail	Additional transaction details or notes that you want to associate with the transaction.	Any string.
Credit Limit	The total the customer can spend using purchase orders.	Any decimal amount.
Available Balance	The available balance the customer has on their purchase order account. This balance is the result of the credit limit minus the customer's total amount due.	Any decimal amount.

B2BUsers