COMMERCE SERVICES
/
Product Service
/
Schemas
/
Family

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

ErrorMessage_v1_1

Error message for version 1.1

MessageIdinteger or null(int32)

Unique identifier for the message.

Messagestring or null

The error message.

Orchestrationstring or null

Orchestration

TimeStampstring or null(date-time)

The time the error occurred.

Recordstring or null

An xml representation of Messages.

MessagesArray of objects or null(StringStringKeyValuePair)

A dictionary of additional messages or data related to the error.

{
  "MessageId": 0,
  "Message": "string",
  "Orchestration": "string",
  "TimeStamp": "2019-08-24T14:15:22Z",
  "Record": "string",
  "Messages": [
    { … }
  ]
}

Family

Grouping of products cross Categories. It can be use to group products that are related to each other only by name, i.e family.

Idinteger or null(int32)

The internal Id of the Family.

Namestring or null

The Name of the Family.

Descriptionstring or null

The Description of the Family.

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

The external Code of the Family.

{
  "Id": 0,
  "Name": "string",
  "Description": "string",
  "ImageKey": "9afa8b7e-ca15-438f-a9d6-f679c437e59c",
  "Code": "string"
}

File

Idinteger or null(int32)

The internal id of the File.

Typeinteger or null(int32)

The type id of the File. Depending on context and Client. Can be used by Applications to differentiate files for different usages.

Namestring or null

The Name of the File.

Descriptionstring or null

The Description of the File.

Keystring or null(uuid)

A unique id for the File at our image server. Url for images are formed like http://[client specific CDN]/{ImageKey}. Preset, height and width can be sent as parameters.

{
  "Id": 0,
  "Type": 0,
  "Name": "string",
  "Description": "string",
  "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd"
}