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.
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.
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.
curl -i -X GET \ 'https://customer-slug.api-se.norce.tech/commerce/product/1.1/ListPromotionProducts?productId=0&statusSeed=string'
[ { "PromotionId": 0, "EffectId": 0, "Items": [ … ] } ]
The internal id of the Product. If the product has variants, any id of the variants can be used.
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.
curl -i -X GET \ 'https://customer-slug.api-se.norce.tech/commerce/product/1.1/ListPromotionsByProductId?id=0&statusSeed=string'
Success
The StartDate of the Promotion, if any. Only valid promotions will be returned.
The EndDate of the Promotion, if any. Only valid promotions will be returned.
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 comma separated list of fulfilled requirements for this promotion. MaxLength: max.
Will contain the discountCode if the promotion has a discountCode requirement. MaxLength: max.
A value of true means the promotion was applied last an not included in any price calculations.
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.
A list of additional images files uploaded for the promotion. Images can be differentiated by using different types. See ListPromotionImageTypes for available types.
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.
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.
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.
Promotion effect quantity or basket discount is multiplied with how many times requirement is fulfilled.
Applied discount amount, including VAT, for this Promotion on this BasketItem.
ExclusivityType allows setting promotions as NotExclusive = 0, Exclusive = 1, or IgnoreExclusivity = 2.
[ { "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": "string", "RequirementSeed": "string", "DiscountCode": "string", "IsExcludedFromPriceCalculation": true, "AllowProductListing": true, "Images": [ … ], "ProductFilters": [ … ], "AppliedAmount": 0, "EffectSeed": "string", "FreightDiscountPct": 0, "IsStackable": true, "AppliedAmountIncVat": 0, "ExclusivityType": 0 } ]
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.
curl -i -X GET \ 'https://customer-slug.api-se.norce.tech/commerce/product/1.1/ListPromotionsByProductUniqueName?statusSeed=string&uniqueName=string'
Success
The StartDate of the Promotion, if any. Only valid promotions will be returned.
The EndDate of the Promotion, if any. Only valid promotions will be returned.
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 comma separated list of fulfilled requirements for this promotion. MaxLength: max.
Will contain the discountCode if the promotion has a discountCode requirement. MaxLength: max.
A value of true means the promotion was applied last an not included in any price calculations.
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.
A list of additional images files uploaded for the promotion. Images can be differentiated by using different types. See ListPromotionImageTypes for available types.
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.
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.
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.
Promotion effect quantity or basket discount is multiplied with how many times requirement is fulfilled.
Applied discount amount, including VAT, for this Promotion on this BasketItem.
ExclusivityType allows setting promotions as NotExclusive = 0, Exclusive = 1, or IgnoreExclusivity = 2.
[ { "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": "string", "RequirementSeed": "string", "DiscountCode": "string", "IsExcludedFromPriceCalculation": true, "AllowProductListing": true, "Images": [ … ], "ProductFilters": [ … ], "AppliedAmount": 0, "EffectSeed": "string", "FreightDiscountPct": 0, "IsStackable": true, "AppliedAmountIncVat": 0, "ExclusivityType": 0 } ]