This method will get a list of prices for an item that is on sale. A customer ID or member ID is required to list prices based on benefits. The order ID and transaction ID are used to determine current ticket quantities on an in process 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
type
int
The type of items to list (1 – Event, 2 – Product, 9 – Membership, 11 – Donation, 12 – Gift Card)
itemID
long
The ID of the item
buyerTypeID
int
The buyer type ID
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
memberID
long
optional
The member ID for member benefits
inventoryGroupID
int
optional
The inventory group ID to access non-default or restricted inventory
Return Values
A list of price group data structures with the following fields
ItemID
long
The Item ID
GroupType
string
Tier, SKU, SuggestedAmounts, Level
PriceGroupID
long
Price Group ID (i.e. TierID, SkuID, or not used)
Name
string
Name of Pricing Group
SalesLineTypeName
string
Name of Sales Line Type
SalesLineTypeID
int
ID of Sales Line Type
HTMLDisplayColor
String
Color for an item (e.g. FFFFFF)
AvailableQty
int
Available quantity of group
UnlimitedQty
bool
Indicates that group has an unlimited quantity
IsAdmission
bool
Indicates if group is for event admission
IsSeated
bool
Indicates if group is for seated events
ShowAvailableQty
bool
Indicates the customer should see available quantity
SoldOutText
string
The text to show when none are available
Time
hh:mm AM/PM string
(Event Only) The specific time for the event tier
DisplaySequence
int
The display sequence for sorting
Prices
list
The list of prices available for sales
PriceID
int
The ID for the item's price
BuyerTypeID
int
The Buyer Type ID
Type
string
The type of price
Price
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 price type (A value of -1 means it is not being used)
MaxPerOrder
int
The maximum quantity required for this price type (A value of -1 means it is not being used)
PromoCodeRequired
bool
Indicates that a promo code is required
DisplaySequence
int
The display sequence for sorting
Description
string
The description for this price
Fee
decimal
The fee amount
VariableMinAmount
decimal
The variable price minimum value amount (A value of -1 means it is not being used)
VariableMaxAmount
decimal
The variable price maximum value amount (A value of -1 means it is not being used)
IsRenewal
bool
(Membership Only) Indicates that the price is for renewals only
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/json/ItemListPrices?appkey={APPKEY}&userkey={USERKEY}&corporgid={CORPORGID}&type={ITEMTYPE}&itemid={ITEMID}&buyertypeid={BUYERTYPEID}&promocode={PROMOCODE}&customerid={CUSTOMERID}
Example JSON Response
[{
"ItemID":9223372036854775807,
"GroupType":"String content",
"PriceGroupID":2147483647,
"Name":"String content",
"SalesLineTypeName":"String content",
"SalesLineTypeID":2147483647,
"HTMLDisplayColor":"FFFFFF",
"AvailableQty":2147483647,
"UnlimitedQty":true,
"IsAdmission":true,
"IsSeated":true,
"ShowAvailableQty":true,
"SoldOutText":"String content",
"Time": "String content",
"DisplaySequence":2147483647,
"Prices":[{
"PriceID":2147483647,
"BuyerTypeID":2147483647,
"Type": "String content",
"Price": "0.0",
"RestrictionLevel": 2147483647,
"MinPerOrder": 2147483647,
"MaxPerOrder": 2147483647,
"PromoCodeRequired": false,
"DisplaySequence": 2147483647,
"Description": "String content",
"Fee": 0,
"VariableMinAmount": -1,
"VariableMaxAmount": -1,
"IsRenewal":false
}]
}]
Example XML Response
<ArrayOfSalesPriceGroup xmlns="http://www.agiletix.com/api">
<SalesPriceGroup>
<ItemID>2147483647</ItemID>
<GroupType>Tier</GroupType>
<PriceGroupID>2147483647</PriceGroupID>
<Name>GString content</Name>
<SalesLineTypeName>String content</SalesLineTypeName>
<SalesLineTypeID>2147483647</SalesLineTypeID>
<HtmlDisplayColor>FFFF00</HtmlDisplayColor>
<AvailableQty>199</AvailableQty>
<IsAdmission>true</IsAdmission>
<IsSeated>false</IsSeated>
<ShowAvailableQty>false</ShowAvailableQty>
<SoldOutText>String content</SoldOutText>
<Time>12:00 AM</Time>
<DisplaySequence>1</DisplaySequence>
<Prices>
<SalesItemPrice>
<PriceID>2147483647</PriceID>
<BuyerTypeID>2147483647</BuyerTypeID>
<Type>String content</Type>
<Price>11.5000</Price>
<RestrictionLevel>0</RestrictionLevel>
<MinPerOrder>0</MinPerOrder>
<MaxPerOrder>10</MaxPerOrder>
<PromoCodeRequired>false</PromoCodeRequired>
<DisplaySequence>0</DisplaySequence>
<Description>String content</Description>
<Fee>1.0000</Fee>
<VariableMinAmount>-1</VariableMinAmount>
<VariableMaxAmount>-1</VariableMaxAmount>
</SalesItemPrice>
</Prices>
</SalesPriceGroup>
</ArrayOfSalesPriceGroup>
Comments