Sign in

v1

latestOpenAPI 3.0.02026-07-24182211348.4 KB
Filter templates

Create filter template attribute

post/filtertemplate/{filterTemplateId}/attribute

Path parameters

filterTemplateIdinteger required

Id of the filter template to add attribute to

Request body

FilterTemplateIdinteger

Id of the filter template the attribute belongs to

AttributeIdinteger

Id of the attribute

Namestring

The text that is shown above the filter

Collapsibleboolean

Is the attribute collapsible

Collapsedboolean

Is the attribute collapsed by default

NumberOfValuesinteger

Number of values to show

ShowMoreTextstring

Text for show more

ShowLessTextstring

Text for show less

IsMultipleChoiceboolean

Is multiple choice, in case of 'DisplayFilter' being 'checkbox' or 'color'

Logic'OR' | 'AND'

Optional logic in case of 'DisplayFilter' being 'checkbox' or 'color'.

DisplayFilter'Link' | 'Slider' | 'Checkbox' | 'Color' | 'Tree' | 'ClickpointBucketSlider'

Display type of the filter.

NumberOfColumnsinteger

The number of columns

ShowNumberOfProductsboolean

Show the number of products that remains after the value has been selected

ShowIconboolean

Enclose a tag that can be replaced by an image in the front-end application

Sequenceinteger

Sequence of the attribute, if left empty it will be automatically assigned

SortingOfValues'Standard' | 'ProductAmount' | 'Alphabetic' | 'AlphabeticReversed' | 'Derived' | 'Manual' | 'Numerical' | 'NumericalReversed'

The order in which the values of this filter are sorted. By using manual sorting, it is even possible to determine the order

ManualSortingValuesstring[]

Ordered list of values when 'SortingOfValues' is set to 'manual'

ManualBackupSorting'Standard' | 'ProductAmount' | 'Alphabetic' | 'AlphabeticReversed' | 'Derived' | 'Manual' | 'Numerical' | 'NumericalReversed'

Backup sorting method of remaining values when 'SortingOfValues' is set to 'manual'

AlternativeSorting'Standard' | 'ProductAmount' | 'Alphabetic' | 'AlphabeticReversed' | 'Derived' | 'Manual' | 'Numerical' | 'NumericalReversed'

Sorting of values when the filter is expanded

ManualAlternativeSortingValuesstring[]

Ordered list of values when 'AlternativeSorting' is set to 'manual'

ManualBackupAlternativeSorting'Standard' | 'ProductAmount' | 'Alphabetic' | 'AlphabeticReversed' | 'Derived' | 'Manual' | 'Numerical' | 'NumericalReversed'

Backup sorting method of remaining values when 'AlternativeSorting' is set to 'manual'

ShowExplanationboolean

Show explanation/help text for the filter.

Explanationstring

The explanation text to show

ShowFilterboolean

Toggle show filter

ShowFilterPercentageThresholdinteger

If supplied, show filter only when at least the given percentage is achieved for the property 'ae-price'. Between 5 and 100 in increments of 5%

Prefixstring

Prefix

Suffixstring

Suffix

MinDepthinteger

Min depth for category or tree (Attribute source type)

MaxDepthinteger

Max depth for category or tree (Attribute source type)

ShowSelectedFirstboolean

When a value has been selected, this appears at the top of the list, irrespective of the selected sorting

CssClassstring

Custom css class

HideFilterOnlyOneOptionboolean

Hide filter when there is only one option available.

IsClickPointboolean

Is Clickpoint toggle

ClickpointListnumber[]

List of clickpoints for when DisplayFilter is set to 'ClickpointBucketSlider' and IsClickPoint is true.

IsBucketboolean

Is bucket toggle

BucketAmountinteger

Amount of buckets for when DisplayFilter is set to 'ClickpointBucketSlider' and IsBucket is true.

BucketStepSizeinteger

Minimal bucket step size for when DisplayFilter is set to 'ClickpointBucketSlider' and IsBucket is true.

SortAutomaticFilterTemplateboolean

Automatically determine where the filter is placed on the filter template based on usage.

SortAutomaticFilterValuesboolean

Automatically sort the filter values based on usage. If there is not enough data, the ‘sorting the values’ selected below is used.

IsSearchableboolean

Show the search in attributes list

SearchPlaceholderstring

The text that is shown in the search field

SearchNoResultsTextstring

The text that is shown when there are no results

Response

The id of the added attribute

integer required