Skip to content
COMMERCE SERVICES
/
Product Service
/
Products
/
List best selling products by node (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 best selling products by company

Request

Main product list based on best selling items for a company

Query
customerIdinteger(int32)

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

companyIdinteger(int32)

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

fromDatestring(date-time)required

Orders from this date will only be included in the calculation. Format: yyyy-mm-ddThh:mm:ss.nnn[z], example 2024-08-01T12:59:59.000Z

statusSeedstringrequired

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

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.

sizestring

Number of items to display. Default is 50.

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/ListBestSellingProductsByCompany?fromDate=2019-08-24T14%3A15%3A22Z&statusSeed=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": [
    { … }
  ]
}

List best selling products by node (v2)

Request

Returns the best selling products based on supplied parameters by Navigation Node.

Query
nodeKeystring(guid)required

Key from NavigationNode.

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. If omitted

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/ListBestsellingProductsByNode2?nodeKey=string&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": [
    { … }
  ]
}

List historical best prices

Request

Lists historical best prices for a product going back 30 days.

Query
partNostringrequired

The part number of the Product.

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/ListHistoricalBestPrices?partNo=string'

Responses

Success

Body
Array [
PartNostring

The part number for this product. MaxLength: 50.

PriceListIdinteger(int32)

The pricelist internal id for the price.

Pricenumber(decimal)

The actual price value, excluding VAT.

PriceIncVatnumber(decimal)

The actual price value, including VAT.

VatRatenumber(decimal)

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

Updatedstring(date-time)

Time when this price started to be best price.

]
Response
[
  {
    "PartNo": "string",
    "PriceListId": 0,
    "Price": 0,
    "PriceIncVat": 0,
    "VatRate": 0,
    "Updated": "2019-08-24T14:15:22Z"
  }
]

Promotions

Operations

Relations

Operations

Reviews

Operations

SkuTypes

Operations

Status

Operations

Variants

Operations

Warehouses

Operations