SudoSOS Backend

Appearance

SudoSOS Back-end API / catalogue/products / ProductFilterParameters

Interface: ProductFilterParameters ​

Define product filtering parameters used to filter query results.

Properties ​

alcoholPercentage? ​

ts
optional alcoholPercentage?: number;

Filter based on alcohol percentage.

allowDeleted? ​

ts
optional allowDeleted?: boolean;

Whether to allow deleted products

categoryId? ​

ts
optional categoryId?: number;

Filter based on the product category id.

createdAt? ​

ts
optional createdAt?: Date;

Filter based on created at attribute.

ts
optional featured?: boolean;

Filter on featured products

ownerId? ​

ts
optional ownerId?: number;

Filter based on product owner.

preferred? ​

ts
optional preferred?: boolean;

Filter on preferred products

priceInclVat? ​

ts
optional priceInclVat?: number;

Filter based on product price.

priceList? ​

ts
optional priceList?: boolean;

Filter on shown on narrowcasting screens

productId? ​

ts
optional productId?: number;

Filter based on product id.

productRevision? ​

ts
optional productRevision?: number;

Filter based on product revision.

returnContainers? ​

ts
optional returnContainers?: boolean;

updatedAt? ​

ts
optional updatedAt?: Date;

Filter based on updated at attribute.

vatGroupId? ​

ts
optional vatGroupId?: number;

Filter based on the VAT group id.