Price Lists Template - Kibo Documentation

The Price Lists template for the import/export tools describes price lists you have defined for specific customer segments. You can use price lists to offer specific pricing to authenticated customers who belong to specific customer segments.

Price Lists template file content with example data.

Access the Tools

With the Import-Export Application installed and enabled, go to Main > Catalog > Price Lists in the Admin. On the Price Lists page, click the Import/Export extension to the left of the Create New Price List button:

The Pricelists Import/Export button on the Price Lists page

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. 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 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

Pricelists

Corresponding REST API Resource: commerce/catalog/admin/pricelists This sheet describes high-level details about pricelists, such as which customer segments they apply to, what sites they are valid for, and whether they have parent lists. On import operations, use this sheet to create new price lists.

Column Name	Description	Valid Values
Master Catalog Name	The name of the master catalog that includes the price list.	A string matching the name of the master catalog as it appears at System > Structure > Catalogs in Admin.
Price List Name	The name of the price list.	Any string. The maximum length is 100 characters.
PriceList Code	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.
Created By	The unique identifier of the user that created the price list.	A 32-character GUID. This value is system-created and read-only.
Default for Sites	A list of sites for which you want the price list the default. The default price list will be in effect on a site if the resolution logic does not return any applicable price lists for the shopper, for example, if the shopper does not belong to any applicable customer segments.	A list of integers that are valid site IDs. Use commas to separate multiple site IDs.
Description	The description of the price list.	Any string. The maximum length is 300 characters.
Enabled	Specifies whether the price list is currently enabled.	A Boolean value, specified as `Yes` or `No`. The default is `Yes`.
Filtered In Storefront	Specifies whether to only display products in the storefront that have valid price list entries. If `Yes`, customers that belong to price lists will not see any products that do not have price list entries.	A Boolean value, specified as `Yes` or `No`. The default is `No`.
Indexed Sites	A list of sites for which you want the price list indexed.	A list of integers that are valid site IDs. Use commas to separate multiple site IDs.
Mapped Customer Segments	The list of customer segments associated with this price list, specified by segment code.	A list of strings that are valid customer segment codes. Use commas to separate multiple codes.
Parent PriceList Code	If the list has a parent list, the PriceList Code for the parent.	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.
Resolution Rank	Specifies the priority of the price list for situations when a customer segment maps to more than one price list. For example, a list with a Resolution Rank of 1 applies over a list with a Resolution Rank of 3.	Any integer. Warning: Be sure to use a unique Resolution Rank for every price list. Setting multiple price lists to the same Resolution Rank can cause unpredictable behavior.
Resolvable	Specifies whether customer segments can resolve to this price list. If no segments should ever resolve to this price list, such as if it is simply a parent for other price lists, you can improve performance by setting this value to `No`. For example, you might have a “B2B” price list that has sub-lists for each specific business partner. Logged in partners should resolve to their own price list, not to the master “B2B” list. In this situation, the partner lists are resolvable, but B2B is not.	A Boolean value, specified as `Yes` or `No`. The default is `Yes`.
Valid For All Sites	Specifies whether the price list is valid for all sites on your tenant. If `No`, you must specify Valid Sites.	A Boolean value, specified as `Yes` or `No`. The default is `Yes`.
Valid Sites	If Valid For All Sites is `No`, the site IDs for the sites on which the price list is valid.	A list of integers that are valid site IDs. Use commas to separate multiple site IDs.

PricelistEntries

Corresponding REST API Resource: commerce/catalog/admin/pricelists/entries This sheet describes price list entries. An entry ties a product in the master catalog to a price list in the same master catalog. To set a price list price, you must create an entry on this sheet and then specify the price for the entry on the PricelistEntryPrices sheet. On import operations, use this sheet to add entries to a price list.

Column Name	Description	Valid Values
Currency Code	The currency in which to show the price of the product.	Any three-character ISO currency code. For example, `USD`.
Master Catalog Name	The name of the master catalog that includes the price list and the product.	A string matching the name of the master catalog as it appears at System > Structure > Catalogs in Admin.
PriceList Code	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.
Product Code	The code that uniquely identifies the product in the master catalog.	Any string that is a valid product code. Codes can be 3-30 characters, and can contain only alphanumeric characters, hyphens, and underscores.
Start Date	The effective start date for the product to begin appearing in the price list.	A date and time in UTC format. If this value is empty and the End Date is set and has not yet passed, the product appears in the price list.
Cost	If Cost Mode is `Overridden`, specifies the value to use for the product cost in the price list.	Any decimal.
Cost Mode	Specifies the mode used to determine the cost for the product in the price list.	A string matching one of the following: `UseCatalog`—Use the cost from the product entry in the master catalog. `Overridden`—Override the cost from the product entry with the cost specified in the Cost field. The default is `UseCatalog.`
Created By	The unique identifier of the user that created the price list entry.	A 32-character GUID. This value is system-created and read-only.
Discounts Restricted	If `Yes`, specifies to restrict the use of discounts on the product when it appears as part of the price list. If the price list price is already discounted from the normal product price, you can use this field to prevent shoppers from applying additional discounts to the price list price.	A Boolean value, specified as `Yes` or `No`. The default is `No`
Discounts Restricted Mode	Specifies whether to use the default catalog setting for discount restriction, or to override the default catalog setting.	Either `UseCatalog` or `Overriden`.
DiscountsRestricted EndDate	If Discounts Restricted is `Yes`, specifies the end date for the restriction.	A date and time in UTC format. If DiscountsRestricted StartDate is specified and this value is empty, the restriction applies indefinitely.
DiscountsRestricted StartDate	If Discounts Restricted is `Yes`, specifies the start date for the restriction.	A date and time in UTC format. If this value is empty and the DiscountsRestricted EndDate is set and has not yet passed, the restriction applies.
End Date	The effective end date for the product’s inclusion in the price list.	A date and time in UTC format. If this value is empty and no other limiting condition has been met, the product appears in the price list indefinitely.
Is Variation	Specifies whether the product in the price list entry is a product variant.	A Boolean value, either `Yes` or `No`.
Map	If Map Mode is `Overridden`, specifies the value to use for the product MAP price in the price list.	Any decimal.
Map EndDate	The effective end date for MAP pricing. The system ignores the MAP value if this date has passed.	A date and time in UTC format. If Map StartDate is specified and this value is empty, the MAP price applies indefinitely.
Map Mode	Specifies the mode used to determine the MAP pricing for the product in the price list.	A string matching one of the following: `UseCatalog`—Use the MAP pricing from the product entry in the master catalog. `Overridden`—Override the MAP pricing from the product entry with the price specified in the Map field. The default is `UseCatalog`.
Map StartDate	The effective start date for MAP pricing. The system ignores the MAP value if this date is in the future.	A date and time in UTC format. If this value is empty and the Map EndDate is set and has not yet passed, the MAP price applies.
Msrp	If Msrp Mode is `Overridden`, specifies the value to use for the product MSRP in the price list.	Any decimal.
Msrp Mode	Specifies the mode used to determine the MSRP for the product in the price list.	A string matching one of the following: `UseCatalog`—Use the MSRP from the product entry in the master catalog. `Overridden`—Override the MSRP from the product entry with the MSRP specified in the Msrp field. The default is `UseCatalog`.
Option Summary	Shows a summary of the price list entry to help Admin users distinguish product variants.	Any string (Read-only).
PriceList Entry Mode	Specifies whether the current entry is a simple entry or a bulk pricing entry. If `Bulk`, you must specify a Minimum Quantity on the PricelistEntryPrices tab.	A string matching one of the following: `Simple`—The entry is a simple entry. Simple entries just map a product to a price. `Bulk`—The entry is a bulk pricing entry. Bulk entries take the quantity of product ordered into account when determining the price to apply. The default is `Simple`.
Product Name	The name of the product as it appears in the master catalog and on the storefront.	Any string.
PriceList Entry TypeCode	The type of pricelist entry.	Any string.

PricelistEntryPrices

Corresponding REST API Resource: commerce/catalog/admin/pricelists/entries This sheet describes prices to associate with various price list entries. On import operations, use this sheet to define the prices that appear for products in a price list.

Column Name	Description	Valid Values
Currency Code	The currency to use for all product prices (list, sale, MSRP, and so on).	Any three-character ISO currency code. For example, `USD`.
Master Catalog Name	The name of the master catalog that includes the price list.	A string matching the name of the master catalog as it appears at System > Structure > Catalogs in Admin.
Minimum Quantity	The minimum quantity of the product a customer must purchase to get the special pricing.	Any integer. The default is `1`.
PriceList Code	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.
Product Code	The code that uniquely identifies the product in the master catalog.	Any string that is a valid product code. Codes can be 3-30 characters, and can contain only alphanumeric characters, hyphens, and underscores.
Start Date	The effective start date for the product to begin appearing in the price list.	A date and time in UTC format. If this value is empty and the End Date is set and has not yet passed, the product appears in the price list.
ListPrice	If ListPrice Mode is `Overridden`, specifies the value to use for the list price in the price list.	Any decimal.
ListPrice Mode	Specifies the mode used to determine the list price for the product in the price list.	A string matching one of the following: `UseCatalog`—Use the price from the product entry in the master catalog. `Overridden`—Override the price from the product entry with the price specified in the ListPrice field. The default is `UseCatalog`.
SalePrice	If SalePrice Mode is `Overridden`, specifies the value to use for the sale price in the price list.	Any decimal.
SalePriceMode	Specifies the mode used to determine the sale price for the product in the price list.	A string matching one of the following: `UseCatalog`—Use the sale price from the product entry in the master catalog. `Overridden`—Override the sale price from the product entry with the price specified in the SalePrice field. The default is `UseCatalog`.
SubscriptionPrice	If Subscription Price Mode is `Overridden`, specifies the value to use for the subscription price in the price list.	Any decimal.
SubscriptionPriceMode	Specifies the mode used to determine the subscription price for the product in the price list.	A string matching one of the following: `UseCatalog`—Use the price from the product entry in the master catalog.`Overridden`—Override the price from the product entry with the price specified in the SubscriptionPrice field. The default is `UseCatalog`.
SubscriptionSalePrice	If Subscription Sale Price Mode is `Overridden`, specifies the value to use for the subscription sale price in the price list.	Any decimal.
SubscriptionSalePriceMode	Specifies the mode used to determine the subscription sale price for the product in the price list.	A string matching one of the following: `UseCatalog`—Use the price from the product entry in the master catalog.`Overridden`—Override the price from the product entry with the price specified in the SubscriptionSalePrice field. The default is `UseCatalog`.

PricelistEntryExtras

Corresponding REST API Resource: commerce/catalog/admin/pricelists/entries This sheet describes extras to associate with various price list entries. On import operations, use this sheet to define the extras that appear for products in a price list.

Column Name	Description	Valid Values
AttributeFQN	The fully qualified name (FQN) of the attribute in the master catalog. Usually a combination of `tenant` and the Attribute Code, for example `tenant~optional-mount`.	Any string. The string must be unique to a single attribute in the master catalog.
Currency Code	The currency to use for the extra price.	Any three-character ISO currency code. For example, `USD`.
Master Catalog Name	The name of the master catalog that includes the price list.	A string matching the name of the master catalog as it appears at System > Structure > Catalogs in Admin.
Price	Specifies the overridden price to use for the extra.	Any integer value, such as `1` or `3`.
PriceList Code	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.
Product Code	The code that uniquely identifies the product in the master catalog.	Any string that is a valid product code. Codes can be 3-30 characters, and can contain only alphanumeric characters, hyphens, and underscores.
Start Date	The effective start date for the extra to begin appearing in the price list.	A date and time in UTC format. If this value is empty and the End Date is set and has not yet passed, the product appears in the price list.
Value	The actual value for the attribute. This is not the string that a customer sees, but rather the value as it appears in the Value column of the Values table for the attribute in Admin. This value must be unique within the vocabulary for a single attribute and match the DataType of the attribute. If an attribute has multiple values, each Value is specified on a separate row in this sheet.	A string or number. The value cannot contain spaces or special characters. You can use a hyphen (-) to escape spaces or characters.
Attribute Code	The unique code that identifies the attribute in the master catalog.	Any string. The string must be unique to a single attribute in the master catalog.
Display Value	The display value of the extra as it appears on your storefront to shoppers.	Any string.

​Access the Tools

​Supported File Formats

​Template Key

​Sheets

​Pricelists

​PricelistEntries

​PricelistEntryPrices

​PricelistEntryExtras