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
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

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

List parametric metadata

Request

Lists metadata for parametric, ParametricInfos.

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/ListParametricInfo \
  -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 parametric.

Namestring or null

The Name of the parametric.

Typeinteger or null(int32)

1 = ListValue, 2 = MultiValue, 3 = Value

Enum123
Descriptionstring or null

The Description of the parametric.

Uomstring or null

The unit of measurement of the values.

IsVariantParametricboolean or null

Specifies if the current Parametric is for variants only (true) or for the common product (false).

ValueTypeinteger or null(int32)

1 = Text, 2 = Integer, 3 = Decimal, 4 = Boolean, 5 = Html, 6 = Date

Enum123456
Codestring or null

An externally defined code use to identify this Parametric.

IsHiddenboolean or null

Indicates if the parametric is hidden or not. This can be used to hide parametrics that are only used in application logic. Only non-hidden parametrics should be displayed in the frontend.

IsGlobalboolean or null

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

]
Response
application/json
[ { "Id": 0, "Name": "string", "Type": 1, "Description": "string", "Uom": "string", "IsVariantParametric": true, "ValueType": 1, "Code": "string", "IsHidden": true, "IsGlobal": true } ]

List parametric list values

Request

Reference list of Parametric values.

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/ListParametricValues2 \
  -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 parametric value.

Namestring or null

The Name of the parametric value.

Descriptionstring or null

The Description of the parametric value.

Codestring or null

An externally defined code use to identify this Parametric value.

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.

SortOrderinteger or null(int32)

Can be specified in Norce Admin for each parametric value.

ParametricIdinteger or null(int32)

The internal Id of the Parametric that contains this value.

ParametricCodestring or null

An externally defined code use to identify this Parametric that contains this value.

Typestring or nullDeprecated
]
Response
application/json
[ { "Id": 0, "Name": "string", "Description": "string", "Code": "string", "ImageKey": "9afa8b7e-ca15-438f-a9d6-f679c437e59c", "Type": "string", "SortOrder": 0, "ParametricId": 0, "ParametricCode": "string" } ]

List category focus parametrics

Request

Available focus parametrics on a category. Focus parametrics is used when filtering a ListProduct result set.

Query
categoryIdinteger(int32)

Internal id of category, retrieved from CategoryItem.

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/ListFocusParametrics \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/jsonArray [
Idstring or null

The internal id of the FilterItem. Values are dependent on the type of the filter. This will be the internal id of a catergory if the Filter is a Category filter. Not used for OnHand and Price filters.

Namestring or null
$typestring or null
Enum"FilterItem""FilterBoolItem""FilterPriceItem""FilterListItem""FilterMultiItem""FilterRangeItem"
Discriminator
Valuestring or null

The Value of the FilterItem.

Typestring or null

The Type of the Item. This is the data type, such as int, string, decimal and DateTime.

Uomstring or null

Unit of measurement for the value, if specified.

Countinteger(int32)

A count of SKUs matched by the FilterItem.

Descriptionstring or null

A description of the value.

Codestring or null

A Client specific code for the value.

SortOrderinteger or null(int32)

SortOrder for the FilterItem. Only used for parametric filter values and can be specified in Norce Admin for list values or multi values. Can be used to sort the values. Default sort order is Name.

]
Response
application/json
[ { "Id": "string", "Name": "string", "$type": "FilterItem" } ]

List product parametric groups

Request

Lists all parametric groups for the client.

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/ListParametricGroups \
  -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 parametricGroup.

Namestring or null

The Name of the parametricGroup.

Descriptionstring or null

The Description of the parametricGroup.

Codestring or null

The external Code for the parametricGroup.

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

List product parametrics

Request

Lists Product Parametric values for a product. What parametric values are returned is defined in the primary Category of the product, or if no primary exists, the first category by sort order. If the product does not exist or does not have a category an empty list is returned. Sort order of the parametric values is taken from the order defined for the category.

Query
productIdinteger(int32)

Internal id of the Product.

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/ListProductParametrics \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/jsonArray [
Namestring or null
Idinteger or null(int32)

Internal product parametric id.

ValueIdinteger or null(int32)

Parametric value internal id if the parametric type is single list value.

Descriptionstring or null
ValueDescriptionstring or null
IsPrimaryboolean or null
ValueIdSeedstring or null
Value2string or null

The parametric value, if not a ListValue or a MultiValue parametric.

Uomstring or null

The unit of measurement, if any.

GroupIdinteger or null(int32)

Id of the parametric group.

GroupNamestring or null

Name of the parametric group.

SortOrderinteger or null(int32)

Use this to sort the parametric. The value is fetched from the variant group type's sort order in the first place and then from the category's sort order for the parametric values.

Codestring or null

An external application specific code use to identify this Parametric.

IsHiddenboolean or null

Indicates if the parametric is hidden or not. This can be used to hide parametrics that are only used in application logic. Only non-hidden parametrics should be displayed in the frontend.

Valuestring or nullDeprecated
]
Response
application/json
[ { "Name": "string", "Value": "string", "Id": 0, "ValueId": 0, "Description": "string", "ValueDescription": "string", "IsPrimary": true, "ValueIdSeed": "string", "Value2": "string", "Uom": "string", "GroupId": 0, "GroupName": "string", "SortOrder": 0, "Code": "string", "IsHidden": true } ]

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