Cart Test
Web/Cart/{sessionKey}/LineItems/{lineItemId}/Discount
Applies a discounted price to all sub line items for a line item

For packages, the discount can only be applied to package line items.

The status field in the response will return as S if the discount can be used or E with a description of the error if the discount cannot be used.
Http Verb PUT
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/Web/Cart/{sessionKey}/LineItems/{lineItemId}/Discount

URI Parameters

Parameter Name Data Type Required Notes
sessionKey string Y
lineItemId integer Y The Id of the Lineitem to apply the discount to. Must be a valid lineitem in the cart.

Request Body

Request object type : ApplyDiscountRequest

Request object type ApplyDiscountRequest has the following properties.
Property Name Data Type Length Required Readonly Notes
DiscountTypeId integer Y The Id of the discount to apply.
FK: TR_DISCOUNT_TYPES.id   Resource: DiscountTypes 
{
  "DiscountTypeId": 1
}
<ApplyDiscountRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <DiscountTypeId>1</DiscountTypeId>
</ApplyDiscountRequest>

Response object type : Collection of UpdatePriceResponse

Response object type Collection of UpdatePriceResponse has the following properties.
Property Name Data Type Length Required Readonly Notes
DueAmount decimal number The new price for the sub lineitem. Will be NULL if an error occurred.
Error string A description of why the price or discount could not be applied, if an error occurred. Will be present if Status is 'E'.
LineItemId integer
NonDiscountPrice decimal number The original price of the sub lineitem. Will be NULL if an error occurred.
PackageId integer
PerformanceId integer
PriceTypeId integer
SeatNumber integer
Status string Will be 'S' if the price or discount is applied, 'E' if it could not be.
SubLineItemId integer
ZoneId integer 
[
  {
    "LineItemId": 1,
    "SubLineItemId": 2,
    "PerformanceId": 3,
    "PackageId": 4,
    "ZoneId": 5,
    "SeatNumber": 6,
    "DueAmount": 1.0,
    "PriceTypeId": 7,
    "NonDiscountPrice": 1.0,
    "Status": "sample string 8",
    "Error": "sample string 9"
  },
  {
    "LineItemId": 1,
    "SubLineItemId": 2,
    "PerformanceId": 3,
    "PackageId": 4,
    "ZoneId": 5,
    "SeatNumber": 6,
    "DueAmount": 1.0,
    "PriceTypeId": 7,
    "NonDiscountPrice": 1.0,
    "Status": "sample string 8",
    "Error": "sample string 9"
  }
]
<UpdatePriceResponses xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <UpdatePriceResponse>
    <DueAmount>1</DueAmount>
    <Error>sample string 9</Error>
    <LineItemId>1</LineItemId>
    <NonDiscountPrice>1</NonDiscountPrice>
    <PackageId>4</PackageId>
    <PerformanceId>3</PerformanceId>
    <PriceTypeId>7</PriceTypeId>
    <SeatNumber>6</SeatNumber>
    <Status>sample string 8</Status>
    <SubLineItemId>2</SubLineItemId>
    <ZoneId>5</ZoneId>
  </UpdatePriceResponse>
  <UpdatePriceResponse>
    <DueAmount>1</DueAmount>
    <Error>sample string 9</Error>
    <LineItemId>1</LineItemId>
    <NonDiscountPrice>1</NonDiscountPrice>
    <PackageId>4</PackageId>
    <PerformanceId>3</PerformanceId>
    <PriceTypeId>7</PriceTypeId>
    <SeatNumber>6</SeatNumber>
    <Status>sample string 8</Status>
    <SubLineItemId>2</SubLineItemId>
    <ZoneId>5</ZoneId>
  </UpdatePriceResponse>
</UpdatePriceResponses>
Change Version Description Contract Old New
Parameter Changed 15.0.0 sessionKey has been marked as required. Required