List filter values by specific product

Returns a list of filter values for the product id. The list can be used to filter products client side.

Request
query Parameters
productId
required
integer <int32>

Accepts an integer product internal id.

statusSeed
required
string

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

assortmentSeed
required
string

Accepts a comma separated string of Assortment internal ids. Lookup references in ListAssortments.

storeSeed
string

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeed
string

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerId
string

Customer internal id. Checks for specific customer bound prices if provided.

companyId
string

Company internal id. Checks for specific company bound prices if provided.

sort
string

Sort order as formatted [Property] [Asc/Desc] with comma as separator. Sample: Field1 Asc, Field2 Desc.

pageNo
string

Page numbers start with 1. Default is 1. If you specify a pageNo out side the range of items, an empty list will be returned.

pageSize
string

Number of items to display per page.

filter
string

Property values to filter on. The return value's ItemCount will be the number of items after filters have been applied. General format: 'filterName|value specification'. See Filter.Name for valid values and the different Filter entities for value specifications. Sample: catf|11946,11947;mfrf|7276;ohf|true;flgf|42,46;prcf|true_10-20;parf|L6360_13239M6355_3387M6355_3390!V60_256-1024*V70_1.4-1.9. The logical operator between comma separated values in catf, mfrf and flgf is OR while parf values use AND.

cultureCode
string

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

currencyId
string

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

salesAreaId
string

Specifies the SalesArea to use. Uses Storm internal ids. If none is supplied, primary SalesArea on Application will be used.

Responses
200

Success

500

Internal Server Error

get/ProductService.svc/rest/ListProductItemFilterValuesById
Response samples
[
  • {
    }
]