Documentation for POST API/Promotion/ClearPromotions

POST API/Promotion/ClearPromotions

Validate existent promotions for specific Online OrderID or OrderID.

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
OnlineOrderId	integer	None.
OrderId	integer	None.
LocaleId	integer	None.
ShouldClearPromotions	boolean	None.
PromotionTypeId	integer	None.

Request Formats

application/xml, text/xml

Sample:

<PromotionInput>
  <OnlineOrderId>1</OnlineOrderId>
  <OrderId>2</OrderId>
  <LocaleId>3</LocaleId>
  <ShouldClearPromotions>True</ShouldClearPromotions>
  <PromotionTypeId>5</PromotionTypeId>
</PromotionInput>

application/json, text/json

Sample:

{
  "OnlineOrderId": 1,
  "OrderId": 2,
  "LocaleId": 3,
  "ShouldClearPromotions": true,
  "PromotionTypeId": 5
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'FormUrlEncodedFormatter' to write type 'PromotionInput'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/xml, text/xml, application/json, text/json

Sample:

Sample not available.