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

Promotions

Contains endpoints for listing products based on promotion associations.

Operations

List promotions for a specific product

Request

Lists all promotions where the product is either in a requirement or in an effect for the promotion.

Query
idinteger(int32)

The internal id of the Product. If the product has variants, any id of the variants can be used.

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.

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.

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/ListPromotionsByProductId \
  -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 Promotion.

Namestring or null[ 0 .. 255 ] characters

The Name of the Promotion. MaxLength: 255

Headerstring or null[ 0 .. 255 ] characters

SubHeader from Norce. MaxLength: 255

ShortDescriptionstring or null[ 0 .. 255 ] characters

DescriptionHeader from Norce. MaxLength: 255

Description1string or null

Description from Norce.

Description2string or null

SubDescription from Norce.

StartDatestring or null(date-time)

The StartDate of the Promotion, if any. Only valid promotions will be returned.

EndDatestring or null(date-time)

The EndDate of the Promotion, if any. Only valid promotions will be returned.

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.

RequirementSeedstring or null

A comma separated list of fulfilled requirements for this promotion.

DiscountCodestring or null

Will contain the discountCode if the promotion has a discountCode requirement.

IsExcludedFromPriceCalculationboolean or null

A value of true means the promotion was applied last an not included in any price calculations.

AllowProductListingboolean or null

This flag can be checked to see whether the promotion allows listing of products from requirements. Use Products.ListProductsByPromotionRequirement to list products. Note that if this property is true and no product requirements exists, no products will be listed.

ImagesArray of objects or null(File)

A list of additional images files uploaded for the promotion. Images can be differentiated by using different types. See ListPromotionImageTypes for available types.

ProductFiltersArray of objects or null(PromotionProductFilter)

A list of productFilters for the promotion. Can be used to filter or fetch promotions matched by Products. match the products properties against the filter values Each ProductFilter must match all existing values and if any ProductFilter matches the promotion will be valid for that product.

AppliedAmountnumber or null(decimal)

Applied discount amount, excluding VAT, if fetched on AppliedPromotions property on the basket. In that case it will be the sum of all applied amounts on all Basket.Items. This value is rounded to two decimals.

EffectSeedstring or null

A comma separated list of applicable effects for this promotion.

FreightDiscountPctnumber or null(decimal)

FreightDiscountPct can be used to calculate external freight prices. The value is given as percentage as 100.00 for 100% discount. Only used for FreightDiscounts.

IsStackableboolean or null

Promotion effect quantity or basket discount is multiplied with how many times requirement is fulfilled.

AppliedAmountIncVatnumber or null(decimal)

Applied discount amount, including VAT, for this Promotion on this BasketItem.

ExclusivityTypeinteger or null(int32)

ExclusivityType allows setting promotions as NotExclusive = 0, Exclusive = 1, or IgnoreExclusivity = 2.

ExternalCodestring or null[ 0 .. 255 ] characters

The external code of the Promotion. This is NOT the discount code. MaxLength: 255

]
Response
application/json
[ { "Id": 0, "Name": "string", "Header": "string", "ShortDescription": "string", "Description1": "string", "Description2": "string", "StartDate": "2019-08-24T14:15:22Z", "EndDate": "2019-08-24T14:15:22Z", "ImageKey": "9afa8b7e-ca15-438f-a9d6-f679c437e59c", "RequirementSeed": "string", "DiscountCode": "string", "IsExcludedFromPriceCalculation": true, "AllowProductListing": true, "Images": [ … ], "ProductFilters": [ … ], "AppliedAmount": 0, "EffectSeed": "string", "FreightDiscountPct": 0, "IsStackable": true, "AppliedAmountIncVat": 0, "ExclusivityType": 0, "ExternalCode": "string" } ]

List promotions for a specific product by unique name

Request

Lists all promotions where the product is either in a requirement or in an effect for the promotion.

Query
uniqueNamestring

Unique name of the product to use.

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.

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.

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/ListPromotionsByProductUniqueName \
  -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 Promotion.

Namestring or null[ 0 .. 255 ] characters

The Name of the Promotion. MaxLength: 255

Headerstring or null[ 0 .. 255 ] characters

SubHeader from Norce. MaxLength: 255

ShortDescriptionstring or null[ 0 .. 255 ] characters

DescriptionHeader from Norce. MaxLength: 255

Description1string or null

Description from Norce.

Description2string or null

SubDescription from Norce.

StartDatestring or null(date-time)

The StartDate of the Promotion, if any. Only valid promotions will be returned.

EndDatestring or null(date-time)

The EndDate of the Promotion, if any. Only valid promotions will be returned.

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.

RequirementSeedstring or null

A comma separated list of fulfilled requirements for this promotion.

DiscountCodestring or null

Will contain the discountCode if the promotion has a discountCode requirement.

IsExcludedFromPriceCalculationboolean or null

A value of true means the promotion was applied last an not included in any price calculations.

AllowProductListingboolean or null

This flag can be checked to see whether the promotion allows listing of products from requirements. Use Products.ListProductsByPromotionRequirement to list products. Note that if this property is true and no product requirements exists, no products will be listed.

ImagesArray of objects or null(File)

A list of additional images files uploaded for the promotion. Images can be differentiated by using different types. See ListPromotionImageTypes for available types.

ProductFiltersArray of objects or null(PromotionProductFilter)

A list of productFilters for the promotion. Can be used to filter or fetch promotions matched by Products. match the products properties against the filter values Each ProductFilter must match all existing values and if any ProductFilter matches the promotion will be valid for that product.

AppliedAmountnumber or null(decimal)

Applied discount amount, excluding VAT, if fetched on AppliedPromotions property on the basket. In that case it will be the sum of all applied amounts on all Basket.Items. This value is rounded to two decimals.

EffectSeedstring or null

A comma separated list of applicable effects for this promotion.

FreightDiscountPctnumber or null(decimal)

FreightDiscountPct can be used to calculate external freight prices. The value is given as percentage as 100.00 for 100% discount. Only used for FreightDiscounts.

IsStackableboolean or null

Promotion effect quantity or basket discount is multiplied with how many times requirement is fulfilled.

AppliedAmountIncVatnumber or null(decimal)

Applied discount amount, including VAT, for this Promotion on this BasketItem.

ExclusivityTypeinteger or null(int32)

ExclusivityType allows setting promotions as NotExclusive = 0, Exclusive = 1, or IgnoreExclusivity = 2.

ExternalCodestring or null[ 0 .. 255 ] characters

The external code of the Promotion. This is NOT the discount code. MaxLength: 255

]
Response
application/json
[ { "Id": 0, "Name": "string", "Header": "string", "ShortDescription": "string", "Description1": "string", "Description2": "string", "StartDate": "2019-08-24T14:15:22Z", "EndDate": "2019-08-24T14:15:22Z", "ImageKey": "9afa8b7e-ca15-438f-a9d6-f679c437e59c", "RequirementSeed": "string", "DiscountCode": "string", "IsExcludedFromPriceCalculation": true, "AllowProductListing": true, "Images": [ … ], "ProductFilters": [ … ], "AppliedAmount": 0, "EffectSeed": "string", "FreightDiscountPct": 0, "IsStackable": true, "AppliedAmountIncVat": 0, "ExclusivityType": 0, "ExternalCode": "string" } ]

List products by promotion effect

Request

Lists all products by promotion effect ChooseProducts(2) or AddProduct(5). This allows the product detail page to display what comes with the main product as promoted products.

Query
productIdinteger(int32)

The main product to find promoted products for.

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

Responses

OK

Bodyapplication/jsonArray [
PromotionIdinteger or null(int32)

This is the promotion internal id for which the Products are listed.

EffectIdinteger or null(int32)

This is the effect internal id for which the Products are listed.

ItemsArray of objects or null(ProductItem)

This is the list of Products associated with the promotion and effect.

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

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