Skip to content
COMMERCE SERVICES
/
Product Service
/
/
VariantRelations

Documentation ProductService (1.1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
https://customer-slug.api-se.norce.tech/commerce/product/1.1/

Schemas

Schemas

VariantItem

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.

UniqueNamestring

A unique name that can be used in Urls and to get a Product. MaxLength: 500.

{
  "Id": 0,
  "GroupByKey": "string",
  "Name": "string",
  "StatusId": 0,
  "TypeId": 0,
  "PartNo": "string",
  "ManufacturerPartNo": "string",
  "ImageKey": "string",
  "FlagIdSeed": "string",
  "Price": {
    "Value": 0,
    "Recommended": 0,
    "Catalog": 0,
    "VatRate": 0,
    "PriceListId": 0,
    "IsBuyable": true,
    "RecommendedQuantity": 0,
    "IsRecommendedQuantityFixed": true,
    "Standard": 0,
    "ValueIncVat": 0
  },
  "OnHand": {
    "Value": 0,
    "IncomingValue": 0,
    "NextDeliveryDate": "2019-08-24T14:15:22Z",
    "LeadtimeDayCount": 0,
    "LastChecked": "2019-08-24T14:15:22Z",
    "IsActive": true,
    "IsReturnable": true,
    "Info": [ … ]
  },
  "OnHandStore": {
    "Value": 0,
    "IncomingValue": 0,
    "NextDeliveryDate": "2019-08-24T14:15:22Z",
    "LeadtimeDayCount": 0,
    "LastChecked": "2019-08-24T14:15:22Z",
    "IsActive": true,
    "IsReturnable": true,
    "Info": [ … ]
  },
  "OnHandSupplier": {
    "Value": 0,
    "IncomingValue": 0,
    "NextDeliveryDate": "2019-08-24T14:15:22Z",
    "LeadtimeDayCount": 0,
    "LastChecked": "2019-08-24T14:15:22Z",
    "IsActive": true,
    "IsReturnable": true,
    "Info": [ … ]
  },
  "Parametrics": {
    "ListSeed": "string",
    "MultipleSeed": "string",
    "ValueSeed": "string"
  },
  "AdditionalImageKeySeed": "string",
  "EanCode": "string",
  "IsBuyable": true,
  "UnitOfMeasurement": "string",
  "UnitOfMeasurementCount": 0,
  "RecommendedQuantity": 0,
  "IsRecommendedQuantityFixed": true,
  "SubHeader": "string",
  "SubDescription": "string",
  "UniqueName": "string"
}

VariantRelations

Idinteger(int32)

This is the product internal id for the variant

RelationsMetadataArray of objects(RelationMetadataItem)(RelationMetadataItem)

Indicates if the related items are product or variant specific

Relationsobject(ProductItemPagedList)(ProductItemPagedList)
{
  "Id": 0,
  "RelationsMetadata": [
    { … }
  ],
  "Relations": {
    "ItemCount": 0,
    "Items": [ … ]
  }
}

Warehouse

StoreIdinteger or null(int32)

The store internal id for the current store. Can be null if WarehouseId and LocationId are supplied.

WarehouseIdinteger or null(int32)

The internal id for the warehouse. Can be null if StoreId is supplied.

LocationIdinteger or null(int32)

The internal id for the warehouse location. Can be null if StoreId is supplied.

OnHandobject(OnHand)(OnHand)
{
  "StoreId": 0,
  "WarehouseId": 0,
  "LocationId": 0,
  "OnHand": {
    "Value": 0,
    "IncomingValue": 0,
    "NextDeliveryDate": "2019-08-24T14:15:22Z",
    "LeadtimeDayCount": 0,
    "LastChecked": "2019-08-24T14:15:22Z",
    "IsActive": true,
    "IsReturnable": true,
    "Info": [ … ]
  }
}

Assortments

Operations

Categories

Operations

Configurations

Operations

Families

Operations

Files

Operations

Filters

Operations

Flags

Operations

InfoTypes

Operations

Manufacturers

Operations

OnHand

Operations

Parametric

Operations

PriceLists

Operations

Products

Operations

Promotions

Operations

Relations

Operations

Reviews

Operations

SkuTypes

Operations

Status

Operations

Variants

Operations

Warehouses

Operations