Skip to content
COMMERCE SERVICES
/
Product Service
/
/
CategoryItem

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

CategoryItem

Idinteger(int32)

The internal Id of the Category structure item.

ParentIdinteger or null(int32)

The internal Id of the parent Category structure item.

CategoryIdinteger(int32)

The internal Id of the actual Category.

Namestring

The Name of the actual Category if the specified so, otherwise it is the Name of the Category structure. MaxLength: 50.

Descriptionstring

The Description of the Category. MaxLength: max.

ImagePathstring

MaxLength: 500. Obsolete! - Use ImageKey

Levelinteger(int32)

The Level of the CategoryItem from the Category structure.

IsDisplayOnlyboolean

Indicates if the CategoryItem is just for display or not.

Keystring(guid)

The Key of the Category structure item.

ChildrenArray of objects(CategoryItem)(CategoryItem)

A list of children for the Category structure item.

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

External code for mapping to the Client's id of this entity. MaxLength: 50.

Synonymsstring

Synonyms from the Category in Storm. Can be used when indexing the category in any search engine. MaxLength: 500.

ParametricsArray of objects(CategoryParametric)(CategoryParametric)

Parametrics is a list of parameterics defined for the category.

{
  "Id": 0,
  "ParentId": 0,
  "CategoryId": 0,
  "Name": "string",
  "Description": "string",
  "ImagePath": "string",
  "Level": 0,
  "IsDisplayOnly": true,
  "Key": "string",
  "Children": [
    {}
  ],
  "ImageKey": "string",
  "Code": "string",
  "Synonyms": "string",
  "Parametrics": [
    { … }
  ]
}

CategoryParametric

Idinteger(int32)

The internal Id of the Parametric.

Namestring

The internal Id of the Parametric. MaxLength: 50.

GroupIdinteger(int32)

The internal Id of the ParametricGroup.

GroupNamestring

The Name of the ParametricGroup. MaxLength: 50.

SortOrderinteger(int32)

Use this to sort the parametric. The value is fetched from the category's sort order for the parametric values.

IsGlobalboolean

Indicates if the parametric is global. If it is set as global it exists on all products in all categories.

{
  "Id": 0,
  "Name": "string",
  "GroupId": 0,
  "GroupName": "string",
  "SortOrder": 0,
  "IsGlobal": true
}

ConfigurationItem

PartNostring

The PartNo of the ConfigurationItem. MaxLength: 50.

GroupsArray of objects(ConfigurationItemGroup)(ConfigurationItemGroup)

A list of ConfigurationItemGroups where each group contains selectable items.

{
  "PartNo": "string",
  "Groups": [
    { … }
  ]
}

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