Follow

API Method - Event List Prices

This method will list the tiers and prices available for an event. A member ID is required to list prices on membership required buyer types. Membership benefits will also be taken into account to list restricted prices not normally available for sales. The order ID and transaction ID are used to determine current ticket quantities on the order. A promo code is required to list restricted promo prices.
Parameters
appKey
 
string
A key identifying the application making the call
userKey
 
string
A key identifying the user making the call
corpOrgID
 
int
The corp organization ID
eventOrgID
 
int
The event level organization ID
eventID
 
int
The event ID
buyerTypeID
 
int
The buyer type ID
memberID
 
long
 
optional
The member ID for member benefits
orderID
 
long
 
optional
The order ID for evaluating quantities
transactionID
 
long
 
optional
The transactionID for evaluating quantities
promoCode
 
string
 
optional
The promo code for restricted promo prices
customerID
 
long
 
optional
The customer ID for account benefits
inventoryGroupID
 
int
 
optional
The inventory group ID to access non-default or restricted inventory
Return Values
A list of tier data structures with the following fields
TierID
 
long
The tier ID
EventID
 
long
The event ID
Name
 
string
The name of the tier
EventAdmission
 
bool
An indicator that this is an admission tier
GeneralAdmission
 
bool
An indicator that this is a general admission tier
SalesLineTypeID
 
int
The sales line type ID
SalesLineTypeName
 
string
The sales line type name
SeatDisplayColor
 
int
The color used for seating
AvailableQty
 
int
The available quantity in open inventory
ShowAvailableQty
 
bool
An indicator to show the available quantity
SoldOutText
 
string
The text to show when no inventory is available
TierTime
 
datetime
The specific time for this tier
DisplaySequence
 
int
The display sequence for sorting
Prices
 
list
A list of event price data structures with the following fields
EventPriceID
 
long
The event price ID
TierID
 
long
The tier ID
BuyerTypeID
 
int
The buyer type ID
TicketType
 
string
The ticket type for this price
BasePrice
 
decimal
The base dollar amount
RestrictionLevel
 
int
The restriction level of the price (0 – Unrestricted price, 1-3 – Restricted prices)
MinPerOrder
 
int
The minimum quantity required for this ticket type (A value of -1 means it is not being used)
MaxPerOrder
 
int
The maximum quantity required for this ticket type (A value of -1 means it is not being used)
PromoCodeRequired
 
bool
An indicator that a promo code is required
DisplaySequence
 
int
The display sequence for sorting
Description
 
string
The description for the price type
FeeAmount
 
decimal
The fee dollar amount
VariableMinAmount
 
decimal
The minimum dollar amount for a customer entered variable price. (A value of -1 means it is not being used)
VariableMaxAmount
 
decimal
The maximum dollar amount for a customer entered variable price. (A value of -1 means it is not being used)
Errors
ApplicationKeyMissing
 
1000
Required parameter appkey is missing or invalid
UserCredentialsMissing
 
1001
Required user credentials are missing or invalid
SecurityInsufficient
 
1002
User security does not permit access to the requested function
RequiredParameter
 
1028
Required parameter is missing
Example Request
https://prod1.agileticketing.net/api/sales.svc/xml/EventListPrices?appkey={APPKEY}&userkey={USERKEY}&corporgid={CORPORGID}&eventorgid={EVENTORGID}&eventID={EVENTID}&buyertypeid={BUYERTYPEID}&memberid={MEMBERID}&orderid={ORDERID}&transactionID={TRANSACTIONID}&promocode={PROMOCODE}
Example JSON Response
[{
	"TierID":9223372036854775807,
	"EventID":9223372036854775807,
	"Name":"String content",
	"EventAdmission":true,
	"GeneralAdmission":true,
	"SalesLineTypeID":2147483647,
	"SalesLineTypeName":"String content",
	"SeatDisplayColor":2147483647,
	"AvailableQty":2147483647,
	"ShowAvailableQty":true,
	"SoldOutText":"String content",
	"TierTime":"\/Date(928167600000-0500)\/",
	"DisplaySequence":2147483647,
	"Prices":[{
		"EventPriceID":9223372036854775807,
		"TierID":9223372036854775807,
		"BuyerTypeID":2147483647,
		"TicketType":"String content",
		"BasePrice":12678967.543233,
		"RestrictionLevel":2147483647,
		"MinPerOrder":2147483647,
		"MaxPerOrder":2147483647,
		"PromoCodeRequired":true,
		"DisplaySequence":2147483647,
		"Description":"String content",
		"FeeAmount":12678967.543233,
		"VariableMinAmount":12678967.543233,
		"VariableMaxAmount":12678967.543233
	}]
}]
Example XML Response
<ArrayOfTier xmlns="http://www.agiletix.com/api">
  <Tier>
    <TierID>9223372036854775807</TierID>
    <EventID>9223372036854775807</EventID>
    <Name>String content</Name>
    <EventAdmission>true</EventAdmission>
    <GeneralAdmission>true</GeneralAdmission>
    <SalesLineTypeID>2147483647</SalesLineTypeID>
    <SalesLineTypeName>String content</SalesLineTypeName>
    <SeatDisplayColor>2147483647</SeatDisplayColor>
    <AvailableQty>2147483647</AvailableQty>
    <ShowAvailableQty>true</ShowAvailableQty>
    <SoldOutText>String content</SoldOutText>
    <TierTime>1999-05-31T11:20:00</TierTime>
    <DisplaySequence>2147483647</DisplaySequence>
    <Prices>
      <EventPrice>
        <EventPriceID>9223372036854775807</EventPriceID>
        <TierID>9223372036854775807</TierID>
        <BuyerTypeID>2147483647</BuyerTypeID>
        <TicketType>String content</TicketType>
        <BasePrice>12678967.543233</BasePrice>
        <RestrictionLevel>2147483647</RestrictionLevel>
        <MinPerOrder>2147483647</MinPerOrder>
        <MaxPerOrder>2147483647</MaxPerOrder>
        <PromoCodeRequired>true</PromoCodeRequired>
        <DisplaySequence>2147483647</DisplaySequence>
        <Description>String content</Description>
        <FeeAmount>12678967.543233</FeeAmount>
        <VariableMinAmount>12678967.543233</VariableMinAmount>
        <VariableMaxAmount>12678967.543233</VariableMaxAmount>
      </EventPrice>
      <EventPrice>
        <EventPriceID>9223372036854775807</EventPriceID>
        <TierID>9223372036854775807</TierID>
        <BuyerTypeID>2147483647</BuyerTypeID>
        <TicketType>String content</TicketType>
        <BasePrice>12678967.543233</BasePrice>
        <RestrictionLevel>2147483647</RestrictionLevel>
        <MinPerOrder>2147483647</MinPerOrder>
        <MaxPerOrder>2147483647</MaxPerOrder>
        <PromoCodeRequired>true</PromoCodeRequired>
        <DisplaySequence>2147483647</DisplaySequence>
        <Description>String content</Description>
        <FeeAmount>12678967.543233</FeeAmount>
        <VariableMinAmount>12678967.543233</VariableMinAmount>
        <VariableMaxAmount>12678967.543233</VariableMaxAmount>
      </EventPrice>
    </Prices>
  </Tier>
  <Tier>
    <TierID>9223372036854775807</TierID>
    <EventID>9223372036854775807</EventID>
    <Name>String content</Name>
    <EventAdmission>true</EventAdmission>
    <GeneralAdmission>true</GeneralAdmission>
    <SalesLineTypeID>2147483647</SalesLineTypeID>
    <SalesLineTypeName>String content</SalesLineTypeName>
    <SeatDisplayColor>2147483647</SeatDisplayColor>
    <AvailableQty>2147483647</AvailableQty>
    <ShowAvailableQty>true</ShowAvailableQty>
    <SoldOutText>String content</SoldOutText>
    <TierTime>1999-05-31T11:20:00</TierTime>
    <DisplaySequence>2147483647</DisplaySequence>
    <Prices>
      <EventPrice>
        <EventPriceID>9223372036854775807</EventPriceID>
        <TierID>9223372036854775807</TierID>
        <BuyerTypeID>2147483647</BuyerTypeID>
        <TicketType>String content</TicketType>
        <BasePrice>12678967.543233</BasePrice>
        <RestrictionLevel>2147483647</RestrictionLevel>
        <MinPerOrder>2147483647</MinPerOrder>
        <MaxPerOrder>2147483647</MaxPerOrder>
        <PromoCodeRequired>true</PromoCodeRequired>
        <DisplaySequence>2147483647</DisplaySequence>
        <Description>String content</Description>
        <FeeAmount>12678967.543233</FeeAmount>
        <VariableMinAmount>12678967.543233</VariableMinAmount>
        <VariableMaxAmount>12678967.543233</VariableMaxAmount>
      </EventPrice>
      <EventPrice>
        <EventPriceID>9223372036854775807</EventPriceID>
        <TierID>9223372036854775807</TierID>
        <BuyerTypeID>2147483647</BuyerTypeID>
        <TicketType>String content</TicketType>
        <BasePrice>12678967.543233</BasePrice>
        <RestrictionLevel>2147483647</RestrictionLevel>
        <MinPerOrder>2147483647</MinPerOrder>
        <MaxPerOrder>2147483647</MaxPerOrder>
        <PromoCodeRequired>true</PromoCodeRequired>
        <DisplaySequence>2147483647</DisplaySequence>
        <Description>String content</Description>
        <FeeAmount>12678967.543233</FeeAmount>
        <VariableMinAmount>12678967.543233</VariableMinAmount>
        <VariableMaxAmount>12678967.543233</VariableMaxAmount>
      </EventPrice>
    </Prices>
  </Tier>
</ArrayOfTier>
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments