Ticket Definition Object


Properties
idstringRead-onlyformat GUID

Ticket definition ID.


eventIdstringformat GUID

Event ID to which the ticket definition belongs.


revisionintegerRead-onlyformat int64

Revision number, which increments by 1 each time the ticket definition is updated. To prevent conflicting changes, the existing revision must be used when updating a ticket definition.


createdDatestringRead-onlyformat date-time

Date and time when the ticket definition was created.


updatedDatestringRead-onlyformat date-time

Date and time when the ticket definition was updated.


namestringminLength 1maxLength 30

Ticket definition name.


descriptionstringmaxLength 500

Ticket definition description.


policyTextstringmaxLength 1000

Ticket definition policy.


hiddenboolean

Whether this ticket definition is hidden to site visitors and can't be purchased.


limitedbooleanRead-only

Whether the ticket has a limited maximum quantity.


initialLimitintegerformat int32

The maximum number of tickets that can be sold for the event when first defining the event. If a seating map is defined after you created a ticket definition, this property is ignored and actualLimit is used instead.


actualLimitintegerRead-onlyformat int32

The maximum number of tickets that can be sold for the event after adding a seating map to the event. If no seating map is defined, this property is the same as initialLimit.


pricingMethodPricingMethod

Ticket pricing method.


feeTypestring

Whether fee is included in the ticket price or customer pays it additionally at checkout.


salePeriodSalePeriod

Ticket sale period.


saleStatusstringRead-only

Ticket sale status.


salesDetailsSalesDetails

Ticket sales information.
Note: This field is only returned when SALES_DETAILS fieldset is included in the request.


limitPerCheckoutintegerRead-onlyminimum 0maximum 50format int32

Number of tickets that can be purchased per checkout.
Note: If the actuaLimit or salesDetails.unsoldCount field value is smaller than limitPerCheckout, then it overrides this field.


extendedFieldsExtendedFields

Data extensions.


eventDetailsEventDetails

Associated event information.
Note: This field is only returned when EVENT_DETAILS fieldset is included in the request.

TicketDefinition
JSON
{ "ticketDefinition": { "id": "aaf51c30-a61c-473e-96be-a42dfa5064c0", "eventId": "9d720f99-1b5a-4141-9877-d32985391e18", "revision": "1", "createdDate": "2023-05-25T11:39:26.108Z", "updatedDate": "2023-05-25T11:39:26.108Z", "name": "Leather Workshop", "description": "Step into the world of fine craftsmanship and explore the artistry of handcrafted leather goods at our captivating Leather Workshop. Join us for a hands-on experience that delves into the intricate process of transforming raw leather into exquisite creations. Immerse yourself in a creative atmosphere where seasoned leather artisans will guide you through the journey of mastering age-old techniques and unlocking your inner artisan.", "policy_text": "This is your event ticket. Ticket holders must present their tickets on entry. You can either print your ticket or present this digital version. You can find all the details about this event on our website. If you have any questions, issues or wish to get a refund, contact the event host. If you can’t attend the event, please get in touch. Looking forward to seeing you there!", "hidden": false, "limited": true, "initialLimit": 3, "actualLimit": 3, "pricingMethod": { "fixedPrice": { "value": "200.00", "currency": "USD" }, "pricingType": "STANDARD", "free": false }, "feeType": "FEE_INCLUDED", "salePeriod": { "startDate": "2023-06-07T10:00:00Z", "endDate": "2023-06-30T00:00:00Z", "displayNotOnSale": false }, "saleStatus": "SALE_ENDED", "salesDetails": { "unsoldCount": 3, "soldCount": 0, "reservedCount": 0, "soldOut": false } } }
Did this help?