List products (v2)

Main product list.

Request
query Parameters
searchString
string

Free text search string.

categorySeed
string

Accepts a comma separated string of Category internal ids, retrieved from CategoryItem.

manufacturerSeed
string

Accepts a comma separated string of Manufacturer internal ids.

flagSeed
string

Accepts a comma separated string of Flag internal ids. Lookup references in ListFlags.

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.

parametrics
string

Parametric values formatted as ListParameters = L[ParametricId][ListId], MultiParameters = M[ParametricId][MultipleId], ValueParameters = V[ParametricId]_[ValueFrom]-[ValueTo] with asterisk () as separator. Sample: L10_45M20_254M20_145V60_256-1024*V70_1.4-1.9. The logical operation between values is AND.

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. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

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.

asVariants
string

Specifies if the output should be grouped as products or as variants. Default is false which returns a list of products. Set to true if variants are wanted.

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

400

Bad Request

Key: ResultSetTooLargePagingRequired. Gets raised when a result set is too large (> 1000). Set pageNo and pageSize to avoid this.

500

Internal Server Error

get/ProductService.svc/rest/ListProducts2
Response samples
{
  • "ItemCount": 0,
  • "Items": [
    ]
}