COMMERCE SERVICES
/
Product Service
/
Relations

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

List product relation types

Request

Reference list of Product Relation types. The ids in the list can be used as accessoryTypeSeed in calls to ListProductAccessories/ListProductRelations.

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

List product relations

Request

Relations connected to a product. Relations are defined as products that customer could choose to buy in addition to the current product. Supports relations like product to product, product to variant, variant to product and variant to variant.

Query
productIdinteger(int32)

Internal id of current Product.

relationTypeSeedstring

Accepts a comma separated string of Type IDs. Lookup references in ListProductRelationTypes. If empty or null, all types will be used.

statusSeedstring

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

assortmentSeedstring

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

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.

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.

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.

isForAllVariantsboolean

(Optional) Specifies if the result should include all variants or just the one specified as productId. Default is true.

Default true
salesAreaIdinteger(int32)

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

Responses

OK

Bodyapplication/jsonArray [
Idinteger or null(int32)

This is the type internal id for the relation type

Codestring or null

This is the type external code for the relation type

Namestring or null

This is the name of the relation type

Descriptionstring or null

This is the description of the relation type

RelationsMetadataArray of objects or null(RelationMetadataItem)

Indicates if the related items are product or variant specific

Relationsobject or null
VariantRelationsArray of objects or null(VariantRelations)

This is a list of variant relations.

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

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