COMMERCE SERVICES
/
Product Service
/
Categories

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

Lists categories as defined in Norce. Used for lookup.

Request

Query
cultureCodestring

(Optional) Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/product/1.1/ListCategories \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/jsonArray [
Idinteger or null(int32)

The internal Id of the Entity. This Id might be different in different tiers such as Stage and Production. Use Code if hard coding is required.

Valuestring or null

The Value of the Entity.

Codestring or null

The Code of the Entity, if existing. Use this value when hard coding is required.

]
Response
application/json
[
  {
    "Id": 0,
    "Value": "string",
    "Code": "string"
  }
]

List categories

Request

Navigational structure.

Query
categoryStructureIdstring

(Optional) Specifies which category structure to use. If none is supplied, value is resolved from Application.

levelstring

(Optional) If supplied, only returns structure nodes of specified level.

parentIdstring

(Optional) If supplied, only returns child nodes of specified parent node.

cultureCodestring

(Optional) Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/product/1.1/ListCategoryItems \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/jsonArray [
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
]
Response
application/json
[
  {
    "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": [ … ]
  }
]

List categories by pricelists

Request

Lists categories as defined by the products on the priceLists in Norce.

Query
pricelistSeedstring

Accepts a comma separated string of pricelist internal ids.

statusSeedstring

(Optional) Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

assortmentSeedstring

Accepts a comma separated string of Assortment internal ids. Lookup references in ListAssortments.

categoryStructureIdstring

(Optional) Specifies which category structure to use. If none is supplied, value is resolved from Application.

levelstring

(Optional) If supplied, only returns structure nodes of specified level.

parentIdstring

(Optional) If supplied, only returns child nodes of specified parent node.

cultureCodestring

(Optional) Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/product/1.1/ListCategoryItemsByPricelists \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/jsonArray [
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
]
Response
application/json
[
  {
    "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": [ … ]
  }
]

Search categories

Request

Query
searchStringstring

The string to search for. Searchable fields are code, name, synonyms and unspsc code.

sizestring

(Optional) Number of items to display.

cultureCodestring

(Optional) Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/product/1.1/SearchCategories \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/jsonArray [
Idinteger or null(int32)

The internal Id of the Entity. This Id might be different in different tiers such as Stage and Production. Use Code if hard coding is required.

Valuestring or null

The Value of the Entity.

Codestring or null

The Code of the Entity, if existing. Use this value when hard coding is required.

]
Response
application/json
[
  {
    "Id": 0,
    "Value": "string",
    "Code": "string"
  }
]

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