Inserts unique checkout codes for a promotion that is not a duplicate

Category
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Operations

Category Parametric
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Operations

Customer Flag
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Operations

Customer FlagGroup
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Operations

Customer InfoType
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Operations

Parametric
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Operations

Parametric Group
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Operations

Parametric List
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Operations

Parametric Multiple
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Operations

PriceList
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Operations

PriceList Population
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Operations

PriceList Pricing
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Operations

PriceList SupplierPricelist
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Operations

PriceList Warehouse
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Operations

Product Family
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Operations

Product File
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Operations

Product Flag
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Operations

Product FlagGroup
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Operations

Product InfoType
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Operations

Product Manufacturer
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Operations

Product RelationType
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Operations

Product Type
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Operations

Product VariantGroup
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Operations

Product Warehouse
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Operations

Product WarehouseLocation
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Operations

Promotion
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Operations

Get promotion

Request

Path

idinteger(int32)required

Promotion id

curl -i -X GET \
  'https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/promotion/{id}'

Responses

OK

Body

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)

Response

{
  "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": [
    { … }
  ]
}

Update promotion

Request

Path

idinteger(int32)required

Promotion id

Body

required

Promotion

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)

curl -i -X PUT \
  'https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/promotion/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "Requirements": [
      {
        "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": [
          {
            "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,
            "Changed": "string",
            "ChangedBy": "string"
          }
        ],
        "Changed": "string",
        "ChangedBy": "string",
        "MatchByEachPartNo": true,
        "GenericQty": 0.1,
        "GenericQtyMax": 0.1
      }
    ],
    "Effects": [
      {
        "Id": 0,
        "EffectType": "string",
        "IsDiscount": true,
        "IsFixedPrice": true,
        "Value": 0.1,
        "IsIncVat": true,
        "IgnoreNonDiscountable": true,
        "DiscountMostExpensiveItems": true,
        "SortOrder": 0,
        "UseRequirementProducts": true,
        "GenericQty": 0.1,
        "ProductList": [
          {
            "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.1,
            "IsIncVat": true,
            "Changed": "string",
            "ChangedBy": "string"
          }
        ],
        "Changed": "string",
        "ChangedBy": "string"
      }
    ],
    "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": [
      {
        "CultureCode": "string",
        "Name": "string",
        "IsNameInherited": true,
        "SubHeader": "string",
        "IsSubHeaderInherited": true,
        "SubDescription": "string",
        "IsSubDescriptionInherited": true,
        "DescriptionHeader": "string",
        "IsDescriptionHeaderInherited": true,
        "Description": "string",
        "IsDescriptionInherited": true,
        "IsTranslated": true
      }
    ]
  }'

Responses

OK

Body

object

Response

{}

List promotions

Request

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/promotion

Responses

OK

Body

Array [

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)

]

Response

[
  {
    "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": [ … ]
  }
]

Insert promotion

Request

Body

required

Promotion

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)

curl -i -X POST \
  https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/promotion \
  -H 'Content-Type: application/json' \
  -d '{
    "Requirements": [
      {
        "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": [
          {
            "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,
            "Changed": "string",
            "ChangedBy": "string"
          }
        ],
        "Changed": "string",
        "ChangedBy": "string",
        "MatchByEachPartNo": true,
        "GenericQty": 0.1,
        "GenericQtyMax": 0.1
      }
    ],
    "Effects": [
      {
        "Id": 0,
        "EffectType": "string",
        "IsDiscount": true,
        "IsFixedPrice": true,
        "Value": 0.1,
        "IsIncVat": true,
        "IgnoreNonDiscountable": true,
        "DiscountMostExpensiveItems": true,
        "SortOrder": 0,
        "UseRequirementProducts": true,
        "GenericQty": 0.1,
        "ProductList": [
          {
            "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.1,
            "IsIncVat": true,
            "Changed": "string",
            "ChangedBy": "string"
          }
        ],
        "Changed": "string",
        "ChangedBy": "string"
      }
    ],
    "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": [
      {
        "CultureCode": "string",
        "Name": "string",
        "IsNameInherited": true,
        "SubHeader": "string",
        "IsSubHeaderInherited": true,
        "SubDescription": "string",
        "IsSubDescriptionInherited": true,
        "DescriptionHeader": "string",
        "IsDescriptionHeaderInherited": true,
        "Description": "string",
        "IsDescriptionInherited": true,
        "IsTranslated": true
      }
    ]
  }'

Responses

OK

Body

object

Response

{}

Get unique checkout codes for a promotion

Request

Path

idinteger(int32)required

Promotion id

curl -i -X GET \
  'https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/promotion/{id}/unique-codes'

Responses

OK

Body

Array [

DiscountCodestring

Createdstring(date-time)

IsClaimedboolean

DateClaimedstring(date-time)

QuotationIdinteger(int32)

ClaimedFromSourcestring

]

Response

[
  {
    "DiscountCode": "string",
    "Created": "2019-08-24T14:15:22Z",
    "IsClaimed": true,
    "DateClaimed": "2019-08-24T14:15:22Z",
    "QuotationId": 0,
    "ClaimedFromSource": "string"
  }
]

Updates unique checkout codes for a promotion

Request

Path

idinteger(int32)required

Promotion id

Body

required

Codes to update or insert

Array [

DiscountCodestring

Createdstring(date-time)

IsClaimedboolean

DateClaimedstring(date-time)

QuotationIdinteger(int32)

ClaimedFromSourcestring

]

curl -i -X PUT \
  'https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/promotion/{id}/unique-codes' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "DiscountCode": "string",
      "Created": "2019-08-24T14:15:22Z",
      "IsClaimed": true,
      "DateClaimed": "2019-08-24T14:15:22Z",
      "QuotationId": 0,
      "ClaimedFromSource": "string"
    }
  ]'

Responses

OK

Body

object

Response

{}