On This Page

Item Schema Reference

Purpose

The Item table contains Auction items and their details.

Fields

Other Fields

Name Type Descriptions
AllowOnlineBiddingBool
AllowPreBiddingBool
AttachmentsString
AuctionAuction Schema Reference
AutoLinkGuestsBool[ "When a single purchase results in multiple guests being created, assign all those guests the same paddle#" ]
BasketItemItem Schema Reference
BiddingClosedBool
BiddingClosedAtDateTime
BidIncrementDouble
BidSheetTextString[ "If set, this text is used on the bid sheet instead of the description." ]
BuyItNowPriceDouble[ "Provide a price the bidder can bid to immediately win the item and stop bidding" ]
CalculatedValueDouble
CatalogTextString[ "If set, this text is used in the event catalog instead of the description." ]
CertificateTextString[ "If set, this text is used on the certificate instead of the description." ]
ClosingModeEnum[ "Controls how the items closes as part of online bidding. This field is intended for use with the virtual live auction controller" ]
ClosingTimeString[ "Silent auction item (or table) closing time. This will NOT affect online bidding for the item." ]
ConsignmentCategoryConsignmentCategory Schema Reference [ "Specify rules for creating expenses when this item is sold" ]
ConsignmentMaximumDouble[ "The maximum cost of the expense generated when this item is sold" ]
ConsignmentMinimumDouble[ "The minimum cost of the expense generated when this item is sold" ]
CouponsString[ "Coupon codes that can be used with this item" ]
CreatedAtDateTime
CreatedByString
DescriptionString
DisplayIdString
DisplayPageTextString[ "If set, this text is used on the display page instead of the description." ]
DonationLevelsString[ "For donation items: specify a comma separated list of donation levels you want to accept, for example 100,500,1000. Include ',*' at the end to allow a custom amount to be entered.I" ]
DonorDonor Schema Reference
EventLocationString[ "For items that are scheduled events, this is the location it will take place" ]
EventStartTimeDateTime[ "For items that are scheduled events, this is the date of the event" ]
EventStartTimeTextString[ "For items that are scheduled events, this is the time of the event" ]
ExcludeFromCatalogBool[ "Always exclude this item from the website and event catalog" ]
FundraisingTargetDouble[ "Mostly used for donation/for-sale items: the amount you are looking to raise with this item which will be shown publicly" ]
HasBiddingTypeBool
HasReserveBool
HasTimedClosingBool
HasWinningBidsBool
HighlightBool
IdGuid
ImageString
IncomeCategoryString
IsCertificateBool
IsCompositeBool[ "This field indicates the lot is a basket or package, containing partial items or other for sale items." ]
IsEventBool[ "This item represents a scheduled event, eg. a concert or dinner party, that is happening at a specific time" ]
IsSponsorshipBool
IsTableTicketBool[ "When this item is sold, create a table based on the number of tickets and automatically seat the guests at it" ]
ItemCategoryItemCategory Schema Reference
LastModifiedAtDateTime
LastModifiedByString
LiveNumberInt
LocalIdGuid
LocationString[ "Location of this item within the auction, eg. the silent auction table" ]
MaxPerBidderInt[ "Maximum number that can be bought by a participant (multiples only)" ]
MultipleWinnersBool[ "This lot can be won by multiple bidders." ]
NotesString
NumberString
Online_PurchasePageBool
Online_RegistrationPageBool[ "Show this item in the default purchase element in the standard website templates" ]
OnlineBiddingEndDateTime
OnlineBiddingStartDateTime
OnlinePurchaseModeEnum
OnlineVisibilityEndDateTime
OnlineVisibilityStartDateTime
PrintBidSheetBool
QuantityInt[ "Enter the available quantity. Leave blank or enter 0 to specify an unlimited amount. For Online Items, a blank quantity implies a single item. For multiple winners, enter the exact amount available." ]
RaffleRaffle Schema Reference
ReceiptIssuedBool
ReceiptRequiredBool
ReceiptValueDouble[ "Receiptable value, if different from the item's value. Leave blank if the same" ]
ReferenceString[ "Enter any external reference for the item" ]
ReserveDouble
SalesTaxCategorySalesTaxCategory Schema Reference
ShippingCostDouble[ "Amount to charge for shipping to winners of this item" ]
SolicitorString[ "Used for the name of the person that approached the donor about this donation" ]
StartingBidDouble
StatementTextString[ "This text will be shown on the statements." ]
TaxableValueDouble[ "Amount of item's value that is considered taxable. Leave blank or use 0 to use the full value." ]
TermsAndConditionsString[ "Describe any specific terms and conditions participants should be aware of" ]
TicketsPerInt[ "Number of tickets that a purchase of this item represents. The 'Ticket Type' field controls the kind of tickets generated." ]
TicketTitleString
TicketTypeEnum
TitleString
TypeEnum
ValueDouble[ "Enter the item's value, or -1 to show 'Priceless' on bidsheets, etc." ]
WinningBid_MaximumDouble
WinningBids_AmountDouble
WinningBids_CountInt

Last reviewed: July 2025
SchemaItem
/advanced/schema_reference/item_schema_reference/
advanced
schema_reference
item_schema_reference
Item Schema Reference