List variant items

Request

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.

Query

productIdsinteger(int32)required

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

statusSeedstringrequired

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

parametricsstring

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.

storeSeedstring

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.

pricelistSeedstring

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.

customerIdstring

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

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

expandstring

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.

cultureCodestring

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

currencyIdstring

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

curl -i -X POST \
  'https://customer-slug.api-se.norce.tech/commerce/product/1.1/ListVariantItems?productIds=0&statusSeed=string'

Responses

Success

Body

Array [

Idinteger(int32)

The product internal id for this VariantItem.

GroupByKeystring

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.

Namestring

The Name of this VariantItem. Will be the same as the corresponding product if this is not a Variant. MaxLength: 255.

StatusIdinteger(int32)

The status for this VariantItem. Valid values can be found in ListStatuses.

TypeIdinteger(int32)

The sku type for this VariantItem. Valid values can be found in ListSkutypes.

PartNostring

The partNo for this VariantItem. MaxLength: 50.

ManufacturerPartNostring

The manufacturer's partNo for this VariantItem. MaxLength: 50.

ImageKeystring or null(guid)

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.

FlagIdSeedstring

A comma separated list of flag internal ids. MaxLength: max.

Priceobject(ProductPrice)(ProductPrice)

OnHandobject(OnHand)(OnHand)

OnHandStoreobject(OnHand)(OnHand)

OnHandSupplierobject(OnHand)(OnHand)

Parametricsobject(ParametricsSeed)(ParametricsSeed)

AdditionalImageKeySeedstring

Seed formatted as TypeId[1]:Guid[1], TypeId[2]:Guid[2],.., TypeId[n]:Guid[n]. MaxLength: max.

EanCodestring

The EAN code for this VariantItem. MaxLength: 50.

IsBuyableboolean

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.

UnitOfMeasurementstring

Short unit of measurement from Storm Admin. MaxLength: 50.

UnitOfMeasurementCountnumber or null(decimal)

Unit of measurement count

RecommendedQuantitynumber or null(decimal)

Indicates the default value used as quantity when buying the product. If IsRecommendedQuantityFixed is true, only multiples of this quantity should be allowed.

IsRecommendedQuantityFixedboolean

If this is set to true only multiples of RecommendedQuantity should be allowed.

SubHeaderstring

Sub header from the Product in Storm. Only set if Product texts are variant unique. MaxLength: 255.

SubDescriptionstring

Sub description from the Product in Storm. Only set if Product texts are variant unique. MaxLength: max.

]

Response

[
  {
    "Id": 0,
    "GroupByKey": "string",
    "Name": "string",
    "StatusId": 0,
    "TypeId": 0,
    "PartNo": "string",
    "ManufacturerPartNo": "string",
    "ImageKey": "string",
    "FlagIdSeed": "string",
    "Price": { … },
    "OnHand": { … },
    "OnHandStore": { … },
    "OnHandSupplier": { … },
    "Parametrics": { … },
    "AdditionalImageKeySeed": "string",
    "EanCode": "string",
    "IsBuyable": true,
    "UnitOfMeasurement": "string",
    "UnitOfMeasurementCount": 0,
    "RecommendedQuantity": 0,
    "IsRecommendedQuantityFixed": true,
    "SubHeader": "string",
    "SubDescription": "string"
  }
]

Documentation ProductService (1.1)

Assortments

Categories

Configurations

Families

Files

Filters

Flags

InfoTypes

Manufacturers

Navigation

OnHand

Parametric

PriceLists

Products

Promotions

Relations

Reviews

SkuTypes

Status

Variants