POST Marketing/PromotionItem

GetPromotionItems with same parentID

Request Information

URI Parameters

None.

Body Parameters

GetPromotionItemRequest
NameDescriptionTypeAdditional information
ID

integer

None.

Lang

string

None.

StoreID

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "ID": 1,
  "Lang": "sample string 2",
  "StoreID": 3
}

application/xml, text/xml

Sample:
<GetPromotionItemRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Marketing">
  <Lang xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">sample string 2</Lang>
  <StoreID xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">3</StoreID>
  <ID>1</ID>
</GetPromotionItemRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PromotionItem
NameDescriptionTypeAdditional information
ID

integer

None.

Created

date

None.

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.

Response Formats

application/json, text/json

Sample:
{
  "ID": 1,
  "Created": "2025-12-06T09:15:26.0644458+01:00",
  "Disabled": "2025-12-06T09:15:26.0644458+01:00",
  "ValidFrom": "2025-12-06T09:15:26.0644458+01:00",
  "Expiration": "2025-12-06T09:15:26.0644458+01:00",
  "PromotionID": 4,
  "Amount": 1.0,
  "DiscountPercent": 1.0,
  "MinimumOrderAmount": 5.0,
  "MinimumQuantity": 6.0,
  "QuantityStep": 7.0,
  "MaximumQuantity": 1.0,
  "Cumulative": true,
  "AutoAddRemoveQuantity": 9.0,
  "PromotionableTypeID": 10,
  "PromotionableID": 11,
  "IncludeDescendants": true
}

application/xml, text/xml

Sample:
<PromotionItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Marketing">
  <Amount>1</Amount>
  <AutoAddRemoveQuantity>9</AutoAddRemoveQuantity>
  <Created>2025-12-06T09:15:26.0644458+01:00</Created>
  <Cumulative>true</Cumulative>
  <Disabled>2025-12-06T09:15:26.0644458+01:00</Disabled>
  <DiscountPercent>1</DiscountPercent>
  <Expiration>2025-12-06T09:15:26.0644458+01:00</Expiration>
  <ID>1</ID>
  <IncludeDescendants>true</IncludeDescendants>
  <MaximumQuantity>1</MaximumQuantity>
  <MinimumOrderAmount>5</MinimumOrderAmount>
  <MinimumQuantity>6</MinimumQuantity>
  <PromotionID>4</PromotionID>
  <PromotionableID>11</PromotionableID>
  <PromotionableTypeID>10</PromotionableTypeID>
  <QuantityStep>7</QuantityStep>
  <ValidFrom>2025-12-06T09:15:26.0644458+01:00</ValidFrom>
</PromotionItem>