Follow

API Method - Item List

This method will get a list of items for sale. If the optional item level organization/folder ID is defined only the items in that org/folder will be returned. If the optional buyer type ID is defined only the items on sale for that buyer type will be returned.
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, 100 - Shows)
itemOrgID
 
int
 
optional
The item level organization/folder ID
buyerTypeID
 
int
 
optional
The buyer type ID
startDate
 
datetime
optional - Except for Events
The start date for listing items
endDate
 
datetime
optional - Except for Events
The end date for listing items
Return Values
A list of item data structures with the following fields
ID
 
long
The item ID
Name
 
string
Name of the item
Internal Name
 
string
Internal Name of the item
Type
 
int
The type of the item (1 – Event, 2 – Product, 9 – Membership, 11 – Donation, 12 – Gift Card, 100 - Shows)
CorpOrgID
 
int
ID of the corp organization
CorpOrgName
 
string
Name of the corp organization
FolderID
 
int
ID of the folder containing the item
Description
 
string
The description of the item
ShortDescription
 
string
The short description of the item
ShortDescriptive1
 
string
The supporting text for an item name
ShortDescriptive2
 
string
The supporting text for an event date/time
ExtraHTML
 
string
The extra HTML/Text for the item
PurchasePrompt
 
string
Text to prompt customer for purchase
MoreInfoPrompt
 
string
Text for user to click for additional information
SalesState
 
int
The current sales status (1 – Before sales, 2 – Available for sales, 3 – After sales but before the event, 4 – After event, 5 – Display custom message)
SalesMessage
 
string
The current sales message to display
HTMLDisplayColor
 
string
Color for an item (e.g. FFFFFF)
ExternalID
 
string
(Event Only) External ID for the event
StartDateTime
 
YYYY-MM-DDThh:mm:ss string (ISO 8601)
(Event Only) The start date/time of the event formatted as YYYY-MM-DDThh:mm:ss
EndDateTime
 
YYYY-MM-DDThh:mm:ss string (ISO 8601)
(Event Only) The end date/time of the event formatted as YYYY-MM-DDThh:mm:ss
Duration
 
int
(Event Only) The duration in minutes of the event
DateTBD
 
bool
(Event Only) The date/time of the event is still to be determined
DisplayTime
 
bool
(Event Only) The time should be shown when displaying the event
DisplayEndDate
 
bool
(Event Only) The end date should be shown when displaying the event
VenueID
 
int
(Event Only) The venue ID
VenueName
 
string
(Event Only) The name of the venue
GroupID
 
int
(Catalog Only) ID of the catalog group
GroupName
 
string
(Catalog Only) Name of the catalog group
PledgeThreshold
 
int
(Donation Only) Minimum required to donate to be able to pledge
AllowOpenEntry
 
bool
(Donation / Gift Card Only) The customer should be allowed to input custom value
ShowTimes
 
list
(Show Only) List of show times for a show
ID
 
int
The ID for the show time
OrgID
 
int
The org/folder ID
DateTBD
 
bool
Indicates if the exact date is still to be determined
StartDateTime
 
YYYY-MM-DDThh:mm:ss string (ISO 8601)
The start date/time of the event formatted as YYYY-MM-DDThh:mm:ss
EndDateTime
 
YYYY-MM-DDThh:mm:ss string (ISO 8601)
The start date/time of the event formatted as YYYY-MM-DDThh:mm:ss
Duration
 
int
The duration in minutes
ShortDescriptive
 
string
The supporting text for an event date/time
SalesMessage
 
string
The current sales message to display
SalesState
 
string
The current sales status (1 – Before sales, 2 – Available for sales, 3 – After sales but before the event, 4 – After event, 5 – Display custom message)
PurchasePrompt
 
string
The "Buy" prompt to show the customer to start the purchase process
MoreInfoPrompt
 
string
The "More Info" prompt to show the customer to view more details
VenueID
 
int
The venue ID
VenueName
 
string
The name of the venue
ContentDelivery
 
string
Whether the showtime is for In Person or Streaming
CustomProperties
 
list
List of custom properties for this show time
ID
 
int
The custom property ID
Group
 
string
The grouping value for the custom property
Name
 
string
The custom property name
Value
 
string
The custom value for this show
Hidden
 
bool
Indicates whether this custom property should be visible to the end customer or just internal
Sequence
 
int
The sequence order for sorting
Media
 
list
A list of additional images, html, or trailers for the show
Caption
 
string
The caption to show with the media or image
MainDuplicate
 
bool
Indicates this is the same as the main image
Sequence
 
int
The sequence order for sorting
Type
 
string
The type of media (Image, HTML, YouTube, Vimeo)
Value
 
string
The raw URL or html value
MediaEmbed
 
string
The formatted html for embed
CustomProperties
 
list
A list of custom property data structures with the following fields
ID
 
int
The custom property ID
Group
 
string
The grouping value for the custom property
Name
 
string
The custom property name
Value
 
string
The custom value for this show
Hidden
 
bool
Indicates whether this custom property should be visible to the end customer or just internal
Sequence
 
int
The sequence order for sorting
RelatedItems
 
list
A list of related events or shorts
ID
 
long
The related event ID
OrgID
 
int
The event level organization ID
Name
 
string
The name of the event
UntilDate
 
datetime
The date of the related event
Duration
 
int
The duration of the event in minutes
ShortDescriptive
 
string
The supporting text for the event name
Description
 
string
The description of the event
ImageURL
 
string
The image URL
ThumbnailURL
 
string
The thumbnail image URL
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/ItemList?appkey={APPKEY}&userkey={USERKEY}&corporgid={CORPORGID}&type={ITEMTYPE}&itemorgid={ITEMORGID}&buyertypeid={BUYERTYPEID}&startdate={STARTDATE}&enddate={ENDDATE}
Example JSON Response
[{
	"ID":9223372036854775807,
	"Name":"String content",
	"InternalName":"String content",
	"Type":1,
	"CorpOrgID":2147483647,
	"CorpOrgName":"String content",
	"FolderID":2147483647,
	"Description":"String content",
	"ShortDescription":"String content",
	"ShortDescriptive1":"String content",
	"ShortDescriptive2":"String content",
	"ExtraHTML":"String content",
	"PurchasePrompt":"String content",
	"MoreInfoPrompt":"String content",
	"SalesState":"2",
	"SalesMessage":"String content",
	"HTMLDisplayColor":"FFFFFF",
	"ExternalID":"String content",
	"StartDateTime":"YYYY-MM-DDThh:mm:ss",
	"EndDateTime":"YYYY-MM-DDThh:mm:ss",
	"Duration":2147483647,
	"DateTBD":true,
	"DisplayTime":true,
	"DisplayEndDate":true,
	"VenueID":2147483647,
	"VenueName":"String content",
	"GroupID":2147483647,
	"GroupName":"String content",
	"PledgeThreshold":2147483647,
	"AllowOpenEntry":true,
	"ShowTimes":[{
		"ID":2147483647,
		"OrgID":2147483647,
		"DateTBD":true,
		"StartDateTime":"YYYY-MM-DDThh:mm:ss",
		"EndDateTime":"YYYY-MM-DDThh:mm:ss",
		"Duration":2147483647,
		"ShortDescriptive":"String content",
		"SalesState":"2",
		"SalesMessage":"String content",
		"PurchasePrompt":"String content",
		"MoreInfoPrompt":"String content",
		"VenueID":2147483647,
		"VenueName":"String content",
		"ContentDelivery":"String content",
		"CustomProperties":[{
			"ID":2147483647,
			"Group":"String content",
			"Name":"String content",
			"Value":"String content",
			"Hidden":true,
			"Sequence":2147483647
		}]
	}],
	"Media":[{
		"Caption":"String content",
		"MainDuplicate":true,
		"Sequence":2147483647,
		"Type":"String content",
		"Value":"String content",
		"MediaEmbed":"String content"
	}],
	"CustomProperties":[{
		"ID":2147483647,
		"Group":"String content",
		"Name":"String content",
		"Value":"String content",
		"Hidden":true,
		"Sequence":2147483647
	}],
	"RelatedItems":[{
		"ID":9223372036854775807,
		"OrgID":2147483647,
		"Name":"String content",
		"UntilDate":"\/Date(928167600000-0500)\/",
		"Duration":2147483647,
		"ShortDescriptive":"String content",
		"Description":"String content",
		"ImageURL":"String content",
		"ThumbnailURL":"String content"
	}]
}]
Example XML Response
<ArrayOfSalesItem xmlns="http://www.agiletix.com/api">
  <SalesItem>
    <ID>9223372036854775807</ID>
    <Name>String content</Name>
    <InternalName>String content</InternalName>
    <Type>1</Type>
    <CorpOrgID>2147483647</CorpOrgID>
    <CorpOrgName>String content</CorpOrgName>
    <FolderID>2147483647</FolderID>
    <Description>String content</Description>
    <ShortDescription>String content</ShortDescription>
    <ShortDescriptive1>String content</ShortDescriptive1>
    <ShortDescriptive2>String content</ShortDescriptive2>
    <ExtraHTML>String content</ExtraHTML>
    <PurchasePrompt>String content</PurchasePrompt>
    <MoreInfoPrompt>String content</MoreInfoPrompt>
    <SalesState>2147483647</SalesState>
    <SalesMessage>String content</SalesMessage>
    <HTMLDisplayColor>FFFFFF</HTMLDisplayColor>
    <ExternalID>String content</ExternalID>
    <StartDate>YYYY-MM-DDThh:mm:ss</StartDate>
    <EndDate>YYYY-MM-DDThh:mm:ss</EndDate>
    <Duration>2147483647</Duration>
    <DateTBD>true</DateTBD>
    <DisplayTime>true</DisplayTime>
    <DisplayEndDate>true</DisplayEndDate>
    <VenueID>2147483647</VenueID>
    <VenueName>String content</VenueName>
    <GroupID>2147483647</GroupID>
    <GroupName>String content</GroupName>
    <PledgeThreshold>2147483647</PledgeThreshold>
    <AllowOpenEntry>true</AllowOpenEntry>
    <ShowTimes>
      <ItemShowTime>
        <ID>2147483647</ID>
        <OrgID>2147483647</OrgID>
        <DateTBD>true</DateTBD>
        <StartDateTime>YYYY-MM-DDThh:mm:ss</StartDateTime>
        <EndDateTime>YYYY-MM-DDThh:mm:ss</EndDateTime>
        <Duration>2147483647</Duration>
        <ShortDescriptive>String content</ShortDescriptive>
        <SalesState>2</SalesState>
        <SalesMessage>String content</SalesMessage>
        <PurchasePrompt>String content</PurchasePrompt>
        <MoreInfoPrompt>String content</MoreInfoPrompt>
        <VenueID>2147483647</VenueID>
        <VenueName>String content</VenueName>
        <ContentDelivery>String content</ContentDelivery>
        <CustomProperties>
          <CustomItemProperty>
            <ID>2147483647</ID>
            <Group>String content</Group>
            <Name>String content</Name>
            <Value>String content</Value>
            <Hidden>true</Hidden>
            <Sequence>2147483647</Sequence>
          </CustomItemProperty>
        </CustomProperties>
      </ItemShowTime>
    </ShowTimes>
    <Media>
      <AdditionalMediaItem>
        <Caption>String content</Caption>
        <MainDuplicate>true</MainDuplicate>
        <MainThumb>false</MainThumb>
        <Sequence>2147483647</Sequence>
        <Type>String content</Type>
        <Value>String content</Value>
        <MediaEmbed>String content</MediaEmbed>
      </AdditionalMediaItem>
    </Media>
    <CustomProperties>
      <CustomItemProperty>
        <ID>2147483647</ID>
        <Group>String content</Group>
        <Name>String content</Name>
        <Value>String content</Value>
        <Hidden>true</Hidden>
        <Sequence>2147483647</Sequence>
      </CustomItemProperty>
    </CustomProperties>
    <AdditionalMedia>
      <AdditionalMediaItem>
        <Caption>String content</Caption>
        <MainDuplicate>true</MainDuplicate>
        <Sequence>2147483647</Sequence>
        <Type>String content</Type>
        <Value>String content</Value>
        <MediaEmbed>String content</MediaEmbed>
      </AdditionalMediaItem>
    </AdditionalMedia>
    <RelatedItems>
      <RelatedEvent>
        <ID>9223372036854775807</ID>
        <OrgID>2147483647</OrgID>
        <Name>String content</Name>
        <UntilDate>1999-05-31T11:20:00</UntilDate>
        <Duration>2147483647</Duration>
        <ShortDescriptive>String content</ShortDescriptive>
        <Description>String content</Description>
        <ImageURL>String content</ImageURL>
        <ThumbnailURL>String content</ThumbnailURL>
      </RelatedEvent>
    </RelatedItems>
  </SalesItem>
</ArrayOfSalesItem>
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments