# List products by pricelists (v2)

Main product list (v2) and prices based on priceLists.

Endpoint: GET /ListProductsByPriceList2
Version: 1.1

## 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` (string, required)
    Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

  - `assortmentSeed` (string, required)
    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 (M20_254V60_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. Note! customerId is mandatory in combination with companyId.

  - `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 outside the range of items, an empty list will be returned. PageSize is mandatory for pageNo to work.

  - `pageSize` (string)
    Number of items to display per page. Mandatory if using pageNo.

  - `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_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.

  - `expand` (string)
    An expand option that specifies what expansions should be made on the ProductItem2 entity. Valid values are: None, Variants, Price, OnHand, OnHandStore, OnHandSupplier and Parameters. These can be comma separated. Use Full for all. Default is Full. None will return just the ProductItem without expansions.

  - `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.

## Response 200 fields (application/json):

  - `ItemCount` (integer)
    Counts the number of products in the list. When fetched with a method that has filters, this value will be to total after the filters have been applied.

  - `Items` (array)

  - `Items.Id` (integer)
    The product internal id for this ProductItem2.

  - `Items.Key` (string)

  - `Items.Name` (string)
    MaxLength: 255.

  - `Items.Manufacturer` (object)

  - `Items.Manufacturer.Id` (integer)
    Internal id of manufacturer.

  - `Items.Manufacturer.PartNo` (string)
    MaxLength: 50.

  - `Items.Manufacturer.LogoPath` (string)
    MaxLength: 255. Obsolete! - Use ImageKey

  - `Items.Manufacturer.LogoKey` (string,null)
    A unique id for the image at our image server. Url for images are formed like http://[client specific CDN]/{LogoKey}. Preset, height and width can be sent as parameters.

  - `Items.Manufacturer.UniqueName` (string)
    A unique name that can be used in Urls and to get a Manufacturer. GetManufacturer and GetManufacturerByUniqueName gets the same Manufacturer. MaxLength: 255.

  - `Items.CategoryIdSeed` (string)
    A comma separated list of category internal id ordered so the primary category id is first. MaxLength: max.

  - `Items.PartNo` (string)
    Contains the part number of the primary Variant, adhering to manual sorting or if sorting isn't set - by lowest available price. MaxLength: 50.

  - `Items.Price` (object)

  - `Items.Price.Value` (number)
    The actual price value, excluding VAT. Multiply by VatRate to get the price inc VAT.

  - `Items.Price.Recommended` (number,null)
    The rule based price from a priceList, excluding VAT, if specified.

  - `Items.Price.Catalog` (number,null)
    The original price, if specified.

  - `Items.Price.VatRate` (number)
    A rate to multiply with price to get price inc VAT. 25% VAT equals a VatRate of 1.25.

  - `Items.Price.PriceListId` (integer)
    The priceList id for the price. If multiple priceLists are available then the best (lowest) price will be used.

  - `Items.Price.IsBuyable` (boolean)
    Indicates if the item is buyable or not. Will always be false if the status is closed. An exception will be thrown if IsBuyable is false and an attempt to buy the item is made. The property can be used to hide or show the buy-button.

  - `Items.Price.RecommendedQuantity` (number,null)
    Indicates the default value used as quantity when buying the product. If IsRecommendedQuantityFixed is true, only multiples of this quantity should be allowed.

  - `Items.Price.IsRecommendedQuantityFixed` (boolean)
    If this is set to true only multiples of RecommendedQuantity should be allowed.

  - `Items.Price.Standard` (number,null)
    The standard price, excluding VAT, if specified.

  - `Items.Price.ValueIncVat` (number)
    The actual price value including VAT calculated on the server side. Should be used to display prices including VAT.

  - `Items.OnHand` (object)

  - `Items.OnHand.Value` (number)
    The aggregated value from all warehouses and locations in the current context (Web, Supplier or Store).

  - `Items.OnHand.IncomingValue` (number)
    The incoming quantity on the next delivery.

  - `Items.OnHand.NextDeliveryDate` (string,null)
    The next delivery data from supplier to client warehouse.

  - `Items.OnHand.LeadtimeDayCount` (integer,null)
    The number of days it takes to ship from the supplier.

  - `Items.OnHand.LastChecked` (string,null)
    When onHand info was last checked. Null if never.

  - `Items.OnHand.IsActive` (boolean)
    Indicate if the product is stocked in a store.

  - `Items.OnHand.IsReturnable` (boolean)
    Indicate if the product is returnable in a store.

  - `Items.OnHand.Info` (array)
    List of IdValues for the OnHand data for this sku warehouse location combination. This will always be null unless fetched with any of the ProductOnHand methods.

  - `Items.OnHand.Info.Id` (integer)
    The internal Id of the Entity. This Id might be different in different tiers such as Stage and Production. Use Code if hard coding is required.

  - `Items.OnHand.Info.Value` (string)
    The Value of the Entity. MaxLength: max.

  - `Items.OnHand.Info.Code` (string)
    The Code of the Entity, if existing. Use this value when hard coding is required. MaxLength: 255.

  - `Items.OnHandStore` (object)

  - `Items.OnHandSupplier` (object)

  - `Items.Variants` (array)
    The Variants on this ProductItem2. Use expand option Variants to include this property or it will be null.

  - `Items.Variants.Id` (integer)
    The product internal id for this VariantItem.

  - `Items.Variants.GroupByKey` (string)
    A key that group items on product. It is equal to the product id for non-variants and equals 'v'+variantId for variants. Should be used to correlate ProductItems with VariantItems. MaxLength: int.

  - `Items.Variants.Name` (string)
    The Name of this VariantItem. Will be the same as the corresponding product if this is not a Variant. MaxLength: 255.

  - `Items.Variants.StatusId` (integer)
    The status for this VariantItem. Valid values can be found in ListStatuses.

  - `Items.Variants.TypeId` (integer)
    The sku type for this VariantItem. Valid values can be found in ListSkutypes.

  - `Items.Variants.PartNo` (string)
    The partNo for this VariantItem. MaxLength: 50.

  - `Items.Variants.ManufacturerPartNo` (string)
    The manufacturer's partNo for this VariantItem. MaxLength: 50.

  - `Items.Variants.ImageKey` (string,null)
    A unique id for the image at our image server. Url for images are formed like http://[client specific CDN]/{ImageKey}. Preset, height and width can be sent as parameters.

  - `Items.Variants.FlagIdSeed` (string)
    A comma separated list of flag internal ids. MaxLength: max.

  - `Items.Variants.Parametrics` (object)

  - `Items.Variants.Parametrics.ListSeed` (string)
    A comma separated list of parametric values on the format id:value-id. Id is the parametric id and value id is the parametric value id. Use ListParametricInfo to list all parametric info and ListParametricValues2 for all values as lookup when resolving parametric data. MaxLength: max.

  - `Items.Variants.Parametrics.MultipleSeed` (string)
    Same as for ParametricListSeed but any parametric can have multiple values. Use ListParametricInfo to list all parametric info and ListParametricValues2 for all values as lookup when resolving parametric data. MaxLength: max.

  - `Items.Variants.Parametrics.ValueSeed` (string)
    Same as for ParametricListSeed but the value is inlined as id:value. Use ListParametricInfo to list all parametric info and ListParametricValues2 for all values as lookup when resolving parametric data. Parametric with values of type html or text are not supported. MaxLength: max.

  - `Items.Variants.AdditionalImageKeySeed` (string)
    Seed formatted as TypeId[1]:Guid[1], TypeId[2]:Guid[2],.., TypeId[n]:Guid[n]. MaxLength: max.

  - `Items.Variants.EanCode` (string)
    The EAN code for this VariantItem. MaxLength: 50.

  - `Items.Variants.UnitOfMeasurement` (string)
    Short unit of measurement from Storm Admin. MaxLength: 50.

  - `Items.Variants.UnitOfMeasurementCount` (number,null)
    Unit of measurement count

  - `Items.Variants.SubHeader` (string)
    Sub header from the Product in Storm. Only set if Product texts are variant unique. MaxLength: 255.

  - `Items.Variants.SubDescription` (string)
    Sub description from the Product in Storm. Only set if Product texts are variant unique. MaxLength: max.

  - `Items.Variants.UniqueName` (string)
    A unique name that can be used in Urls and to get a Product. MaxLength: 500.

  - `Items.UniqueName` (string)
    A unique name that can be used in Urls and to get a Product. GetProduct and GetProductByUniqueName gets the same Product. MaxLength: 500.

  - `Items.SubHeader` (string)
    Sub header from the Product in Storm. MaxLength: 255.

  - `Items.SubDescription` (string)
    Sub description from the Product in Storm. MaxLength: max.

  - `Items.Synonyms` (string)
    Synonyms from the Product in Storm. Can be used when indexing the product in any search engine. MaxLength: 500.

  - `Items.StockDisplayBreakPoint` (integer,null)
    A value that can be used for display logic regarding OnHand.

  - `Items.IsSubscribable` (boolean)
    True if this product can be added in a Subscription. False otherwise.

  - `Items.PopularityRank` (integer,null)
    A value used to sort items based on popularity. Lower values are more popular.

  - `Items.SortOrder` (integer,null)
    A custom sort order that can be used when the product item is in a list. The sort order is defined for the primary category of the product item.

  - `Items.Updated` (string,null)

  - `Items.ImageAltText` (string)
    Default image alt text