Skip to content

Working with Presentation Attributes

The product, ad, and category attributes in eSales can have configured presentation attributes. Attributes can be configured to be displayed by default by configuring the Present status of the attribute to Yes.

Almost all panels accepts the argument presentation_attributes. This argument defines which presentation attributes that will be included or excluded in a result. The argument overrides any default presentation attributes.

If the argument is excluding, the default presentation attributes will be returned except the ones used in the argument. Attributes that are not default are not affected by an excluding argument. An excluding argument has exclude: before the presentation attributes.

Simple format

The standard format for presentation attributes are comma-separated lists. This includes both including and excluding arguments. When using the simple format, eSales will choose attribute type depending on the panel used. For product panels and ads panels it is product attributes, and for category panels it is category attributes.

Individual presentation attributes can not be specified for ads or categories using the simple format. The typed format must be used to specify these attributes.

Example attributes Description
title,author Presentation attributes for title and author will be used for products together with default attributes for ads and categories.
exclude:author,description Presentation attributes author and description will be excluded from the default attributes.

Typed format

The typed format allows for specifying presentation attributes based on entity type. The different entity types are separated by a comma (,) and each entity type is specified as type[comma-separated list of attributes].

It is not possible to use both the simple and the typed format in the same argument.

Example attributes Description
product[title,author] Presentation attributes for title and author will be used for products together with default attributes for ads and categories.
product[title,author],ad[img,link] Presentation attributes for title and author for products will be used together with img and link for ads, and default attributes for categories.
product[title,author],ad[] Presentation attributes for title and author for products will be used together with no attributes for ads, and default attributes for categories.
product[title,author],category[image] Presentation attributes for title and author for products will be used together with default attributes for ads, and the image attribute for categories.
product[exclude:title,author] Exclude presentation attributes for title and author for products but use default attributes for ads and categories.
product[title,author],ad[exclude:img,link] Exclude presentation attributes for img and link for ads but use title and author for products and default attributes for categories.
×