Offering

Fields

Field	Type	Required	Description
id	string	✓
created	string	✓
changed	string
urn	string		URN for this offering
category	string		Category for this offering (e.g., “event”, “venue”)
name	string	✓	Offering name, can be ticket name, vaucher name, etc…
type	"admission" | "admission.tableCommitment" | "package" | "skip" | "drink" | "ticket" | "tc-ticket" | "merch" | "donation" | "membership" | "voucher" | "service" | "other"	✓
capacity	number	✓
quantitySold	number	✓
status	"live" | "hidden" | "sold-out" | "draft" | "archived" | "deleted" | "unavailable"	✓
priceCategory	"donation" | "free" | "paid" | "other"	✓
sorting	number	✓
schedule	object
description	string
instructions	string
step	number	✓
maximumQuantity	number	✓
minimumQuantity	number	✓
package	boolean
includes	object[]
constraints	unknown		Any constraints that apply to this offering. it can be time limit, quantity limit, etc…
hidden	boolean	✓
order_confirmation_message	string | null
costs	object	✓
options	object[]
costComponents	object[]		Describe fees and other costs associated with purchasing tickets to this offering
meta	object
config	object
refPath	string		path to the offering doc in the db.

Field Examples

name:

"General Admission" (ticket) | "T-shirt" (merch) | "Donation" (donation) | "Membership" (membership) | "Gift Card" (voucher) | "Service Fee" (service) | "Other" (other)

capacity:

100

maximumQuantity:

10

minimumQuantity:

1

options:

"General Admission" (ticket) | "T-shirt" (merch) | "Donation" (donation) | "Membership" (membership) | "Gift Card" (voucher) | "Service Fee" (service) | "Other" (other)