Products Test
TXN/Products/Search
Search for products based on a set of criteria.
Http Verb POST
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/TXN/Products/Search

URI Parameters

This resource has no URI (Query) parameters.

Request Body

Request object type : ProductSearchRequest

Request object type ProductSearchRequest has the following properties.
Property Name Data Type Length Required Readonly Notes
ArtistId integer N
FK: TR_LANG.id   Resource: Languages
BusinessUnitId integer N
FK: TR_BU.id   Resource: BusinessUnits
ComposerId integer N
FK: TR_COMPOSER.id   Resource: Composers
ConstituentId integer N
FK: T_CUSTOMER.customer_no   Resource: Constituents
DayOfWeek string One of SUN, MON, TUE, WED, THU, FRI, SAT.
EndDateRange date
EndDateRangePackage date
FacilityId integer N
FK: T_FACILITY.facil_no   Resource: Facilities
FullText string
FullTextType string The default is 'F' (FreeTextTable). You can pass a value of 'C' to search using ContainsTable.
IsWebSearch boolean Controls filtering by Web Publish dates on performances. When this flag is passed as True, performances where the current date is outside the web publish date range will not be returned or considered to be in packages.
KeywordAndOr integer 1 = OR and 2 = AND.
KeywordDescriptions string N Comma separated list of keyword descriptions.
FK: TR_TKW.id
KeywordId integer N
FK: TR_TKW.id
Keywords string N Comma separated list of keywords. If a keyword number is passed in KeywordId or a string of Keywords is passed in Keywords and PackageId related search fileds are specified, the package will be returned if the production elements for the performance contain the keyword OR if the package contains the keyword.
FK: TR_TKW.id
LanguageId integer N
FK: TR_LANG.id   Resource: Languages
ModeOfSaleId integer N
FK: TR_MOS.id   Resource: ModesOfSale
OneOrAllPerformancesInPackage string Possible values are ONE, ALL, PKG. Do not send a value for performance search. PKG : Search based on package criteria. ONE : Search for packages with performance criteria and include packages where at least one of the performances in the package matches. ALL : Search for packages with performance criteria and include packages where all the performances in the package match.
OnSaleOnly boolean If a value of true is sent, only the products on sale would be returned.
PackageId integer N
FK: T_PKG.pkg_no   Resource: Packages
PackageIds string N A list of valid package Ids.
FK: T_PACKAGE.pkg_no   Resource: Packages
PackageSeasonId integer N
FK: TR_SEASON.id   Resource: Seasons
PackageTypeId integer N
FK: TR_PKG_TYPE.id   Resource: PackageTypes
PerformanceIds string N A list of valid performances ids.
FK: T_PERF.perf_no   Resource: Performances
ProductionSeasonId integer
ProductionSeasonIds string N A list of valid product seasons ids.
FK: T_PROD_SEASON.prod_season_no   Resource: ProductionSeasons
SeasonId integer N
FK: TR_SEASON.id   Resource: Seasons
SeasonIds string N A list of valid season Ids.
FK: TR_SEASON.id   Resource: Seasons
ShowAll boolean Overrides the publish dates for Season Maintenance.
ShowConstituentAvailability boolean If a value of true is sent, Total product availability for the specified constituent (ConstituentId parameter) will be included in the response.
ShowGrossAvailability boolean If a value of true is sent, Total product availability will be included in the response.
StartDateRange date
StartDateRangePackage date
TimeSlotId integer N
FK: TR_TIME_SLOT.id   Resource: TimeSlots
TitleId integer N
FK: T_TITLE.title_no   Resource: Titles 
{
  "ConstituentId": 1,
  "TitleId": 1,
  "StartDateRange": "2025-04-24T05:30:32.5489103-07:00",
  "EndDateRange": "2025-04-24T05:30:32.5489103-07:00",
  "TimeSlotId": 1,
  "ComposerId": 1,
  "LanguageId": 1,
  "ArtistId": 1,
  "KeywordId": 1,
  "FacilityId": 1,
  "OneOrAllPerformancesInPackage": "sample string 1",
  "DayOfWeek": "sample string 2",
  "SeasonIds": "sample string 3",
  "SeasonId": 1,
  "ModeOfSaleId": 1,
  "OnSaleOnly": true,
  "ShowGrossAvailability": true,
  "ShowConstituentAvailability": true,
  "BusinessUnitId": 1,
  "ProductionSeasonIds": "sample string 7",
  "ProductionSeasonId": 1,
  "PerformanceIds": "sample string 8",
  "PackageSeasonId": 1,
  "PackageIds": "sample string 9",
  "PackageId": 1,
  "PackageTypeId": 1,
  "StartDateRangePackage": "2025-04-24T05:30:32.5489103-07:00",
  "EndDateRangePackage": "2025-04-24T05:30:32.5489103-07:00",
  "Keywords": "sample string 10",
  "KeywordAndOr": 1,
  "KeywordDescriptions": "sample string 11",
  "ShowAll": true,
  "FullText": "sample string 13",
  "FullTextType": "sample string 14",
  "IsWebSearch": true
}
<ProductSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <ArtistId>1</ArtistId>
  <BusinessUnitId>1</BusinessUnitId>
  <ComposerId>1</ComposerId>
  <ConstituentId>1</ConstituentId>
  <DayOfWeek>sample string 2</DayOfWeek>
  <EndDateRange>2025-04-24T05:30:32.5489103-07:00</EndDateRange>
  <EndDateRangePackage>2025-04-24T05:30:32.5489103-07:00</EndDateRangePackage>
  <FacilityId>1</FacilityId>
  <FullText>sample string 13</FullText>
  <FullTextType>sample string 14</FullTextType>
  <IsWebSearch>true</IsWebSearch>
  <KeywordAndOr>1</KeywordAndOr>
  <KeywordDescriptions>sample string 11</KeywordDescriptions>
  <KeywordId>1</KeywordId>
  <Keywords>sample string 10</Keywords>
  <LanguageId>1</LanguageId>
  <ModeOfSaleId>1</ModeOfSaleId>
  <OnSaleOnly>true</OnSaleOnly>
  <OneOrAllPerformancesInPackage>sample string 1</OneOrAllPerformancesInPackage>
  <PackageId>1</PackageId>
  <PackageIds>sample string 9</PackageIds>
  <PackageSeasonId>1</PackageSeasonId>
  <PackageTypeId>1</PackageTypeId>
  <PerformanceIds>sample string 8</PerformanceIds>
  <ProductionSeasonId>1</ProductionSeasonId>
  <ProductionSeasonIds>sample string 7</ProductionSeasonIds>
  <SeasonId>1</SeasonId>
  <SeasonIds>sample string 3</SeasonIds>
  <ShowAll>true</ShowAll>
  <ShowConstituentAvailability>true</ShowConstituentAvailability>
  <ShowGrossAvailability>true</ShowGrossAvailability>
  <StartDateRange>2025-04-24T05:30:32.5489103-07:00</StartDateRange>
  <StartDateRangePackage>2025-04-24T05:30:32.5489103-07:00</StartDateRangePackage>
  <TimeSlotId>1</TimeSlotId>
  <TitleId>1</TitleId>
</ProductSearchRequest>

Response object type : Collection of ProductSearchResponse

Response object type Collection of ProductSearchResponse has the following properties.
Property Name Data Type Length Required Readonly Notes
AvailabilityByConstituent integer
BusinessUnitId integer
Description string
EndDateTime date
FacilityId integer
FirstDateTime date
GrossAvailability integer
IsFixedSeatPackage boolean
IsFlexPackage boolean
IsOnSale boolean
IsSuperPackage boolean
LastDateTime date
PackageCode string
PackageDateTime date
PackageId integer
PerformanceCode string
PerformanceDate date
PerformanceId integer
PerformanceStatusId integer
ProductionSeasonDescription string
ProductionSeasonId integer
ProductShortDescription string
ProductTypeDescription string
ProductTypeId integer
SearchRelevance integer
SearchWeight integer
SeasonDescription string
SeasonId integer
StartDateTime date
TimeSlotId integer
ZoneMapId integer 
[
  {
    "PackageId": 1,
    "PerformanceId": 2,
    "PackageCode": "sample string 3",
    "PerformanceCode": "sample string 4",
    "PerformanceDate": "2025-04-24T05:30:32.5801457-07:00",
    "GrossAvailability": 6,
    "AvailabilityByConstituent": 7,
    "FacilityId": 8,
    "TimeSlotId": 9,
    "Description": "sample string 10",
    "IsOnSale": true,
    "BusinessUnitId": 12,
    "ProductionSeasonId": 13,
    "IsFixedSeatPackage": true,
    "ZoneMapId": 15,
    "StartDateTime": "2025-04-24T05:30:32.5801457-07:00",
    "EndDateTime": "2025-04-24T05:30:32.5801457-07:00",
    "FirstDateTime": "2025-04-24T05:30:32.5801457-07:00",
    "LastDateTime": "2025-04-24T05:30:32.5801457-07:00",
    "SearchWeight": 20,
    "IsSuperPackage": true,
    "IsFlexPackage": true,
    "ProductTypeId": 23,
    "ProductTypeDescription": "sample string 24",
    "PerformanceStatusId": 25,
    "SearchRelevance": 26,
    "SeasonId": 27,
    "SeasonDescription": "sample string 28",
    "ProductionSeasonDescription": "sample string 29",
    "ProductShortDescription": "sample string 30",
    "PackageDateTime": "2025-04-24T05:30:32.5801457-07:00"
  },
  {
    "PackageId": 1,
    "PerformanceId": 2,
    "PackageCode": "sample string 3",
    "PerformanceCode": "sample string 4",
    "PerformanceDate": "2025-04-24T05:30:32.5801457-07:00",
    "GrossAvailability": 6,
    "AvailabilityByConstituent": 7,
    "FacilityId": 8,
    "TimeSlotId": 9,
    "Description": "sample string 10",
    "IsOnSale": true,
    "BusinessUnitId": 12,
    "ProductionSeasonId": 13,
    "IsFixedSeatPackage": true,
    "ZoneMapId": 15,
    "StartDateTime": "2025-04-24T05:30:32.5801457-07:00",
    "EndDateTime": "2025-04-24T05:30:32.5801457-07:00",
    "FirstDateTime": "2025-04-24T05:30:32.5801457-07:00",
    "LastDateTime": "2025-04-24T05:30:32.5801457-07:00",
    "SearchWeight": 20,
    "IsSuperPackage": true,
    "IsFlexPackage": true,
    "ProductTypeId": 23,
    "ProductTypeDescription": "sample string 24",
    "PerformanceStatusId": 25,
    "SearchRelevance": 26,
    "SeasonId": 27,
    "SeasonDescription": "sample string 28",
    "ProductionSeasonDescription": "sample string 29",
    "ProductShortDescription": "sample string 30",
    "PackageDateTime": "2025-04-24T05:30:32.5801457-07:00"
  }
]
<ProductSearchResponses xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <ProductSearchResponse>
    <AvailabilityByConstituent>7</AvailabilityByConstituent>
    <BusinessUnitId>12</BusinessUnitId>
    <Description>sample string 10</Description>
    <EndDateTime>2025-04-24T05:30:32.5801457-07:00</EndDateTime>
    <FacilityId>8</FacilityId>
    <FirstDateTime>2025-04-24T05:30:32.5801457-07:00</FirstDateTime>
    <GrossAvailability>6</GrossAvailability>
    <IsFixedSeatPackage>true</IsFixedSeatPackage>
    <IsFlexPackage>true</IsFlexPackage>
    <IsOnSale>true</IsOnSale>
    <IsSuperPackage>true</IsSuperPackage>
    <LastDateTime>2025-04-24T05:30:32.5801457-07:00</LastDateTime>
    <PackageCode>sample string 3</PackageCode>
    <PackageDateTime>2025-04-24T05:30:32.5801457-07:00</PackageDateTime>
    <PackageId>1</PackageId>
    <PerformanceCode>sample string 4</PerformanceCode>
    <PerformanceDate>2025-04-24T05:30:32.5801457-07:00</PerformanceDate>
    <PerformanceId>2</PerformanceId>
    <PerformanceStatusId>25</PerformanceStatusId>
    <ProductShortDescription>sample string 30</ProductShortDescription>
    <ProductTypeDescription>sample string 24</ProductTypeDescription>
    <ProductTypeId>23</ProductTypeId>
    <ProductionSeasonDescription>sample string 29</ProductionSeasonDescription>
    <ProductionSeasonId>13</ProductionSeasonId>
    <SearchRelevance>26</SearchRelevance>
    <SearchWeight>20</SearchWeight>
    <SeasonDescription>sample string 28</SeasonDescription>
    <SeasonId>27</SeasonId>
    <StartDateTime>2025-04-24T05:30:32.5801457-07:00</StartDateTime>
    <TimeSlotId>9</TimeSlotId>
    <ZoneMapId>15</ZoneMapId>
  </ProductSearchResponse>
  <ProductSearchResponse>
    <AvailabilityByConstituent>7</AvailabilityByConstituent>
    <BusinessUnitId>12</BusinessUnitId>
    <Description>sample string 10</Description>
    <EndDateTime>2025-04-24T05:30:32.5801457-07:00</EndDateTime>
    <FacilityId>8</FacilityId>
    <FirstDateTime>2025-04-24T05:30:32.5801457-07:00</FirstDateTime>
    <GrossAvailability>6</GrossAvailability>
    <IsFixedSeatPackage>true</IsFixedSeatPackage>
    <IsFlexPackage>true</IsFlexPackage>
    <IsOnSale>true</IsOnSale>
    <IsSuperPackage>true</IsSuperPackage>
    <LastDateTime>2025-04-24T05:30:32.5801457-07:00</LastDateTime>
    <PackageCode>sample string 3</PackageCode>
    <PackageDateTime>2025-04-24T05:30:32.5801457-07:00</PackageDateTime>
    <PackageId>1</PackageId>
    <PerformanceCode>sample string 4</PerformanceCode>
    <PerformanceDate>2025-04-24T05:30:32.5801457-07:00</PerformanceDate>
    <PerformanceId>2</PerformanceId>
    <PerformanceStatusId>25</PerformanceStatusId>
    <ProductShortDescription>sample string 30</ProductShortDescription>
    <ProductTypeDescription>sample string 24</ProductTypeDescription>
    <ProductTypeId>23</ProductTypeId>
    <ProductionSeasonDescription>sample string 29</ProductionSeasonDescription>
    <ProductionSeasonId>13</ProductionSeasonId>
    <SearchRelevance>26</SearchRelevance>
    <SearchWeight>20</SearchWeight>
    <SeasonDescription>sample string 28</SeasonDescription>
    <SeasonId>27</SeasonId>
    <StartDateTime>2025-04-24T05:30:32.5801457-07:00</StartDateTime>
    <TimeSlotId>9</TimeSlotId>
    <ZoneMapId>15</ZoneMapId>
  </ProductSearchResponse>
</ProductSearchResponses>
Change Version Description Contract Old New
Property Added 15.0.0 IsWebSearch has been added to ProductSearchRequest ProductSearchRequest ProductSearchRequest.IsWebSearch