POST Marketing/AddPromotionItem

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Disabled		date	None.
ValidFrom		date	None.
Expiration		date	None.
PromotionID		integer	None.
Amount	The unitary amount to apply. If null, use DiscountPercent	decimal number	None.
DiscountPercent		decimal number	Range: inclusive between 0 and 1
MinimumOrderAmount	The minimum required order amount to apply this promotion	decimal number	None.
MinimumQuantity	Sets the minimum number of such an item that the discount can be applied to in the same purchase.	decimal number	None.
QuantityStep	Sets the number of items that have to be grouped together to apply the discount	decimal number	None.
MaximumQuantity	Sets the maximum number of products that the discount can be applied to in the same purchase.	decimal number	None.
Cumulative	This promotionItem applies after other main promotion	boolean	None.
AutoAddRemoveQuantity	If the conditions of this promoItem are (not) met, the PromotedEntity(ies) gets automatically added/removed to/from the order	decimal number	None.
PromotionableTypeID	Defines the set of Products included in this promo. The set can be defined at the Store, Classification or Product level	integer	None.
PromotionableID		integer	None.
IncludeDescendants	Includes PromotionableEntity descendants	boolean	None.
Lang		string	None.
StoreID		integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Disabled": "2025-12-06T09:17:20.2022842+01:00",
  "ValidFrom": "2025-12-06T09:17:20.2022842+01:00",
  "Expiration": "2025-12-06T09:17:20.2022842+01:00",
  "PromotionID": 2,
  "Amount": 1.0,
  "DiscountPercent": 1.0,
  "MinimumOrderAmount": 3.0,
  "MinimumQuantity": 4.0,
  "QuantityStep": 5.0,
  "MaximumQuantity": 1.0,
  "Cumulative": true,
  "AutoAddRemoveQuantity": 7.0,
  "PromotionableTypeID": 8,
  "PromotionableID": 9,
  "IncludeDescendants": true,
  "Lang": "sample string 11",
  "StoreID": 12
}

application/xml, text/xml

Sample:

<AddPromotionItemBinding xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Binding.Marketing">
  <Lang xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">sample string 11</Lang>
  <StoreID xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">12</StoreID>
  <Amount>1</Amount>
  <AutoAddRemoveQuantity>7</AutoAddRemoveQuantity>
  <Cumulative>true</Cumulative>
  <Disabled>2025-12-06T09:17:20.2022842+01:00</Disabled>
  <DiscountPercent>1</DiscountPercent>
  <Expiration>2025-12-06T09:17:20.2022842+01:00</Expiration>
  <IncludeDescendants>true</IncludeDescendants>
  <MaximumQuantity>1</MaximumQuantity>
  <MinimumOrderAmount>3</MinimumOrderAmount>
  <MinimumQuantity>4</MinimumQuantity>
  <PromotionID>2</PromotionID>
  <PromotionableID>9</PromotionableID>
  <PromotionableTypeID>8</PromotionableTypeID>
  <QuantityStep>5</QuantityStep>
  <ValidFrom>2025-12-06T09:17:20.2022842+01:00</ValidFrom>
</AddPromotionItemBinding>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

integer

Response Formats

application/json, text/json

Sample:

application/xml, text/xml

Sample:

<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</int>