Management API (v1)

The Norce Management API lets you manage configurations and metadata on a client.

Download OpenAPI description
Languages
Servers

https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/

Schemas

PromotionEffectProductListModel

PromotionEffectProductList model, represents a single product rule within a promotion effect setting. Defines specific product filters such as manufacturer, category, flag, price list, product type, product, or variant.

Idinteger(int32)

The unique identifier for the product effect rule

ManufacturerIdinteger or null(int32)

The manufacturer identifier for filtering products by manufacturer, null if not filtering by manufacturer

ManufacturerCodestring or null

The manufacturer code for filtering products by manufacturer, null if not filtering by manufacturer

ManufacturerNamestring or null

The manufacturer name for filtering products by manufacturer, null if not filtering by manufacturer

CategoryIdinteger or null(int32)

The category identifier for filtering products by category, null if not filtering by category

CategoryCodestring or null

The category code for filtering products by category, null if not filtering by category

CategoryNamestring or null

The category name for filtering products by category, null if not filtering by category

FlagIdinteger or null(int32)

The flag identifier for filtering products by flag, null if not filtering by flag

FlagCodestring or null

The flag code for filtering products by flag, null if not filtering by flag

FlagNamestring or null

The flag name for filtering products by flag, null if not filtering by flag

IsFlagInclusiveboolean

Indicates whether the flag rule is "set" or "not set" for filtering products by flag

PriceListIdinteger or null(int32)

The price list identifier for filtering products by price list, null if not filtering by price list

PriceListCodestring or null

The price list code for filtering products by price list, null if not filtering by price list

PriceListNamestring or null

The price list name for filtering products by price list, null if not filtering by price list

ProductTypeIdinteger or null(int32)

The product type identifier for filtering products by product type, null if not filtering by product type

ProductTypeNamestring or null

The product type name for filtering products by product type, null if not filtering by product type

ProductIdinteger or null(int32)

The product id filter for this product rule, null if not filtering by specific product

ProductHasVariantsboolean

True if the product has variants.

ProductNamestring or null

The product name for filtering by specific product, null if not filtering by specific product

VariantProductIdinteger or null(int32)

The variant product id filter for this product rule, null if not filtering by specific variant product

VariantProductNamestring or null

The variant product name for filtering by specific variant product, null if not filtering by specific variant product

PartNostring or null

The part number for the product or variant product

Qtyinteger or null(int32)

The quantity required for this product rule, null if applied on the requirement level

IsDiscountboolean or null

Indicates whether the effect is calculated as a percentage discount

IsFixedPriceboolean or null

Indicates whether the effect is a fixed price adjustment

Valuenumber or null(decimal)

The value associated with the effect, such as discount amount or fixed price

IsIncVatboolean or null

Indicates whether the value is inclusive of VAT, relevant for fixed price effects

Changedstring or null

The date and time when this promotion effect product list was last changed.

ChangedBystring or null

The identifier of the user who last changed this promotion effect product list.

{ "Id": 0, "ManufacturerId": 0, "ManufacturerCode": "string", "ManufacturerName": "string", "CategoryId": 0, "CategoryCode": "string", "CategoryName": "string", "FlagId": 0, "FlagCode": "string", "FlagName": "string", "IsFlagInclusive": true, "PriceListId": 0, "PriceListCode": "string", "PriceListName": "string", "ProductTypeId": 0, "ProductTypeName": "string", "ProductId": 0, "ProductHasVariants": true, "ProductName": "string", "VariantProductId": 0, "VariantProductName": "string", "PartNo": "string", "Qty": 0, "IsDiscount": true, "IsFixedPrice": true, "Value": 0, "IsIncVat": true, "Changed": "string", "ChangedBy": "string" }

PromotionListModel

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.

Idinteger(int32)

The promotion identifier

Namestring or null[ 0 .. 255 ] characters

The name of the promotion in the current culture

DefaultNamestring or null[ 0 .. 255 ] characters

The default name of the promotion used as fallback when no culture-specific name is available

IsNameInheritedboolean

Indicates whether the name is inherited from the default culture

SubHeaderstring or null[ 0 .. 255 ] characters

The sub header of the promotion in the current culture

DefaultSubHeaderstring or null[ 0 .. 255 ] characters

The default sub header of the promotion used as fallback when no culture-specific sub header is available

IsSubHeaderInheritedboolean

Indicates whether the sub header is inherited from the default culture

SubDescriptionstring or null

The sub description of the promotion in the current culture

DefaultSubDescriptionstring or null

The default sub description of the promotion used as fallback when no culture-specific sub description is available

IsSubDescriptionInheritedboolean

Indicates whether the sub description is inherited from the default culture

DescriptionHeaderstring or null[ 0 .. 255 ] characters

The description header of the promotion in the current culture

DefaultDescriptionHeaderstring or null[ 0 .. 255 ] characters

The default description header of the promotion used as fallback when no culture-specific description header is available

IsDescriptionHeaderInheritedboolean

Indicates whether the description header is inherited from the default culture

Descriptionstring or null

The description of the promotion in the current culture

DefaultDescriptionstring or null

The default description of the promotion used as fallback when no culture-specific description is available

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default culture

ImageKeystring or null(guid)

The unique identifier for the promotion image

ImageUrlstring or null

The URL of the promotion image, deprecated, use ImageKey instead.

Codestring or null[ 0 .. 50 ] characters

The unique code identifying the promotion

ExclusivityTypestring or null

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

StartDatestring or null(date-time)

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"

EndDatestring or null(date-time)

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"

CountLeftinteger or null(int32)

The number of usages left for this promotion, if AllowedUsageCount is set

AllowedUsageCountinteger or null(int32)

The maximum number of times this promotion can be used

UsageCountinteger or null(int32)

The total number of times this promotion has been used

UniqueUserUsageCountinteger or null(int32)

The number of unique users who have used this promotion

UniqueDiscountCodeCountinteger or null(int32)

The number of unique discount codes associated with this promotion

UniqueDiscountCodeUsedCountinteger or null(int32)

The number of unique discount codes that have been used for this promotion

TotalOrdernumber or null(decimal)

The total order amount for this promotion

TotalDiscountnumber or null(decimal)

The total discount amount given by this promotion

DiscountPercentagenumber or null(decimal)

The discount percentage applied by this promotion

MarginPercentagenumber or null(decimal)

The margin percentage for this promotion

IsStackableboolean or null

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.

IsProductReqboolean

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.

ExcludeFromPriceCalculationboolean

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.

Statusstring or null

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

CurrencyCodestring or null

The currency code for this promotion

StoppedDatestring or null(date-time)

The date and time when the promotion was stopped

StoppedByinteger or null(int32)

The identifier of the user who stopped this promotion

StoppedByNamestring or null

The name of the user who stopped this promotion

Createdstring(date-time)

The date and time when the promotion was created

CreatedByNamestring or null

The name of the user who created this promotion

Changedstring or null

The date and time when the promotion was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the promotion

CulturesArray of objects(PromotionCultureModel)

The list of culture-specific translations for 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": [ {} ] }

PromotionCultureModel

Culture-specific model for promotion translations

CultureCodestring or null[ 0 .. 16 ] characters

The culture code for this translation

Namestring or null[ 0 .. 255 ] characters

The name of the promotion in this culture

IsNameInheritedboolean

Indicates whether the name is inherited from the default culture

SubHeaderstring or null[ 0 .. 255 ] characters

The sub header of the promotion in this culture

IsSubHeaderInheritedboolean

Indicates whether the sub header is inherited from the default culture

SubDescriptionstring or null

The sub description of the promotion in this culture

IsSubDescriptionInheritedboolean

Indicates whether the sub description is inherited from the default culture

DescriptionHeaderstring or null[ 0 .. 255 ] characters

The description header of the promotion in this culture

IsDescriptionHeaderInheritedboolean

Indicates whether the description header is inherited from the default culture

Descriptionstring or null

The description of the promotion in this culture

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default culture

IsTranslatedboolean

Indicates whether this culture has been translated

{ "CultureCode": "string", "Name": "string", "IsNameInherited": true, "SubHeader": "string", "IsSubHeaderInherited": true, "SubDescription": "string", "IsSubDescriptionInherited": true, "DescriptionHeader": "string", "IsDescriptionHeaderInherited": true, "Description": "string", "IsDescriptionInherited": true, "IsTranslated": true }

Settings ApplicationCountry

Operations

Settings ApplicationCulture

Operations

Settings ApplicationCurrency

Operations

Settings ApplicationSalesArea

Operations

Settings Application

Operations

Category

Operations

CategoryParametric

Operations

Settings ClientAssortment

Operations

Settings ClientCurrency

Operations

Settings ClientSalesArea

Operations

Customer FlagGroup

Operations

Customer Flag

Operations

Customer InfoType

Operations

Product Family

Operations

Product File

Operations

Product Manufacturer

Operations

Parametric Group

Operations

Parametric List

Operations

Parametric Multiple

Operations

Parametric

Operations

PriceList Population

Operations

PriceList Pricing

Operations

PriceList

Operations

PriceList SupplierPriceList

Operations

PriceList Warehouse

Operations

Product FlagGroup

Operations

Product Flag

Operations

Product InfoType

Operations

Product Type

Operations

Promotion

Operations

Product RelationType

Operations

PriceList RoundingRule

Operations

Shopping InfoType

Operations

Store Application

Operations

Store PriceList

Operations

Store

Operations

Store Warehouse

Operations

Supplier PriceList

Operations

Supplier PriceListWarehouse

Operations

Supplier

Operations

Supplier Warehouse

Operations

Supplier WarehouseLocation

Operations

Product VariantGroup

Operations

Product WarehouseLocation

Operations

Product Warehouse

Operations