commerce/catalog/admin/pricelists/entries

Use the Entries sub-resource to interact with price list entries. Price list entries enable you to override product pricing as well as control what products shoppers can view and purchase when the price list is exclusive. Refer to the Price Lists guides topic for more information.

JSON Example

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

cost

type: decimal

The cost of the product to the retailer, as specified through API or using the Cost field of the Product editor in Admin. This is not the price that the shopper sees on the storefront (which is usually higher).

For price lists entries, this property specifies the cost of the product if costMode is set to Overridden.

costMode

type: string

Specifies whether the product's cost is the default catalog cost or is overridden. If this property is set to Overridden, cost cannot not be null.

This property has the following valid values:

  • UseCatalog
  • Overridden

currencyCode

type: string

The localized currency code for the monetary amount.

discountsRestricted

type: bool

Indicates if the discount is restricted. If true, the system cannot apply any discounts to this product. Discount restrictions are defined at the master catalog level. Client administrators cannot override discount restrictions at the catalog level, but they can limit the restriction to a defined time interval.

For price list entries, specifies whether discounts are restricted for the specific entry if discountRestrictedMode is set to Overridden.

Refer to Discount Restriction in the Price Lists guides topic for more information.

discountsRestrictedEndDate

type: DateTime

The date and time on which the discount restriction period ends.

discountsRestrictedMode

type: string

Specifies whether to use the default catalog setting for discount restriction, or to override the default catalog setting.

Refer to Discount Restriction in the Price Lists guides topic for more information.

This property has the following valid values:

  • UseCatalog
  • Overridden

discountsRestrictedStartDate

type: DateTime

The date and time on which the discount restriction period starts.

endDate

type: DateTime

Specifies the date in UTC format when the price list entry is no longer in effect. This property is optional.

extraEntries

type: list of priceListEntryExtra

A list of product extras associated with the price list entry.

Refer to Extras in the Price Lists guides topic for more information.

priceListEntryExtra.attributeCode

type: string

Merchant-defined code for an extensible attribute. This code may be used to generate an object's fully qualified name, such as for products.

priceListEntryExtra.attributeFQN

type: string

The fully qualified name of the attribute. The attributeDefiniteId may be used to generate this name.

priceListEntryExtra.attributeName

type: string

Name of attribute that this extra is based on. ReadOnly

priceListEntryExtra.displayValue

type: string

Value to display. Currently only vaild when Value is a string type. ReadOnly

priceListEntryExtra.price

type: decimal

The price of either the product or shipping.

This amount can be affected by discounts and/or fees. For products, this amount can also be affected by price lists.

priceListEntryExtra.value

type: object

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

isVariation

type: bool

Specifies whether the product in the price list entry is a product variant.

Refer to Configurable Products with Options in the Price Lists guides topic for more information.

map

type: decimal

The minimum advertised price (MAP) of the product, if mapMode is set to Overridden.

mapEndDate

type: DateTime

The date the price list entry's map is no longer in effect.

mapMode

type: string

Specifies whether to use the product's default catalog map, or to override the product's default catalog map.

This property has the following valid values:

  • UseCatalog
  • Overridden

mapStartDate

type: DateTime

The date the price list entry's map takes effect.

msrp

type: decimal

The manufacturer's suggested retail price (MSRP) for the product. This content may be defined by the supplier.

msrpMode

type: string

Specifies whether to use the product's default catalog msrp, or to override the product's default catalog msrp.

options

type: list of productOption

List of option attributes configured for an object. These values are associated and used by products, product bundles, and product types.

productOption.attributeFQN

type: string

The fully qualified name of the attribute. The attributeDefiniteId may be used to generate this name.

productOption.values

type: list of productOptionValue

List of value data for objects.

productOption.productOptionValue.attributeVocabularyValueDetail

type: attributeVocabularyValue

Properties of an individual vocabulary value for an attribute. For example, a "color" attribute might have the following vocabulary values: Red, Blue, Green.

productOption.productOptionValue.attributeVocabularyValue.content

type: attributeVocabularyValueLocalizedContent

Localizable content (such as a name and/or description) for an attribute. The content may be localized when displayed according to the locale code specified by the master catalog. Content can include descriptive text for product extensible attributes, catalog-level descriptions (displayed if isContentOverriden is true), product bundles, and customer account notes.

productOption.productOptionValue.attributeVocabularyValue.attributeVocabularyValueLocalizedContent.localeCode

type: string

The two character locale code, per the country code provided. This code determines the localized content to use and display.

productOption.productOptionValue.attributeVocabularyValue.attributeVocabularyValueLocalizedContent.stringValue

type: string

If the object value is a String, this value provides that string value, used by vocabulary property values, products, and options.

productOption.productOptionValue.attributeVocabularyValue.displayOrder

type: int

The order in which the attribute value displays. If you omit a value for this property, Kibo eCommerce infers the display order from the attribute value's position the list.

productOption.productOptionValue.attributeVocabularyValue.localizedContent

type: list of attributeVocabularyValueLocalizedContent

The localized content associated with the object.

productOption.productOptionValue.attributeVocabularyValue.attributeVocabularyValueLocalizedContent.localeCode

type: string

The two character locale code, per the country code provided. This code determines the localized content to use and display.

productOption.productOptionValue.attributeVocabularyValue.attributeVocabularyValueLocalizedContent.stringValue

type: string

If the object value is a String, this value provides that string value, used by vocabulary property values, products, and options.

productOption.productOptionValue.attributeVocabularyValue.productName

type: string

The name of the product that represents a line item in a taxable order or product bundle.

productOption.productOptionValue.attributeVocabularyValue.value

type: object

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

productOption.productOptionValue.attributeVocabularyValue.valueSequence

type: int

The number that denotes the order of the entity value within a list of entity values.

productOption.productOptionValue.value

type: object

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

priceEntries

type: list of priceListEntryPrice

A list of product pricing information associated with the price list entry.

priceListEntryPrice.listPrice

type: decimal

The product's list price if priceListEntryPrice.listPriceMode is set to Overridden.

priceListEntryPrice.listPriceMode

type: string

Specifies whether to use the product's default catalog list price, or to override the product's default catalog list price.

This property has the following valid values:

  • UseCatalog
  • Overridden

priceListEntryPrice.minQty

type: int

This property is for future price list entry functionality and currently should always be 1.

priceListEntryPrice.salePrice

type: decimal

The set sale price for a product consisting of a price with a discount already applied.

For price list entries, this property is the product's sale price if the priceListEntryPrice.salePriceMode is set to Overridden.

priceListEntryPrice.salePriceMode

type: string

Specifies whether to use the product's default catalog sale price, or to override the product's default catalog sale price.

This property has the following valid values:

  • UseCatalog
  • Overridden

priceListCode

type: string

External unique identifier of the Price List. Must be unique an only contain url sanitized characters. The max length is 50.

priceListEntryMode

type: string

This property is for future price list functionality and currently should always be Simple.

priceListEntrySequence

type: int

This property is used for referencing the price list entry. Read-only.

priceListEntryTypeCode

type: string

The unique identifier of the price list entry type.

productCode

type: string

The unique, user-defined product code of a product, used throughout Kibo eCommerce to reference and associate to a product.

productName

type: string

The name of the product that represents a line item in a taxable order or product bundle.

startDate

type: DateTime

Specifies the date and time in UTC format when the price list entry is in effect.

Operations

Operation Name Request URI Description
AddPriceListEntry POST %7bpriceListCode%7d%2fentries%3fresponseFields%3d%7bresponseFields%7d

Adds a new price list entry to the specified price list.

DeletePriceListEntry DELETE %7bpriceListCode%7d%2fentries%2f%7bproductCode%7d%2f%7bcurrencyCode%7d%3fstartDate%3d%7bstartDate%7d

Deletes a price list entry.

GetPriceListEntries GET %7bpriceListCode%7d%2fentries%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 list entries associated with the specified price list according to any specified facets, filter criteria, and sort options.

GetPriceListEntry GET %7bpriceListCode%7d%2fentries%2f%7bproductCode%7d%2f%7bcurrencyCode%7d%3fstartDate%3d%7bstartDate%7d%26responseFields%3d%7bresponseFields%7d

Retrieves the details of a price list entry.

UpdatePriceListEntry PUT %7bpriceListCode%7d%2fentries%2f%7bproductCode%7d%2f%7bcurrencyCode%7d%3fstartDate%3d%7bstartDate%7d%26responseFields%3d%7bresponseFields%7d

Updates the details of a price list entry.