The Norce Management API lets you manage configurations and metadata on a client.
The Norce Management API lets you manage configurations and metadata on a client.
https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/
Represents a list model for promotions, including various localized fields and settings, except for requirements and effects. Promotions are used to define discounts and special offers that are automatically applied on baskets during the purchase process.
The default name of the promotion used as fallback when no culture-specific name is available
The sub header of the promotion in the current culture
The default sub header of the promotion used as fallback when no culture-specific sub header is available
The default sub description of the promotion used as fallback when no culture-specific sub description is available
Indicates whether the sub description is inherited from the default culture
The description header of the promotion in the current culture
The default description header of the promotion used as fallback when no culture-specific description header is available
Indicates whether the description header is inherited from the default culture
The default description of the promotion used as fallback when no culture-specific description is available
Indicates whether the description is inherited from the default culture
Exclusive promotion type: NotExclusive, Exclusive, IgnoreExclusivity. Default is NotExclusive
The start date when the promotion becomes active, null means active immediately, if status is Active and start date is in the future the promotion is considered "Coming"
The end date when the promotion expires, null means no end date, if status is Active and end date is in the past the promotion is considered "Ended"
The number of usages left for this promotion, if AllowedUsageCount is set
The number of unique discount codes associated with this promotion
The number of unique discount codes that have been used for this promotion
Indicates whether this promotion can be stacked with itself. If true, multiples of the same promotion can be applied, like 3 for 2 deals (6 for 4, etc.). If false, the promotion can only be applied once per order.
Indicates whether this promotions products can be listed from API calls. If true, products can be listed in a front-end application when building a promotion bundle configuration UI. like choose products to buy with this promotion.
Indicates whether this promotion should be excluded from basket total price, so that other promotions are not validated based on the discounted price from this promotion.
{ "Id": 0, "Name": "string", "DefaultName": "string", "IsNameInherited": true, "SubHeader": "string", "DefaultSubHeader": "string", "IsSubHeaderInherited": true, "SubDescription": "string", "DefaultSubDescription": "string", "IsSubDescriptionInherited": true, "DescriptionHeader": "string", "DefaultDescriptionHeader": "string", "IsDescriptionHeaderInherited": true, "Description": "string", "DefaultDescription": "string", "IsDescriptionInherited": true, "ImageKey": "string", "ImageUrl": "string", "Code": "string", "ExclusivityType": "string", "StartDate": "2019-08-24T14:15:22Z", "EndDate": "2019-08-24T14:15:22Z", "CountLeft": 0, "AllowedUsageCount": 0, "UsageCount": 0, "UniqueUserUsageCount": 0, "UniqueDiscountCodeCount": 0, "UniqueDiscountCodeUsedCount": 0, "TotalOrder": 0, "TotalDiscount": 0, "DiscountPercentage": 0, "MarginPercentage": 0, "IsStackable": true, "IsProductReq": true, "ExcludeFromPriceCalculation": true, "Status": "string", "CurrencyCode": "string", "StoppedDate": "2019-08-24T14:15:22Z", "StoppedBy": 0, "StoppedByName": "string", "Created": "2019-08-24T14:15:22Z", "CreatedByName": "string", "Changed": "string", "ChangedBy": "string", "Cultures": [ { … } ] }
Culture-specific model for promotion translations
Indicates whether the sub description is inherited from the default culture
The description header of the promotion in this culture
Indicates whether the description header is inherited from the default culture
Indicates whether the description is inherited from the default culture
{ "CultureCode": "string", "Name": "string", "IsNameInherited": true, "SubHeader": "string", "IsSubHeaderInherited": true, "SubDescription": "string", "IsSubDescriptionInherited": true, "DescriptionHeader": "string", "IsDescriptionHeaderInherited": true, "Description": "string", "IsDescriptionInherited": true, "IsTranslated": true }
PromotionUniqueDiscountCode model, represents a unique discount code managed for a promotion. Unique discount codes can only be used once. Tracks its creation date, claim status, and associated quotation if claimed.
The unique identifier for the promotion unique discount code
The date and time the unique discount code was claimed, if applicable
The identifier of the quotation associated with the claim, if applicable
{ "DiscountCode": "string", "Created": "2019-08-24T14:15:22Z", "IsClaimed": true, "DateClaimed": "2019-08-24T14:15:22Z", "QuotationId": 0, "ClaimedFromSource": "string" }