commerce/catalog/admin/pricelists

Use the Price Lists resource to view and create price lists. You can use price lists to override the catalog pricing of products for specific customer segments and/or sites. You can override products' list price, sale price, advanced pricing information such as MSRP, cost, MAP, and the catalog price of any extras associated with the product in a price list. You can also restrict discounts from applying to the overridden product pricing in a price list. Refer to Price Lists in the Guides section for more information about price lists.

JSON Example

PriceList Properties

Property Description
auditInfo

type: auditInfo

Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data.

auditInfo.createBy

type: string

Identifier of the user that created the object. System created and read only.

auditInfo.createDate

type: DateTime

The date and time in UTC format set when the object was created.

auditInfo.updateBy

type: string

Identifier of the user that updated the entity most recently.

auditInfo.updateDate

type: DateTime

The date and time in UTC format the object was updated most recently.

defaultForSites

type: list of int

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. Refer to Default in the Price Lists guides topic for more information.

description

type: string

The localized description in text for the object, displayed per the locale code. For example, descriptions are used for product descriptions, attributes, and pre-authorization transaction types.

enabled

type: bool

Indicates if a capability, function tied to an Arc.js action, application, or price list is enabled for the tenant/site. If true, the capability/application/function/price list is enabled for the tenant. System-supplied and read-only with the exception of functions tied to an Arc.js action and price lists.

filteredInStorefront

type: bool

Indicates whether the price list is exclusive. When a price list is exclusive, shoppers that resolve to the exclusive price list can only view and purchase products that have price entries in the price list and any of its parents. The default is false. Refer to Exclusivity for more information.

indexedSites

type: list of int

A list of site identifiers for which the price list pricing is indexed. Refer to Indexing in the Price Lists guides topic for more information.

mappedCustomerSegments

type: list of string

A list of customer segment codes that Kibo eCommerce uses to determine the shoppers to whom the price list applies. Refer to Resolution in the Price Lists guides topic for more information.

name

type: string

The user supplied name that appears in Admin. You can use this field for identification purposes.

parentPriceListCode

type: string

The code of the price list's parent price list. You can assign each price list a parent price list, which allows each child price list to inherit the parent price list's overridden product pricing. Refer to Inheritance in the Price Lists guides topic for more information.

parentPriceListName

type: string

The user-defined name of the parent price list, if applicable. This value is read-only.

priceListCode

type: string

The unique, user-defined code of the price list.

priceListSequence

type: int

A unique, internal ID of the price list. This property is read-only.

rank

type: int

The resolution rank of the price list that is used to break ties when a customer is applicable for multiple price lists. A lower number represents a higher priority. In order avoid conflicts, Kibo eCommerce recommends setting this property to a unique value. Refer to Resolution Rank in the Price List guides topic for more information.

resolvable

type: bool

Specifies whether the price list is resolvable. When true, Kibo eCommerce is able to apply the price list and its product pricing directly to a shopper. When false, Kibo eCommerce is unable to apply the price list and its product pricing directly to a shopper; however Kibo eCommerce can still apply the price list to a shopper if it is a parent of a resolvable price list. Refer to Resolution in the Price List guides topic for more information.

validForAllSites

type: bool

Specifies whether the price list is valid for all sites associated with the master catalog to which the price list belongs. If this property is true, the validSites property is empty.

validSites

type: list of int

A list of sites for which the price list is valid. If this property contains any entries, the validForAllSites property is false.

Operations

Operation Name Request URI Description
AddPriceList POST %3fresponseFields%3d%7bresponseFields%7d

Adds a new price list to the tenant.

BulkAddPriceListEntries POST bulkaddentries%3fpublishEvents%3d%7bpublishEvents%7d%26invalidateCache%3d%7binvalidateCache%7d

Adds up to 5000 new price list entries in bulk.

BulkDeletePriceListEntries POST bulkdeleteentries%3fpublishEvents%3d%7bpublishEvents%7d%26invalidateCache%3d%7binvalidateCache%7d

Deletes up to 5000 price list entries in bulk.

BulkUpdatePriceListEntries POST bulkupdateentries%3fpublishEvents%3d%7bpublishEvents%7d%26invalidateCache%3d%7binvalidateCache%7d

Updates up to 5000 price list entries in bulk.

DeletePriceList DELETE %7bpriceListCode%7d%3fcascadeDeleteEntries%3d%7bcascadeDeleteEntries%7d

Deletes the specified price list from the tenant.

GetPriceList GET %7bpriceListCode%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves the details of the specified price list.

GetPriceLists GET %3fstartIndex%3d%7bstartIndex%7d%26pageSize%3d%7bpageSize%7d%26sortBy%3d%7bsortBy%7d%26filter%3d%7bfilter%7d%26responseFields%3d%7bresponseFields%7d

Retrieves a list of price lists according to any specified facets, filter criteria, and sort options.

UpdatePriceList PUT %7bpriceListCode%7d%3fresponseFields%3d%7bresponseFields%7d

Updates the details of the specified price list.