List variant items

This method can be used together with any ListProduct-method to get related variant data when the ListProduct-method is called with asVariants = false. This will enable filtering on variant data in the product list. Just expand on the data needed in the list.

Request
query Parameters
productIds
required
integer <int32>

A list of product internal ids to get variant data for.

statusSeed
required
string

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

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.

expand
string

An expand option that specifies what expansions should be made on the VariantItem entity. Valid values are: None, Price, OnHand, OnHandStore, OnHandSupplier and Parameters. These can be comma separated. Use Full for all. Default is Full. None will return just the VariantItem 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.

Responses
200

Success

500

Internal Server Error

post/ProductService.svc/rest/ListVariantItems
Response samples
[
  • {
    }
]