COMMERCE SERVICES
/
Product Service
/
Schemas
/
VariantItem

Norce Commerce Product v1.1 service (1.1)

The Product namespace has Entities and Operations used for Products and other related Entities such as Prices, Filters, Categories etc. The main use of the Product service is to retrieve product data, variants, prices, and its availability to be used in a webshop or other sales channels. The Product service is read only and does not support creating or updating data in Norce. For this, use the Connect API.

Download OpenAPI description
openapi-v1.json
openapi-v1.yaml
Languages
Servers
Playground

https://{slug}.api-se.playground.norce.tech/commerce/

Stage

https://{slug}.api-se.stage.norce.tech/commerce/

Production

https://{slug}.api-se.norce.tech/commerce/

Assortments

Contains endpoints for viewing metadata about assortment types, not commonly used anymore, still in use by legacy systems.

Operations

Categories

Contains endpoints for looking up category metadata.

Operations

Configurations

Contains endpoints for working with configuration products, not currently in use.

Operations

Families

Contains endpoints for viewing product family metadata, not commonly used anymore, but still needed in legacy systems.

Operations

Files

Contains endpoints for viewing file and image metadata.

Operations

Filters

Contains endpoints for working with ProductFilter navigations. Read more about it here.

Operations

Flags

Contains endpoints for viewing product flag metadata.

Operations

InfoTypes

Contains endpoints for viewing product related extended fields, info types.

Operations

Manufacturers

Contains endpoints for viewing manufacturer information.

Operations

Navigation

Contains endpoints for viewing navigation nodes, not commonly used anymore, still in use by legacy systems.

Operations

OnHand

Contains endpoints for looking up detailed availability information.

Operations

Parametric

Contains endpoints for viewing parametric meta data and parametric data used in comparison views.

Operations

PriceLists

Contains endpoints for viewing price list data and metadata.

Operations

Products

Contains endpoints for listing, finding and viewing products, variants and its content. Read more about this here and here

Operations

Promotions

Contains endpoints for listing products based on promotion associations.

Operations

Relations

Contains endpoints for listing products based on their relations and relation metadata.

Operations

Reviews

Contains endpoints for managing product reviews, not commonly used anymore, still in use by legacy systems.

Operations

SkuTypes

Contains endpoints for looking up product type metadata.

Operations

Status

Contains endpoints for looking up product status metadata.

Operations

Variants

Contains endpoints for listing variants.

Operations

Warehouses

Contains endpoints for viewing warehouse and location information.

Operations

Schemas

StringStringKeyValuePair

Keystring or null
Valuestring or null
{
  "Key": "string",
  "Value": "string"
}

VariantItem

Idinteger or null(int32)

The product internal id for this VariantItem.

GroupByKeystring or null

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.

Namestring or null

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

StatusIdinteger or null(int32)

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

TypeIdinteger or null(int32)

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

PartNostring or null

The partNo for this VariantItem.

ManufacturerPartNostring or null

The manufacturer's partNo for this VariantItem.

ImageKeystring or null(uuid)

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 or null

A comma separated list of flag internal ids.

Priceobject or null
OnHandobject or null

Information about OnHand for a given SKU. There are generally three different types of OnHand in Norce. One for the Web, one for the chosen supplier and one for any specified Store.

OnHandStoreobject or null

Information about OnHand for a given SKU. There are generally three different types of OnHand in Norce. One for the Web, one for the chosen supplier and one for any specified Store.

OnHandSupplierobject or null

Information about OnHand for a given SKU. There are generally three different types of OnHand in Norce. One for the Web, one for the chosen supplier and one for any specified Store.

Parametricsobject or null
AdditionalImageKeySeedstring or null

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

EanCodestring or null

The EAN code for this VariantItem.

IsBuyableboolean or null

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 or null

Short unit of measurement from Norce Admin.

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 or null

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

SubHeaderstring or null

Sub header from the Product in Norce. Only set if Product texts are variant unique.

SubDescriptionstring or null

Sub description from the Product in Norce. Only set if Product texts are variant unique.

UniqueNamestring or null

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

ImageAltTextstring or null

Image alt text for this Variant Item

{
  "Id": 0,
  "GroupByKey": "string",
  "Name": "string",
  "StatusId": 0,
  "TypeId": 0,
  "PartNo": "string",
  "ManufacturerPartNo": "string",
  "ImageKey": "9afa8b7e-ca15-438f-a9d6-f679c437e59c",
  "FlagIdSeed": "string",
  "Price": {
    "Value": 0,
    "Recommended": 0,
    "Catalog": 0,
    "VatRate": 0,
    "PriceListId": 0,
    "IsBuyable": true,
    "RecommendedQuantity": 0,
    "IsRecommendedQuantityFixed": true,
    "Standard": 0,
    "ValueIncVat": 0,
    "CostPurchase": 0,
    "IsDiscountable": true,
    "CurrencyId": 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",
  "ImageAltText": "string"
}

VariantRelations

Variant specific relations for this product.

Idinteger or null(int32)

This is the product internal id for the variant

RelationsMetadataArray of objects or null(RelationMetadataItem)

Indicates if the related items are product or variant specific

Relationsobject or null
{
  "Id": 0,
  "RelationsMetadata": [
    { … }
  ],
  "Relations": {
    "ItemCount": 0,
    "Items": [ … ]
  }
}