Cart Test
Web/Cart/{sessionKey}/Packages/Super
Adds a new sub package item to the cart

This method is used to add a seated or unseated super package line item to the cart for the specified session by adding the component sub packages. When the package is seated, the best seating function can be used or specific seat numbers can be passed for use with SYOS functionality. The method must be called once for each sub package.

A super package line item is created when the first sub package is added to the cart.The ID number from the super package line item is required when the remaining component sub packages are added.It is returned as SuperPackageLineItemId in the response.

Super package line items can be added as alternate/upgrade line items to another super package line item in the cart. To add an alternate/upgrade line item, the parent line item ID must be passed as the ParentSuperPackageLineItemId parameter value for this method.The parent line item ID can be retrieved using the /Web/Cart (GET) method.
Http Verb POST
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/Web/Cart/{sessionKey}/Packages/Super

URI Parameters

Parameter Name Data Type Required Notes
sessionKey string Y

Request Body

Request object type : AddSubPackageItemRequest

Request object type AddSubPackageItemRequest has the following properties.
Property Name Data Type Length Required Readonly Notes
LeaveSingleSeats boolean Y When set to True, the best seating function is allowed to reserve seats that would leave a single contiguous seat available. When set to False, the best seating function will not reserve seats that would leave a single contiguous seat available.
NumberOfSeats integer Y The number of seats to be added to the cart for the request.
ParentSuperPackageLineItemId integer N If the line item being added is an alternate/upgrade line item pass the line item ID of parent super package line item.
PriceType string Y The price type for the package. If multiple seats are being requested different price types can be used for each seat by passing a comma separated list of price types.When using multiple price types, a price type must be specified for each seat even if some seats are using the same price type.For example, if there are 4 seats, two at the Adult and two at the Child price type, 4 price type IDs must be passed. The price types passed must be valid for the current mode of sale.
FK: TR_PRICE_TYPE.id   Resource: PriceTypes
PriceTypeReason string N Price Type reasons (Comp Codes) for use with price types that require them. If multiple seats are being requested with different price types, the price type reasons can be specified in a list, matching the price types.
FK: TR_COMP_CODE.id   Resource: PriceTypeReasons
RequestedSeats string N The ID numbers (seat_no) of specific seats to reserve. Muliple seat numbers can be passed as a comma separated list. If no value is passed seats are reserved using the best seating function.
SubPackageId integer Y The ID number of the sub package to be added to cart. The super package ID number should not be used.
FK: T_PKG.pkg_no   Resource: Packages
SuperPackageLineItemId integer Y The super package line item ID of the super package to which the sub packages are being added. For the first sub package added the value should be 0. The super package line item is generated then and its ID returned for use with the remaining sub packages.
Unseated boolean Y When set to True, seats will not be assigned. When set to False, seats will be assigned.
ZoneId integer Y The ID number of the desired price zone for the request. A value of 0 can be passed. When reserving specific seats, the zone of the specified seats overrides whatever zone value is passed here. As the parameter is required but essentially irrelevant, you can pass a value of 0 to meet the requirement.
FK: T_ZONE.zone_no   Resource: Zones 
{
  "ParentSuperPackageLineItemId": 1,
  "SuperPackageLineItemId": 2,
  "PriceType": "sample string 3",
  "PriceTypeReason": "sample string 4",
  "SubPackageId": 5,
  "NumberOfSeats": 6,
  "ZoneId": 7,
  "RequestedSeats": "sample string 8",
  "LeaveSingleSeats": true,
  "Unseated": true
}
<AddSubPackageItemRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <LeaveSingleSeats>true</LeaveSingleSeats>
  <NumberOfSeats>6</NumberOfSeats>
  <ParentSuperPackageLineItemId>1</ParentSuperPackageLineItemId>
  <PriceType>sample string 3</PriceType>
  <PriceTypeReason>sample string 4</PriceTypeReason>
  <RequestedSeats>sample string 8</RequestedSeats>
  <SubPackageId>5</SubPackageId>
  <SuperPackageLineItemId>2</SuperPackageLineItemId>
  <Unseated>true</Unseated>
  <ZoneId>7</ZoneId>
</AddSubPackageItemRequest>

Response object type : AddSubPackageItemResponse

Response object type AddSubPackageItemResponse has the following properties.
Property Name Data Type Length Required Readonly Notes
LineItemId integer
SuperPackageLineItemId integer 
{
  "LineItemId": 1,
  "SuperPackageLineItemId": 2
}
<AddSubPackageItemResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <LineItemId>1</LineItemId>
  <SuperPackageLineItemId>2</SuperPackageLineItemId>
</AddSubPackageItemResponse>
Change Version Description Contract Old New
Parameter Changed 15.0.0 sessionKey has been marked as required. Required