Skip to content
COMMERCE SERVICES
/
Product Service
/
Products
/
Search products light (v2)

Documentation ProductService (1.1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers

https://customer-slug.api-se.norce.tech/commerce/product/1.1/

Assortments

Operations

Categories

Operations

Configurations

Operations

Families

Operations

Files

Operations

Filters

Operations

Flags

Operations

InfoTypes

Operations

Manufacturers

Operations

OnHand

Operations

Parametric

Operations

PriceLists

Operations

Products

Operations

List product in family (v2)

Request

Returns other products in the same family for the current product.

Query
productIdinteger(int32)required

The internal product id for which family products are listed.

statusSeedstringrequired

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

assortmentSeedstringrequired

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

storeSeedstring

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

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

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

companyIdstring

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

sortstring

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

Number of items to display.

cultureCodestring

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

currencyIdstring

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

asVariantsstring

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

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

curl -i -X GET \
  'https://customer-slug.api-se.norce.tech/commerce/product/1.1/ListProductsInFamilies2?productId=0&statusSeed=string&assortmentSeed=string'

Responses

Success

Body
ItemCountinteger(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(ProductItem)(ProductItem)
Response
{
  "ItemCount": 0,
  "Items": [
    { … }
  ]
}

Search products light (v2)

Request

Quick search of products, only returns ProductId and Name.

Query
searchStringstringrequired

Free text search string. Minimum of 2 characters required.

statusSeedstringrequired

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

assortmentSeedstringrequired

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

pricelistSeedstring

A comma separated list of PriceList 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

Current Customer.Id, checks for specific customer bound prices.

companyIdstring

Current Company ID, checks for specific company bound prices.

sizestring

Number of items to display.

cultureCodestring

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

currencyIdstring

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

salesAreaIdstring

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

curl -i -X GET \
  'https://customer-slug.api-se.norce.tech/commerce/product/1.1/SearchProductsLite2?searchString=string&statusSeed=string&assortmentSeed=string'

Responses

Success

Body
Array [
Idinteger(int32)

Internal product id.

Namestring

MaxLength: 255.

ManufacturerNamestring

MaxLength: 100.

Pricenumber(decimal)

The best price excluding VAT for the product.

VatRatenumber(decimal)

A rate to multiply with price to get price inc VAT. 25% VAT equals a VatRate of 1.25.

ImageKeystring or null(guid)

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.

UniqueNamestring

A unique name that can be used in Urls and to get a Product. GetProduct and GetProductByUniqueName gets the same Product. MaxLength: 500.

CategoryIdinteger or null(int32)
PriceIncVatnumber(decimal)

The price including VAT calculated on the server side. Should be used to display prices including VAT.

]
Response
[
  {
    "Id": 0,
    "Name": "string",
    "ManufacturerName": "string",
    "Price": 0,
    "VatRate": 0,
    "ImageKey": "string",
    "UniqueName": "string",
    "CategoryId": 0,
    "PriceIncVat": 0
  }
]

Update product view count

Request

Updates the view count for the product. Used when calculating most popular products. Should be called on product detail pages.

Query
categoryIdinteger(int32)required

The category internal id for the product.

productIdinteger(int32)required

Product internal id.

curl -i -X POST \
  'https://customer-slug.api-se.norce.tech/commerce/product/1.1/UpdateProductViewCount?categoryId=0&productId=0'

Responses

Success

Body

Promotions

Operations

Relations

Operations

Reviews

Operations

SkuTypes

Operations

Status

Operations

Variants

Operations

Warehouses

Operations