POST Marketing/ApplicablePromotions

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ProductID	integer	None.
Lang	string	None.
StoreID	integer	None.

Request Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

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

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of PromotionItem

Name	Description	Type	Additional information
ID		integer	None.
PromotionID		integer	None.
Base		decimal number	None.
Amount		decimal number	None.
Discount		decimal number	None.
DiscountPercent		decimal number	None.
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.
ValidFrom		date	None.
Expiration		date	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.
Cumulative		boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ID": 1,
    "PromotionID": 2,
    "Base": 3.0,
    "Amount": 4.0,
    "Discount": 5.0,
    "DiscountPercent": 6.0,
    "MinimumOrderAmount": 7.0,
    "MinimumQuantity": 8.0,
    "QuantityStep": 9.0,
    "MaximumQuantity": 1.0,
    "ValidFrom": "2024-03-28T08:41:16.725927+01:00",
    "Expiration": "2024-03-28T08:41:16.725927+01:00",
    "AutoAddRemoveQuantity": 11.0,
    "Cumulative": true
  },
  {
    "ID": 1,
    "PromotionID": 2,
    "Base": 3.0,
    "Amount": 4.0,
    "Discount": 5.0,
    "DiscountPercent": 6.0,
    "MinimumOrderAmount": 7.0,
    "MinimumQuantity": 8.0,
    "QuantityStep": 9.0,
    "MaximumQuantity": 1.0,
    "ValidFrom": "2024-03-28T08:41:16.725927+01:00",
    "Expiration": "2024-03-28T08:41:16.725927+01:00",
    "AutoAddRemoveQuantity": 11.0,
    "Cumulative": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfPromotionItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.View.Catalog">
  <PromotionItem>
    <Amount>4</Amount>
    <AutoAddRemoveQuantity>11</AutoAddRemoveQuantity>
    <Base>3</Base>
    <Cumulative>true</Cumulative>
    <Discount>5</Discount>
    <DiscountPercent>6</DiscountPercent>
    <Expiration>2024-03-28T08:41:16.725927+01:00</Expiration>
    <ID>1</ID>
    <MaximumQuantity>1</MaximumQuantity>
    <MinimumOrderAmount>7</MinimumOrderAmount>
    <MinimumQuantity>8</MinimumQuantity>
    <PromotionID>2</PromotionID>
    <QuantityStep>9</QuantityStep>
    <ValidFrom>2024-03-28T08:41:16.725927+01:00</ValidFrom>
  </PromotionItem>
  <PromotionItem>
    <Amount>4</Amount>
    <AutoAddRemoveQuantity>11</AutoAddRemoveQuantity>
    <Base>3</Base>
    <Cumulative>true</Cumulative>
    <Discount>5</Discount>
    <DiscountPercent>6</DiscountPercent>
    <Expiration>2024-03-28T08:41:16.725927+01:00</Expiration>
    <ID>1</ID>
    <MaximumQuantity>1</MaximumQuantity>
    <MinimumOrderAmount>7</MinimumOrderAmount>
    <MinimumQuantity>8</MinimumQuantity>
    <PromotionID>2</PromotionID>
    <QuantityStep>9</QuantityStep>
    <ValidFrom>2024-03-28T08:41:16.725927+01:00</ValidFrom>
  </PromotionItem>
</ArrayOfPromotionItem>