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

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

List products by ids (v3)

Request

Main product list.

Query
idSeedstring

Accepts a comma separated string of Product IDs.

statusSeedstring

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

storeSeedstring

(Optional) Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

(Optional) A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

(Optional) Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

(Optional) Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

(Optional) Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

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.

filterstring

(Optional) Property values to filter on. The return value's ItemCount will be the number of items after filters have been applied. General format: 'filterName|value specification'. See Filter.Name for valid values and the different Filter entities for value specifications. Sample: catf|11946,11947;mfrf|7276;ohf|true;flgf|42,46;prcf|true_10-20;parf|L6360_13239M6355_3387M6355_3390!V60_256-1024*V70_1.4-1.9. The logical operator between comma separated values in catf, mfrf and flgf is OR while parf values use AND.

cultureCodestring

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

currencyIdstring

(Optional) Specifies in which currency to display prices. Uses Norce internal ids. If none is supplied, value is resolved from Application.

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. Only specified ids will be returned if returnAllVariants is set to false. Set returnAllVariants to true to return all.

returnAllVariantsstring

(Optional) Specifies if the result should include all variants or just the specified. Default is false.

salesAreaIdstring

(Optional) Specifies the SalesArea to use. Uses Norce internal ids. If none is supplied, primary SalesArea on Application will be used.

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

Responses

OK

Bodyapplication/json
ItemCountinteger or null(int32)

Counts the number of products in the list. If the list is fetched with AsVariants set to true ItemCount will still just count the number of products. Not items in the list. When fetched with a method that has filters, this value will be to total after the filters have been applied.

ItemsArray of objects or null(ProductItem)

List of ProductItems. It is used in lists.

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

List products by part numbers

Request

Main product list.

Query
partNoSeedstring

Accepts a comma separated string of partNos.

statusSeedstring

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

storeSeedstring

(Optional) Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

(Optional) A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

(Optional) Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

(Optional) Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

(Optional) Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

cultureCodestring

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

currencyIdstring

(Optional) Specifies in which currency to display prices. Uses Norce internal ids. If none is supplied, value is resolved from Application.

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. Only specified ids will be returned if returnAllVariants is set to false. Set returnAllVariants to true to return all.

returnAllVariantsstring

(Optional) Specifies if the result should include all variants or just the specified. Default is false.

salesAreaIdstring

(Optional) Specifies the SalesArea to use. Uses Norce internal ids. If none is supplied, primary SalesArea on Application will be used.

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

Responses

OK

Bodyapplication/json
ItemCountinteger or null(int32)

Counts the number of products in the list. If the list is fetched with AsVariants set to true ItemCount will still just count the number of products. Not items in the list. When fetched with a method that has filters, this value will be to total after the filters have been applied.

ItemsArray of objects or null(ProductItem)

List of ProductItems. It is used in lists.

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

List product variants by product ids

Request

Returns all variants for the product as a ProductItemList.

Query
productIdinteger(int32)

Accepts a comma separated string of Product IDs.

statusSeedstring

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

storeSeedstring

(Optional) Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

(Optional) A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

(Optional) Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

(Optional) Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

(Optional) Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

cultureCodestring

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

currencyIdstring

(Optional) Specifies in which currency to display prices. Uses Norce internal ids. If none is supplied, value is resolved from Application.

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.

salesAreaIdstring

(Optional) Specifies the SalesArea to use. Uses Norce internal ids. If none is supplied, primary SalesArea on Application will be used.

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

Responses

OK

Bodyapplication/json
ItemCountinteger or null(int32)

Counts the number of products in the list. If the list is fetched with AsVariants set to true ItemCount will still just count the number of products. Not items in the list. When fetched with a method that has filters, this value will be to total after the filters have been applied.

ItemsArray of objects or null(ProductItem)

List of ProductItems. It is used in lists.

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

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