Skip to content
MANAGEMENT API (BETA)
/
/
PromotionModel

Norce Management API (v1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/

Schemas

Schemas

WarehouseLocationModel

Idinteger(int32)
Codestring
Namestring
IsStandardboolean
StandardLeadTimeDayCountinteger(int32)
IsIncludedInStockCalculationboolean
PrimaryPriceListIdinteger(int32)
PrimaryPriceListNamestring
Changedstring
ChangedBystring
{
  "Id": 0,
  "Code": "string",
  "Name": "string",
  "IsStandard": true,
  "StandardLeadTimeDayCount": 0,
  "IsIncludedInStockCalculation": true,
  "PrimaryPriceListId": 0,
  "PrimaryPriceListName": "string",
  "Changed": "string",
  "ChangedBy": "string"
}

PromotionModel

RequirementsArray of objects(PromotionRequirementSettingModel)
EffectsArray of objects(PromotionEffectSettingModel)
Idinteger(int32)
Namestring
DefaultNamestring

Read only inherited name

IsNameInheritedboolean
SubHeaderstring
DefaultSubHeaderstring

Read only inherited sub header

IsSubHeaderInheritedboolean
SubDescriptionstring
DefaultSubDescriptionstring

Read only inherited sub description

IsSubDescriptionInheritedboolean
DescriptionHeaderstring
DefaultDescriptionHeaderstring

Read only inherited description header

IsDescriptionHeaderInheritedboolean
Descriptionstring
DefaultDescriptionstring

Read only inherited description

IsDescriptionInheritedboolean
ImageKeystring(uuid)
Example: "00000000-0000-0000-0000-000000000000"
ImageUrlstring

Read only full image url at CDN

Codestring
ExclusivityTypestring

Exclusive promotion type: NotExclusive, Exclusive, IgnoreExclusivity. Default is NotExclusive

StartDatestring(date-time)
EndDatestring(date-time)
CountLeftinteger(int32)

Read only value that shows count left when AllowedUsageCount is set

AllowedUsageCountinteger(int32)
UsageCountinteger(int32)

Read only value that shows how many times this promotion has been used

UniqueUserUsageCountinteger(int32)
UniqueDiscountCodeCountinteger(int32)

Read only value that shows count of unique discount codes

UniqueDiscountCodeUsedCountinteger(int32)

Read only value that shows count of used unique discount codes

TotalOrdernumber(double)

Read only value that shows total order value of orders where promotion was used

TotalDiscountnumber(double)

Read only value that shows total order discount of orders where promotion was used

DiscountPercentagenumber(double)

Read only value that shows discount percentage for rows where promotion was used

MarginPercentagenumber(double)

Read only value that shows total order margin of orders where promotion was used

IsStackableboolean
IsProductReqboolean
ExcludeFromPriceCalculationboolean
Statusstring

Promotion status: Inactive, Active, Draft. Default is Inactive

CurrencyCodestring
StoppedDatestring(date-time)

Read only value that shows when a promotion was inactivated

StoppedByinteger(int32)

Read only value that shows who inactivated promotion

StoppedByNamestring

Read only value that shows who inactivated promotion

Createdstring(date-time)

Read only value that shows when promotion was created

CreatedByNamestring

Read only value that shows who created this promotion

Changedstring

Read only value that shows when promotion was changed

ChangedBystring

Read only value that shows who changed this promotion

CulturesArray of objects(PromotionCultureModel)
{
  "Requirements": [
    { … }
  ],
  "Effects": [
    { … }
  ],
  "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": "00000000-0000-0000-0000-000000000000",
  "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.1,
  "TotalDiscount": 0.1,
  "DiscountPercentage": 0.1,
  "MarginPercentage": 0.1,
  "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": [
    { … }
  ]
}

PromotionRequirementSettingModel

Idinteger(int32)
RequirementTypestring

Requirement type can have one of the following values: BasketTotal, ProductFilter, ProductManufacturer, ProductCategory, ProductFlag, ProductPriceList, ProductType, DiscountCode, UniqueDiscountCode, CustomerFlag, CompanyFlag

DiscountCodestring
ValueTypestring

Read only value that is set depending on if OrderSum is set or not. Will be OrderSum if any OrderSum value is set and Quantity when not.

OrderSumTypestring

Read only vaue that is set depending on if OrderSum and/or OrderSumMax is set. Can be Above when only OrderSum is set, Below when only OrderSumMax or Between.

OrderSumnumber(double)
OrderSumMaxnumber(double)
IsIncVatboolean
ProductsIncludedstring

Determines how rows in ProductList is handled, default value is "And". All rows need to be valid when set to "And". At least one row need to be valid when set to "Or". No row can be valid when set to "Not".

CustomerFlagIdinteger(int32)
CustomerFlagNamestring
IsCustomerFlagIncludedboolean
SortOrderinteger(int32)
ProductListArray of objects(PromotionRequirementProductListModel)
Changedstring
ChangedBystring
MatchByEachPartNoboolean
GenericQtynumber(double)
GenericQtyMaxnumber(double)
{
  "Id": 0,
  "RequirementType": "string",
  "DiscountCode": "string",
  "ValueType": "string",
  "OrderSumType": "string",
  "OrderSum": 0.1,
  "OrderSumMax": 0.1,
  "IsIncVat": true,
  "ProductsIncluded": "string",
  "CustomerFlagId": 0,
  "CustomerFlagName": "string",
  "IsCustomerFlagIncluded": true,
  "SortOrder": 0,
  "ProductList": [
    { … }
  ],
  "Changed": "string",
  "ChangedBy": "string",
  "MatchByEachPartNo": true,
  "GenericQty": 0.1,
  "GenericQtyMax": 0.1
}

Category

Operations

Category Parametric

Operations

Customer Flag

Operations

Customer FlagGroup

Operations

Customer InfoType

Operations

Parametric

Operations

Parametric Group

Operations

Parametric List

Operations

Parametric Multiple

Operations

PriceList

Operations

PriceList Population

Operations

PriceList Pricing

Operations

PriceList SupplierPricelist

Operations

PriceList Warehouse

Operations

Product Family

Operations

Product File

Operations

Product Flag

Operations

Product FlagGroup

Operations

Product InfoType

Operations

Product Manufacturer

Operations

Product RelationType

Operations

Product Type

Operations

Product VariantGroup

Operations

Product Warehouse

Operations

Product WarehouseLocation

Operations

Promotion

Operations

Settings Application

Operations

Settings ApplicationCountry

Operations

Settings ApplicationCulture

Operations

Settings ApplicationCurrency

Operations

Settings ApplicationSalesArea

Operations

Settings ClientAssortment

Operations

Settings ClientCurrency

Operations

Settings ClientSalesArea

Operations

Shopping InfoType

Operations

Store

Operations

Store Application

Operations

Store PriceList

Operations

Store Warehouse

Operations

Supplier

Operations

Supplier PriceList

Operations

Supplier PriceListWarehouse

Operations

Supplier Warehouse

Operations

Supplier WarehouseLocation

Operations