Documentation for POST API/Promotion/EvaluateCartPromotions

POST API/Promotion/EvaluateCartPromotions

Evaluates a promotion and gives the updated pricing without any order context.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
RepDID	Optional, specify the Rep # of the rep placing the order. Leave blank for blind shopping.	string	None.
CustomerDID	Optional, specify the Rep # of the rep placing the order. Leave blank for blind shopping.	string	None.
IsUnauthenticated	Optional, indicates no customer or rep is currently logged in.	boolean	None.
OwnerRepDID	Optional, specify the Rep # of the referring rep. This is the rep who shared the shopping link	string	None.
ShipCountry	Required. The shipping country for the given order.	string	None.
Items	Required. The items placed on the current order. These should be the original items without any promotion.	Collection of CartPromotionRequestItem	None.
LocaleID	Optional.	integer	None.

Request Formats

application/xml, text/xml

Sample:

<PromotionRequestViewModel>
  <RepDID>sample string 1</RepDID>
  <CustomerDID>sample string 2</CustomerDID>
  <IsUnauthenticated>True</IsUnauthenticated>
  <OwnerRepDID>sample string 4</OwnerRepDID>
  <ShipCountry>sample string 5</ShipCountry>
  <Items>
    <CartPromotionRequestItem>
      <InventoryID>1</InventoryID>
      <Quantity>2</Quantity>
      <OnlineOrderDetailID>1</OnlineOrderDetailID>
      <Price>3</Price>
      <TaxableAmount>4</TaxableAmount>
      <ShippingValue>5</ShippingValue>
      <Compare>6</Compare>
      <Volume1>7</Volume1>
      <Volume2>8</Volume2>
      <Volume3>9</Volume3>
      <Volume4>10</Volume4>
      <OtherPrice1>11</OtherPrice1>
      <OtherPrice2>12</OtherPrice2>
      <OtherPrice3>13</OtherPrice3>
      <OtherPrice4>14</OtherPrice4>
      <IsAutoShip>True</IsAutoShip>
      <PriceID>1</PriceID>
    </CartPromotionRequestItem>
    <CartPromotionRequestItem>
      <InventoryID>1</InventoryID>
      <Quantity>2</Quantity>
      <OnlineOrderDetailID>1</OnlineOrderDetailID>
      <Price>3</Price>
      <TaxableAmount>4</TaxableAmount>
      <ShippingValue>5</ShippingValue>
      <Compare>6</Compare>
      <Volume1>7</Volume1>
      <Volume2>8</Volume2>
      <Volume3>9</Volume3>
      <Volume4>10</Volume4>
      <OtherPrice1>11</OtherPrice1>
      <OtherPrice2>12</OtherPrice2>
      <OtherPrice3>13</OtherPrice3>
      <OtherPrice4>14</OtherPrice4>
      <IsAutoShip>True</IsAutoShip>
      <PriceID>1</PriceID>
    </CartPromotionRequestItem>
  </Items>
  <LocaleID>1</LocaleID>
</PromotionRequestViewModel>

application/json, text/json

Sample:

{
  "RepDID": "sample string 1",
  "CustomerDID": "sample string 2",
  "IsUnauthenticated": true,
  "OwnerRepDID": "sample string 4",
  "ShipCountry": "sample string 5",
  "Items": [
    {
      "InventoryID": 1,
      "Quantity": 2,
      "OnlineOrderDetailID": 1,
      "Price": 3.0,
      "TaxableAmount": 4.0,
      "ShippingValue": 5.0,
      "Compare": 6.0,
      "Volume1": 7.0,
      "Volume2": 8.0,
      "Volume3": 9.0,
      "Volume4": 10.0,
      "OtherPrice1": 11.0,
      "OtherPrice2": 12.0,
      "OtherPrice3": 13.0,
      "OtherPrice4": 14.0,
      "IsAutoShip": true,
      "PriceID": 1
    },
    {
      "InventoryID": 1,
      "Quantity": 2,
      "OnlineOrderDetailID": 1,
      "Price": 3.0,
      "TaxableAmount": 4.0,
      "ShippingValue": 5.0,
      "Compare": 6.0,
      "Volume1": 7.0,
      "Volume2": 8.0,
      "Volume3": 9.0,
      "Volume4": 10.0,
      "OtherPrice1": 11.0,
      "OtherPrice2": 12.0,
      "OtherPrice3": 13.0,
      "OtherPrice4": 14.0,
      "IsAutoShip": true,
      "PriceID": 1
    }
  ],
  "LocaleID": 1
}

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 'PromotionRequestViewModel'.

Response Information

Resource Description

ICartPromotionResponse

Name	Type	Additional information
ErrorMessage	string	None.
IsSuccessful	boolean	None.
Messages	Collection of ICartPromotionResponseMessage	None.
LocaleID	integer	None.

Response Formats

application/xml, text/xml

Sample:

<CartPromotionResponse>
  <ErrorMessage />
  <IsSuccessful>False</IsSuccessful>
  <Messages />
  <LocaleID>0</LocaleID>
</CartPromotionResponse>

application/json, text/json

Sample:

{
  "IsSuccessful": false,
  "LocaleID": 0
}