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

Get a manufacturer

Request

Get a specific manufacturer by internal id.

Query
idinteger(int32)

Internal id for manufacturer.

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

Responses

OK

Bodyapplication/json
Idinteger or null(int32)

The internal Id of the Manufacturer.

Namestring or null

The Name of the Manufacturer.

OrgNostring or null

The organizational number of the Manufacturer.

WebSitestring or null

The url to the Manufacturer's web site.

SupportUrlstring or null

The url to the Manufacturer's support page on their web site.

SupportEmailstring or null

The email address to the Manufacturer's support.

SupportPhonestring or null

The phone number to the Manufacturer's support.

SupportOpenHoursstring or null

The opening hours for the Manufacturer's support.

SupportPolicystring or null

The url to the Manufacturer's support policy web page.

SupportDescriptionstring or null

The url to the Manufacturer's support description web page.

Keystring or null(uuid)

The system wide unique Key of the Manufacturer.

LogoKeystring or null(uuid)

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

UniqueNamestring or null

A unique name that can be used in Urls and to get this entity. GetManufacturer and GetManufacturerByUniqueName gets the same Manufacturer.

LogoPathstring or nullDeprecated
Response
application/json
{ "Id": 0, "Name": "string", "OrgNo": "string", "WebSite": "string", "LogoPath": "string", "SupportUrl": "string", "SupportEmail": "string", "SupportPhone": "string", "SupportOpenHours": "string", "SupportPolicy": "string", "SupportDescription": "string", "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd", "LogoKey": "3d7d7146-aca8-4108-aa6b-ef13bcb3846c", "UniqueName": "string" }

Get a manufacturer by unique name

Request

Get a specific manufacturer by unique name.

Query
uniqueNamestring

Unique name for the manufacturer.

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

Responses

OK

Bodyapplication/json
Idinteger or null(int32)

The internal Id of the Manufacturer.

Namestring or null

The Name of the Manufacturer.

OrgNostring or null

The organizational number of the Manufacturer.

WebSitestring or null

The url to the Manufacturer's web site.

SupportUrlstring or null

The url to the Manufacturer's support page on their web site.

SupportEmailstring or null

The email address to the Manufacturer's support.

SupportPhonestring or null

The phone number to the Manufacturer's support.

SupportOpenHoursstring or null

The opening hours for the Manufacturer's support.

SupportPolicystring or null

The url to the Manufacturer's support policy web page.

SupportDescriptionstring or null

The url to the Manufacturer's support description web page.

Keystring or null(uuid)

The system wide unique Key of the Manufacturer.

LogoKeystring or null(uuid)

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

UniqueNamestring or null

A unique name that can be used in Urls and to get this entity. GetManufacturer and GetManufacturerByUniqueName gets the same Manufacturer.

LogoPathstring or nullDeprecated
Response
application/json
{ "Id": 0, "Name": "string", "OrgNo": "string", "WebSite": "string", "LogoPath": "string", "SupportUrl": "string", "SupportEmail": "string", "SupportPhone": "string", "SupportOpenHours": "string", "SupportPolicy": "string", "SupportDescription": "string", "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd", "LogoKey": "3d7d7146-aca8-4108-aa6b-ef13bcb3846c", "UniqueName": "string" }

List manufacturers

Request

Main manufacturer list. This function will not calculate ProductCount. Use ListManufacturersEx for that.

Query
searchStringstring

(Optional) Free text search string.

pageNostring

(Optional) Page numbers start with 1. Default is 1. If you specify a pageNo outside the range of items, an empty list will be returned. PageSize is mandatory for pageNo to work.

pageSizestring

(Optional) Number of items to display per page. Mandatory if using pageNo.

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

Responses

OK

Bodyapplication/json
ItemCountinteger or null(int32)

The total item count. Can be used to manage paging. Use PageSize to calculate number of pages.

ItemsArray of objects or null(ManufacturerItem)

Current list of ManufacturerItems for the current page if paging is used. Otherwise all items will be in the list.

Response
application/json
{ "ItemCount": 0, "Items": [ { … } ] }

List manufacturers (extended)

Request

Main product list. Same as ListManufacturers but this one will calculate ProductCount. ProductCount is the number of products with an active price in the application's default price list, matching the manufacturer filter in ListProductFilters.

Query
searchStringstring

(Optional) Free text search string on manufacturer.

statusSeedstring

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

assortmentSeedstring

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

asVariantsstring

(Optional) Specifies if the output should be grouped as products or as variants. Default is false which returns a list of products. Set to true if variants are wanted.

pageNostring

(Optional) Page numbers start with 1. Default is 1. If you specify a pageNo outside the range of items, an empty list will be returned. PageSize is mandatory for pageNo to work.

pageSizestring

(Optional) Number of items to display per page. Mandatory if using pageNo.

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

Responses

OK

Bodyapplication/json
ItemCountinteger or null(int32)

The total item count. Can be used to manage paging. Use PageSize to calculate number of pages.

ItemsArray of objects or null(ManufacturerItem)

Current list of ManufacturerItems for the current page if paging is used. Otherwise all items will be in the list.

Response
application/json
{ "ItemCount": 0, "Items": [ { … } ] }

Search manufacturers

Request

Query
searchStringstring

The string to search for. Searchable fields are manufacturerCode, orgNo, name and prefix.

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/SearchManufacturers \
  -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" } ]

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