commerce/catalog/storefront/pricelists

Retrieves the details of a price list. The details may contain a hierarchy of ancestor and/or descendant price lists dependening on your configuration.

JSON Example

PriceList Properties

Property Description
ancestors

type: list of priceListNode

A list of price lists and their details that describe the ancestor/parent hierarchy of the current price list. Each price list within this list is an ancestor/parent of the current price list. An ancestor/parent price list can have it's own ancestor/parent, which is denoted by priceListNode.parentPriceListId.

priceListNode.parentPriceListId

type: int

Specifies the id of the price list's parent within the ancestor/descendant hierarchy, if applicable.

priceListNode.priceListCode

type: string

Specifies the code of the price list within the ancestor/descendant hierarchy, if applicable.

priceListNode.priceListId

type: int

Specifies the internal id of the price list within the ancestor/descendant hierarchy, if applicable.

priceListNode.priceListLevel

type: int

Denotes the place of the ancestor/descendant within the hierarchy. A value of 1 is the closest ancestor/descendant to the current price list. For example an ancestor that has a value of 1 is the direct parent of the current price list.

descendants

type: list of priceListNode

A list of price lists and their details that describe the descendant/child hierarchy of the current price list. Each price list within this list is an descendant/child of the current price list. A descendant/child price list can have it's own descendant/child, which is denoted by priceListNode.parentPriceListId.

priceListNode.parentPriceListId

type: int

Specifies the id of the price list's parent within the ancestor/descendant hierarchy, if applicable.

priceListNode.priceListCode

type: string

Specifies the code of the price list within the ancestor/descendant hierarchy, if applicable.

priceListNode.priceListId

type: int

Specifies the internal id of the price list within the ancestor/descendant hierarchy, if applicable.

priceListNode.priceListLevel

type: int

Denotes the place of the ancestor/descendant within the hierarchy. A value of 1 is the closest ancestor/descendant to the current price list. For example an ancestor that has a value of 1 is the direct parent of the current price list.

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.

isIndexed

type: bool

Specifies whether the price list is indexed for the site.

isSiteDefault

type: bool

Specifies whether the price list is the default price list for the site. Refer to Default 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.

priceListCode

type: string

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

priceListId

type: int

The internal identifier of the price list.

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 Lists guides topic for more information.

validSites

type: list of int

A list of site identifiers for which the price list is valid.

Operations

Operation Name Request URI Description
GetPriceList GET %7bpriceListCode%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves the details of the specified price list.

GetResolvedPriceList GET resolved%3fcustomerAccountId%3d%7bcustomerAccountId%7d%26responseFields%3d%7bresponseFields%7d

Retrieves the details of a price list to which the specified customer resolves. This is primarly used when creating an offline order for a shopper.

You can use this operation alongside custom Arc.js actions to alter the price list to which a shopper resolves.