Entities and methods to handle baskets and payments.
Entities and methods to handle baskets and payments.
curl -i -X GET \ https://customer-slug.api-se.norce.tech/commerce/shopping/1.1/GetPromotion
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.
{ "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 }
curl -i -X GET \ https://customer-slug.api-se.norce.tech/commerce/shopping/1.1/ListPromotionImageTypes
[ { "Id": 0, "Value": "string", "Code": "string" } ]
curl -i -X GET \ https://customer-slug.api-se.norce.tech/commerce/shopping/1.1/ListPromotionRequirementTypes
[ { "Id": 0, "Value": "string", "Code": "string" } ]
curl -i -X GET \ https://customer-slug.api-se.norce.tech/commerce/shopping/1.1/ListPromotions
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 } ]
Lists all promotions where any BasketItem is either in a requirement or in an effect for the promotion. Fulfilled promotions are excluded from the result. Promotions based on discount codes, customer or company are also excluded. This can be used to display promotions not yet fulfilled in a Checkout.
curl -i -X GET \ 'https://customer-slug.api-se.norce.tech/commerce/shopping/1.1/ListPromotionsByBasket?basketId=0'
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 } ]