Skip to content
COMMERCE SERVICES
/
Product Service
/
/
Family

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

ConfigurationItemGroupItem

ProductIdinteger(int32)

The internal product id of the Product.

PartNostring

The PartNo of the Product. MaxLength: 50.

Namestring

The Name of the Product. When Product is a VariantType, this will be the value of the variant parameter(s). MaxLength: 255.

Descriptionstring

The Description of the Product. MaxLength: max.

SortOrderinteger(int32)

The SortOrder of the Item within the group.

Quantitynumber(decimal)

The Quantity of the Item.

Pricenumber(decimal)

The Price of the Item.

PriceListIdinteger(int32)

The internal pricelist id of the Item.

VatRatenumber(decimal)

A rate to multiply with price to get price inc VAT. 25% VAT equals a VatRate of 1.25.

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.

UniqueNamestring

A unique name that can be used in Urls and to get a Product. GetProduct and GetProductByUniqueName gets the same Product. MaxLength: 500.

{
  "ProductId": 0,
  "PartNo": "string",
  "Name": "string",
  "Description": "string",
  "SortOrder": 0,
  "Quantity": 0,
  "Price": 0,
  "PriceListId": 0,
  "VatRate": 0,
  "ImageKey": "string",
  "UniqueName": "string"
}

Family

Idinteger(int32)

The internal Id of the Family.

Namestring

The Name of the Family. MaxLength: 50.

Descriptionstring

The Description of the Family. MaxLength: max.

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.

Codestring

The external Code of the Family. MaxLength: 50.

{
  "Id": 0,
  "Name": "string",
  "Description": "string",
  "ImageKey": "string",
  "Code": "string"
}

Filter

Namestring

The Name of the filter. Available names are: catf, mfrf, flgf, ohf, prcf and parf. These are a short notation of the actual types. Used in filter specifications as filter name. MaxLength: 50.

Typestring

The Type of the filter. Available types are: Category, Manufacturer, Flag, OnHand, Price and Parametric. MaxLength: 50.

ItemsArray of objects(IFilterItem)(IFilterItem)

A list of specific FilterItems for the Filter. The items are the actual values for each type of Filter.

{
  "Name": "string",
  "Type": "string",
  "Items": [
    { … }
  ]
}

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