COMMERCE SERVICES
/
Product Service
/
Schemas
/
CategoryItem

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

CategoryItem

Represents a Category from Norce's navigation structures. This is returned as a tree structure where each node has a list of children.

Idinteger or null(int32)

The internal Id of the Category structure item.

ParentIdinteger or null(int32)

The internal Id of the parent Category structure item.

CategoryIdinteger or null(int32)

The internal Id of the actual Category.

Namestring or null

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

Descriptionstring or null

The Description of the Category.

Levelinteger or null(int32)

The Level of the CategoryItem from the Category structure.

IsDisplayOnlyboolean or null

Indicates if the CategoryItem is just for display or not.

Keystring or null(uuid)

The Key of the Category structure item.

ChildrenArray of objects or null(CategoryItem)

A list of children for the Category structure item.

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.

Codestring or null

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

Synonymsstring or null

Synonyms from the Category in Norce. Can be used when indexing the category in any search engine.

ParametricsArray of objects or null(CategoryParametric)

Parametrics is a list of parameterics defined for the category.

ImagePathstring or nullDeprecated
{
  "Id": 0,
  "ParentId": 0,
  "CategoryId": 0,
  "Name": "string",
  "Description": "string",
  "ImagePath": "string",
  "Level": 0,
  "IsDisplayOnly": true,
  "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
  "Children": [
    {}
  ],
  "ImageKey": "9afa8b7e-ca15-438f-a9d6-f679c437e59c",
  "Code": "string",
  "Synonyms": "string",
  "Parametrics": [
    { … }
  ]
}

CategoryParametric

Represents a parametric defined for a Category.

Idinteger or null(int32)

The internal Id of the Parametric.

Namestring or null

The internal Id of the Parametric.

GroupIdinteger or null(int32)

The internal Id of the ParametricGroup.

GroupNamestring or null

The Name of the ParametricGroup.

SortOrderinteger or null(int32)

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

IsGlobalboolean or null

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

Represents an Item much like any package item. ConfigurationItems contains groups of configurable items instead of fixed items.

PartNostring or null

The PartNo of the ConfigurationItem.

GroupsArray of objects or null(ConfigurationItemGroup)

A list of ConfigurationItemGroups where each group contains selectable items.

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