Gets a Product and its optional variants by the uniqueName. The main product will be based on the product with the supplied name, status permitting.
Documentation ProductService (1.1)
https://customer-slug.api-se.norce.tech/commerce/product/1.1/
Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.
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.
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.
Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.
Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.
Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.
https://customer-slug.api-se.norce.tech/commerce/product/1.1/GetProductByUniqueName
- cURL
- JS
- C#
curl -i -X GET \
'https://customer-slug.api-se.norce.tech/commerce/product/1.1/GetProductByUniqueName?uniqueName=string&statusSeed=string'
Success
- application/json
- application/xml
The name of the product. When Product is a VariantType, this will be the value of the variant parameter(s). MaxLength: 255.
Contains the partNo if the product is not a variant or if the product is fetched by PartNo or VariantUniqueName. If the product has a value here then the selected variant can be found by either PartNo or by Id. MaxLength: 50.
If viewed on Product level this will be the product specific files. If viewed on a Variant it will be the variant specific files.
A comma separated list of flag internal ids. If viewed on Product level this will be the product specific flags. If viewed on a Variant it will be the variant specific flags. MaxLength: max.
If viewed on Product level this can be a from-price. It will be the price of the cheapest variant. If viewed on a Variant it will be the variant specific price.
The original price, if specified. Same rules apply as for Price if it is a Product or a Variant.
The rule based price from a priceList, if specified. Same rules apply as for Price if it is a Product or a Variant.
Obsolete! - Use ListDeliveryMethodByProduct if this is required.
A rate to multiply with price to get price inc VAT. 25% VAT equals a VatRate of 1.25.
Indicates the default value used as quantity when buying the product. If IsRecommendedQuantityFixed is true, only multiples of this quantity should be allowed.
A list of variants for this Product, if any. If the Product is itself a variant this will be empty.
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.
A list of this product's parametric values. Only used on variants.
DescriptionHeader for the product as specified in Storm Admin. MaxLength: 255.
A unique name that can be used in Urls and to get a Product. GetProduct and GetProductByUniqueName gets the same Product. MaxLength: 500.
A value that can be used for display logic regarding OnHand.
A list of this product's parametric values. Only Parametric values common to all variants for this product will be here. On Variant level this will contain Parametric values with distinguishing values that are not variant parametric values.
Indicates if the item is buyable or not. Will always be false if the status is closed. An exception will be thrown if IsBuyable is false and an attempt to buy the item is made. The property can be used to hide or show the buy-button. Note that the value can differ for underlying variants.
This will be the EAN code of the selected variant of the product if any. Variants will have this set. MaxLength: 50.
Sku type internal id for this product. Might not be valid if there are variants with different types. Then variants must be examined. Also see ListSkutypes.
A list of categories ordered so the primary category is first.
If this is set to true only multiples of RecommendedQuantity should be allowed.
A value used to sort items based on popularity. Lower values are more popular.
Actual weight or gross weight for the product. As specified in Storm Admin.
Synonyms from the Product in Storm. Can be used when indexing the product in any search engine. MaxLength: 500.
The standard price, if specified. Same rules apply as for Price if it is a Product or a Variant.
A key that can be used to group items on product. It is equal to the ProductId for non-variants and equals 'v'+variantId for variants. Should only be used when fetching product lists as variants. MaxLength: int.
The price including VAT calculated on the server side. Should be used to display prices including VAT.
{ "Id": 0, "Name": "string", "Description": "string", "PartNo": "string", "SubHeader": "string", "Manufacturer": { "Id": 0, "Name": "string", "PartNo": "string", "LogoPath": "string", "LogoKey": "string", "UniqueName": "string" }, "Image": "string", "CampaignImage": "string", "LargeImage": "string", "ThumbnailImage": "string", "Files": [ { … } ], "FlagIdSeed": "string", "Price": 0, "PriceCatalog": 0, "PriceRecommended": 0, "PriceFreight": 0, "PriceFreightVatRate": 0, "VatRate": 0, "RecommendedQuantity": 0, "OnHand": { "Value": 0, "IncomingValue": 0, "NextDeliveryDate": "2019-08-24T14:15:22Z", "LeadtimeDayCount": 0, "LastChecked": "2019-08-24T14:15:22Z", "IsActive": true, "IsReturnable": true, "Info": [ … ] }, "OnHandStore": { "Value": 0, "IncomingValue": 0, "NextDeliveryDate": "2019-08-24T14:15:22Z", "LeadtimeDayCount": 0, "LastChecked": "2019-08-24T14:15:22Z", "IsActive": true, "IsReturnable": true, "Info": [ … ] }, "OnHandSupplier": { "Value": 0, "IncomingValue": 0, "NextDeliveryDate": "2019-08-24T14:15:22Z", "LeadtimeDayCount": 0, "LastChecked": "2019-08-24T14:15:22Z", "IsActive": true, "IsReturnable": true, "Info": [ … ] }, "Variants": [ {} ], "PriceListId": 0, "Key": "string", "Updated": "2019-08-24T14:15:22Z", "NavigationNodeKey": "string", "CategoryId": 0, "CategoryName": "string", "ImageKey": "string", "VariantParametrics": [ { … } ], "StatusId": 0, "MetaTags": "string", "MetaDescription": "string", "VariantName": "string", "DescriptionHeader": "string", "UniqueName": "string", "StockDisplayBreakPoint": 0, "Parametrics": [ { … } ], "Families": [ { … } ], "IsBuyable": true, "SubDescription": "string", "Uom": "string", "UomCount": 0, "EanCode": "string", "Type": 0, "Categories": [ { … } ], "IsRecommendedQuantityFixed": true, "PopularityRank": 0, "CostPurchase": 0, "CostUnit": 0, "Title": "string", "ActualWeight": 0, "CommodityCode": "string", "IsDropShipOnly": true, "Synonyms": "string", "IsSubscribable": true, "UnspscCode": "string", "PriceStandard": 0, "Width": 0, "Height": 0, "Depth": 0, "IsDangerousGoods": true, "HasQuantityBreaks": true, "GroupByKey": "string", "PriceIncVat": 0, "ImageAltText": "string" }
Accepts a comma separated string of Category internal ids, retrieved from CategoryItem.
Accepts a comma separated string of Flag internal ids. Lookup references in ListFlags.
Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.
Accepts a comma separated string of Assortment internal ids. Lookup references in ListAssortments.
Parametric values formatted as ListParameters = L[ParametricId][ListId], MultiParameters = M[ParametricId][MultipleId], ValueParameters = V[ParametricId]_[ValueFrom]-[ValueTo] with asterisk () as separator. Sample: L10_45M20_254M20_145V60_256-1024*V70_1.4-1.9. The logical operation between values is AND.
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
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.
Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.
Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.
Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.
Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.
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.
https://customer-slug.api-se.norce.tech/commerce/product/1.1/ListBestsellingProducts2
- cURL
- JS
- C#
curl -i -X GET \
'https://customer-slug.api-se.norce.tech/commerce/product/1.1/ListBestsellingProducts2?statusSeed=string&assortmentSeed=string'
Success
- application/json
- application/xml
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.
{ "ItemCount": 0, "Items": [ { … } ] }
Customer internal id. Checks for specific customer bound prices if provided.
Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.
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
Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.
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.
Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.
Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.
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.
https://customer-slug.api-se.norce.tech/commerce/product/1.1/ListBestSellingProductsByCompany
- cURL
- JS
- C#
curl -i -X GET \
'https://customer-slug.api-se.norce.tech/commerce/product/1.1/ListBestSellingProductsByCompany?fromDate=2019-08-24T14%3A15%3A22Z&statusSeed=string'
Success
- application/json
- application/xml
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.
{ "ItemCount": 0, "Items": [ { … } ] }