Data Definition

The offeringUrl does not include the type of the offering, as although a user may be allowed to sell as a box office operator, they may want to only sell publically available tickets. In that case they would use type PUBLIC even though the capability says they can use BOX_OFFICE. To get the full URL for the offering, append the desired type to the offeringUrl.

If the returned type is PUBLIC, the user is not allowed to sell this event as a box office operator, and changing the type to BOX_OFFICE won't work.

Name	Description
AdditionalField	A definition of a question to be asked of the ticket buyer, in the form: name (String): the key for the field adminName (String): the server-side key for the field (don't use this one) fieldType (String): a standard field type, or CUSTOM label (String): the description of the field to be displayed to the ticket buyer inputType (String): AUTOCOMPLETE, TEXT, TEXTAREA, DATE, SELECT - a hint as to how to display the input index (Number): sort order for the field child (Boolean): whether the input appears conditionally values (List[String]): possible values for a SELECT metadata (Map): other metadata about the input
AdditionalFieldWithTickets	All the fields on AdditionalField, and also: ticketTypes (List[Ref]): the ticket types this field is used for
Address	A postal address in the form: streetAddress1 (String): the first line of the street address streetAddress2 (String): the second line of the street address postcode (String): the postcode of the street address state (String): the state country (String): the country
Admission	Details of an Admission (a ticket in a sale) in the form: saleDate (Date): the time the sale was created orderId (Number): the ID of the sale orderRef (String): the key for the sale eventDate (Date): the time the event date starts eventName (String): the name of the event ticketId (Number): the ID of the Admission ticketName (String): the name of the Ticket Type scans (List[Scan]): scans of the Admission reservationStatus (String): the status of the Admission: NOT_RESERVED, RESERVED, PENDING_GUEST_DETAILS, CONFIRMED, REFUNDED, RETURNED ticketPrice (Currency): the face value of the ticket discountCode (String): the booking code used for the sale customer (Map): the payee details
AdmissionResult	One of: SUCCESSFUL ALREADY_ADMITTED
AllocationType	One of: GENERAL_ADMISSION BEST_AVAILABLE RESERVED_ALLOCATION
BankDetails	Bank account details in the form: accountName (String): the account holder name accountNumber (String): the account number bsb (String): the bank's BSB - must be empty, or 6 characters remittanceEmail optional (String): the remittance email address
CartItem	An item in a cart (reserved tickets or other items such as surcharges) in the form: ticketType optional (Ref): the type of ticket description (String): text describing the item quantity (Number): how many of the item are reserved sortIndex (Number): ordering for display lineTotal (Currency): the total cost for this item fees (Currency): fees for a single item price (Currency): face value for a single item
CartSale	A reserved sale in the form: saleKey (String): the unique key for the sale event (Ref): the event the sale is for total (Currency): the total amount to be paid tax (Currency): the tax component of the total discount (Currency): the total discounts applying to this sale items (List[CartItem]): the items in this sale
CartSalePaymentResponse	A response to the attempted payment of one sale in the form: saleKey (String): the unique key for the sale status (String): the status of the sale before payment was attempted RESERVED LOCKED PROCESSING CONFIRMED UNFULFILLED successful (Boolean): whether payment succeeded amount (Currency): the amount that was charged
ContentFrameType	(String) The type of frame that the email content will be wrapped in. One of: NONE ACCOUNT CUSTOM
ContentType	(String) A classification of what this content is about, which determines the fields that will be interpolated into it. One of: EVENT SALE
CreditCard	Credit card details in the form: name (String): Name on the card number (String): digits only expiryYear (Numeric): 4 digits expiryMonth (Numeric): 1-12 cvn (String): 3 or 4 characters
Currency	A currency in the form: code (String): ISO 4217 value (Numeric): a represented value of currency.
Customer	A customer in the form: firstName (String): the first name of the customer lastName (String): the last name of the customer emailAddress (Email): the email address of the customer mobilePhone (Phone): the phone number of the customer
Date	A date in ISO8601 format (yyyy-MM-ddTHH:mm:ss:SSSZZ).
Email	A valid email address.
EmailTriggerAudience	An object in the form: confirmed (Boolean): whether to send the email to confirmed sales (the ticket is valid for entry) locked (Boolean): whether to send the email to sales in the process of being paid for, i.e. payment plans unfulfilled (Boolean): whether to send the email to unfulfilled sales (the ticket must be exchanged for a barcode) merchandise (Boolean): whether to send the email to sales which contain only non-ticket items
EmailCampaignType	(String) The rule for when to fire the campaign. One of: DAY_OF_EVENT AT_A_TIME AT_A_TIME_OR_AFTER ASAP NEVER DAY_BEFORE_EVENT TWO_DAYS_BEFORE DAY_AFTER_EVENT
Invoice	An Invoice in the form: subTotal (Currency) taxTotal (Currency) totalPaid (Currency) lineItems (List[Map]) description (String) quantity (Number) unitPrice (Currency) lineTotal (Currency) taxTotal (Currency) fees (Optional Currency) ticketTypeId (Optional Number) itemType (String)
List	An array.
Number	A numeric value.
OfferingCopy	Explanatory text in a ticket listing configured by the creator of an event. copy (String) sortIndex (Number) ticketTags (List[String]) eventDateTags (List[String])
OfferingGroup	A grouping of tickets offered for an event - within IWT this usually corresponds to an event date. The pages are used to break up a long list of tickets for the convenience of buyers. The pages should be displayed in order of increasing sort index. name (String) sortIndex (Number) pages (List[OfferingPage])
OfferingPage	A list of tickets offered for an event. The tickets and copy should be displayed interspersed in order of increasing sort index. name (String) sortIndex (Number) tickets (List[OfferingTicket]) copies (List[OfferingCopy])
OfferingPaymentGatewayConfig	Payment configuration for the offering, e.g. which payment interface to use, account ID, etc. Details will depend on the information required depending on the type. type (String)
OfferingTicket	A ticket. name (String) saleStatus (String) detailText (String) - additional detail about this ticket venueSectionNickname (String) tags (List[String]) sortIndex (Number) minQuantity (Number) quantityStep (Number) maxQuantity (Number) ticketsLeft (Number) ticketTypeId (Number) venueSectionId (Number) reservedAllocation (Boolean) - whether this ticket requires you to choose a seat showTicketsLeft (Boolean) - whether the ticketsLeft value is meaningful faceValue (Currency) fee (Currency)
OfferingVoterConfig	Configuration for a guardian rule which applies to the offering. This can be used to prevent the buyer from choosing ticket combinations which would be prohibited by the server-side rules. Details will vary depending on the type of the config. type (String)
PaddingStrategy	The padding strategy of a venue section: CENTRE XY_PLOT
PaymentSchedule	Details of a payment plan: payNow (Currency) Amount of the initial payment firstInstalmentAmount (Currency) Amount of the first instalment firstInstalmentDate (String) When the first instalment must be paid perInstalmentAmount (Currency) Amount of the regular instalments lastInstalmentAmount (Currency) Amount of the last instalment lastInstalmentDate (String) When the last instalment must be paid numInstalments (Integer) The number of regular instalments
PaymentTransaction	A payment transaction in the form: type (String) REFUND or PAYMENT created (String) total (Currency) eftpos (Currency) cash (Currency) credit (Currency) cardNumber (String) txRef (String) successful (Boolean) refund (Boolean) return (Boolean)
Phone	A valid phone number.
Ref	A reference to another entity. Is of the form: id (Number): the id of the referenced entity. link (URL): the URL of the referenced entity. name (String): some value that describes this entity.
ReservationStatus	(String) one of: NOT_RESERVED RESERVED PENDING_GUEST_DETAILS CONFIRMED REFUNDED
SaleStatus	(String) one of: NOT_AVAILABLE_FOR_SALE_PUBLIC_OR_PRIVATE NOT_AVAILABLE_FOR_SALE AVAILABLE_FOR_SALE AVAILABLE_FOR_SALE_FROM SOLD_OUT WITHDRAWN
Scan	A scan of an Admission, in the form: scannedDate (Date): when the scan happened. scannedBy (String): the user who did the scanning.
ScanCapability	A description of something this user can scan. Details TBD.
SellCapability	A description of an offering that this user can sell: eventId (Optional Number): when the scan happened. offeringUrl (String): the API URL to retrieve details of the offering. offeringName (String): the name of the offering. offeringType (String): the type of the offering. One of BOX_OFFICE - this offering is sold as a box office operator LAYBY - this offering is sold on payment plan PUBLIC - this offering sells tickets available to the public
String	A textual value.
TicketTypeMetadata	Metadata for a ticket type, in the form: id (Number): the unique ID of the ticket. name (String): the name of the ticket. saleStatus (SaleStatus): the sale status of the ticket. price (Currency): the price of the ticket. fee (Currency): the public booking fee applicable to the ticket. tags (List[String]): the tags the ticket type has.