Item Schema Reference
Purpose
The Item table contains Auction items and their details.
Fields
95 fields
Other Fields
| Name ↑ | Type | Descriptions |
|---|---|---|
| AllowOnlineBidding | Bool | |
| AllowPreBidding | Bool | |
| Attachments | String | |
| Auction | Auction Schema Reference | |
| AutoLinkGuests | Bool | When a single purchase results in multiple guests being created, assign all those guests the same paddle# |
| BasketItem | Item Schema Reference | |
| BiddingClosed | Bool | |
| BiddingClosedAt | DateTime | |
| BidIncrement | Double | |
| BidSheetText | String | If set, this text is used on the bid sheet instead of the description. |
| BuyItNowPrice | Double | Provide a price the bidder can bid to immediately win the item and stop bidding |
| CalculatedValue | Double | |
| CatalogText | String | If set, this text is used in the event catalog instead of the description. |
| CertificateText | String | If set, this text is used on the certificate instead of the description. |
| ClosingMode | Enum | Controls how the items closes as part of online bidding. This field is intended for use with the virtual live auction controller |
| ClosingTime | String | Silent auction item (or table) closing time. This will NOT affect online bidding for the item. |
| ConsignmentCategory | ConsignmentCategory Schema Reference | Specify rules for creating expenses when this item is sold |
| ConsignmentMaximum | Double | The maximum cost of the expense generated when this item is sold |
| ConsignmentMinimum | Double | The minimum cost of the expense generated when this item is sold |
| Coupons | String | Coupon codes that can be used with this item |
| CreatedAt | DateTime | |
| CreatedBy | String | |
| Description | String | |
| DisplayId | String | |
| DisplayPageText | String | If set, this text is used on the display page instead of the description. |
| DonationLevels | String | 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 |
| Donor | Donor Schema Reference | |
| EventLocation | String | For items that are scheduled events, this is the location it will take place |
| EventStartTime | DateTime | For items that are scheduled events, this is the date of the event |
| EventStartTimeText | String | For items that are scheduled events, this is the time of the event |
| ExcludeFromCatalog | Bool | Always exclude this item from the website and event catalog |
| FundraisingTarget | Double | Mostly used for donation/for-sale items: the amount you are looking to raise with this item which will be shown publicly |
| HasBiddingType | Bool | |
| HasReserve | Bool | |
| HasTimedClosing | Bool | |
| HasWinningBids | Bool | |
| Highlight | Bool | |
| Id | Guid | |
| Image | String | |
| IncomeCategory | String | |
| IsCertificate | Bool | |
| IsComposite | Bool | This field indicates the lot is a basket or package, containing partial items or other for sale items. |
| IsEvent | Bool | This item represents a scheduled event, eg. a concert or dinner party, that is happening at a specific time |
| IsSponsorship | Bool | |
| IsTableTicket | Bool | When this item is sold, create a table based on the number of tickets and automatically seat the guests at it |
| ItemCategory | ItemCategory Schema Reference | |
| LastModifiedAt | DateTime | |
| LastModifiedBy | String | |
| LiveNumber | Int | |
| LocalId | Guid | |
| Location | String | Location of this item within the auction, eg. the silent auction table |
| MaxPerBidder | Int | Maximum number that can be bought by a participant (multiples only) |
| MultipleWinners | Bool | This lot can be won by multiple bidders. |
| Notes | String | |
| Number | String | |
| Online_PurchasePage | Bool | |
| Online_RegistrationPage | Bool | Show this item in the default purchase element in the standard website templates |
| OnlineBiddingEnd | DateTime | |
| OnlineBiddingStart | DateTime | |
| OnlinePurchaseMode | Enum | |
| OnlineVisibilityEnd | DateTime | |
| OnlineVisibilityStart | DateTime | |
| PrintBidSheet | Bool | |
| Quantity | Int | 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. |
| Raffle | Raffle Schema Reference | |
| ReceiptIssued | Bool | |
| ReceiptRequired | Bool | |
| ReceiptValue | Double | Receiptable value, if different from the item's value. Leave blank if the same |
| Reference | String | Enter any external reference for the item |
| Reserve | Double | |
| SalesTaxCategory | SalesTaxCategory Schema Reference | |
| ShippingCost | Double | Amount to charge for shipping to winners of this item |
| Solicitor | String | Used for the name of the person that approached the donor about this donation |
| StartingBid | Double | |
| StatementText | String | This text will be shown on the statements. |
| TaxableValue | Double | Amount of item's value that is considered taxable. Leave blank or use 0 to use the full value. |
| TermsAndConditions | String | Describe any specific terms and conditions participants should be aware of |
| TicketsPer | Int | Number of tickets that a purchase of this item represents. The 'Ticket Type' field controls the kind of tickets generated. |
| TicketTitle | String | |
| TicketType | Enum | |
| Title | String | |
| Type | Enum | |
| Value | Double | Enter the item's value, or -1 to show 'Priceless' on bidsheets, etc. |
| WinningBid_Maximum | Double | |
| WinningBids_Amount | Double | |
| WinningBids_Count | Int |
Set Fields
| Name ↑ | Type | Descriptions |
|---|---|---|
| _AllDonors | Donor Schema Reference | |
| _BidderNotifications | BidderNotification Schema Reference | |
| _BidHistory | BidHistory Schema Reference | |
| _ItemDonors | ItemDonor Schema Reference | |
| _PackageContents | Package Schema Reference | |
| _Packages | Package Schema Reference | |
| _PartialItems | Item Schema Reference | |
| _PickPrizeRaffleTickets | RaffleTicket Schema Reference | |
| _ProxyBids | ProxyBid Schema Reference |
Last reviewed: October 2025