Promotion id
Norce Management API (v1)
https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/
https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/promotion/{id}
- cURL
- JS
- C#
curl -i -X GET \
'https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/promotion/{id}'
OK
- application/json
- text/json
Exclusive promotion type: NotExclusive, Exclusive, IgnoreExclusivity. Default is NotExclusive
Read only value that shows count of used unique discount codes
Read only value that shows total order value of orders where promotion was used
Read only value that shows total order discount of orders where promotion was used
Read only value that shows discount percentage for rows where promotion was used
Read only value that shows total order margin of orders where promotion was used
{ "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": [ { … } ] }
- application/json
- text/json
- application/x-www-form-urlencoded
Promotion
Exclusive promotion type: NotExclusive, Exclusive, IgnoreExclusivity. Default is NotExclusive
Read only value that shows count of used unique discount codes
Read only value that shows total order value of orders where promotion was used
Read only value that shows total order discount of orders where promotion was used
Read only value that shows discount percentage for rows where promotion was used
Read only value that shows total order margin of orders where promotion was used
https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/promotion/{id}
- cURL
- JS
- C#
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
}
]
}'
https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/promotion
- cURL
- JS
- C#
curl -i -X GET \
https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/promotion
OK
- application/json
- text/json
Exclusive promotion type: NotExclusive, Exclusive, IgnoreExclusivity. Default is NotExclusive
Read only value that shows count of used unique discount codes
Read only value that shows total order value of orders where promotion was used
Read only value that shows total order discount of orders where promotion was used
Read only value that shows discount percentage for rows where promotion was used
Read only value that shows total order margin of orders where promotion was used
[ { "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": [ … ] } ]
- application/json
- text/json
- application/x-www-form-urlencoded
Promotion
Exclusive promotion type: NotExclusive, Exclusive, IgnoreExclusivity. Default is NotExclusive
Read only value that shows count of used unique discount codes
Read only value that shows total order value of orders where promotion was used
Read only value that shows total order discount of orders where promotion was used
Read only value that shows discount percentage for rows where promotion was used
Read only value that shows total order margin of orders where promotion was used
https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/promotion
- cURL
- JS
- C#
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
}
]
}'
https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/promotion/{id}/unique-codes
- cURL
- JS
- C#
curl -i -X GET \
'https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/promotion/{id}/unique-codes'
[ { "DiscountCode": "string", "Created": "2019-08-24T14:15:22Z", "IsClaimed": true, "DateClaimed": "2019-08-24T14:15:22Z", "QuotationId": 0, "ClaimedFromSource": "string" } ]
- application/json
- text/json
- application/x-www-form-urlencoded
Codes to update or insert
https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/promotion/{id}/unique-codes
- cURL
- JS
- C#
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"
}
]'
https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/promotion/{id}/unique-codes
- cURL
- JS
- C#
curl -i -X POST \
'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"
}
]'