REST API TicketShops
Object type: ticketShop
This page contains information about all properties and methods regarding the ticket shop, a single sub-object of event. A ticketshop will automatically be created when you create an event. That's why you only have read and update access, but no create access. If you delete the related event, the ticketshop will also be deleted.
Attributes: R - accessible in read requests W - accessible in write (update) requests C - accessible in create requests
|| The internal id of this object.
|| The date/time the shop will be closed and no new purchases can be done anymore. This is matching the event's end date or if none is set the event start date plus 7 days.
(Side note: This ignores a possibly set value for the registrationEndDate as that one only closes the shop for the public. In theory user might still be able to purchase tickets with a promotion code.)
|| The date/time the shop will be open for the public (in case not all categories are hidden by a promotion code anyway). Users would still be able to buy a ticket before this date if you provide them with an unlocking promotion code.
If it is not set (default) the shop opens immediately after the event activation.
|| The date/time the shop will be closed for the public. Users will still be able to buy a ticket after this date if you provide them with an unlocking promotion code.
If it is not set (default) the shop closes at the date provided in the property closeDate.
|| Is true if the event is in the past or cancelled (if event is still in demo mode, this property is always false).
||The disagio (percentage fee) in this event.|
||The base fee (gross) per ticket in this event.|
||The disagio (percentage fee) for products sold through this ticket shop.|
||Wether the fee will be included in the ticket price or not.||Default: true|
|| Wether the shipment fee will be included in the ticket price or not.
Deprecated! This feature is not supported anymore and will always be set to false
||Wether the event is a commercial event. Only commercial events have salesTax.||Default: true|
||For commercial events, the sales tax. 1% = 100, 19% = 1900.||Default: depends on country|
||The global number of available tickets in this event.||Default: null|
||Wether the number of available tickets will be shown in the ticket shop or not.||Default: true|
||The currency of the ticket shop.||Default: EUR|
||Do you want to allow the cancelation of ticket pruchases?||Default: true|
||Is the buyer allowed to edit the ticket data after the purchase||Default: true|
||Is it allowed to transfer the ticket to another person after the purchase||Default: true|
||The global number of sold tickets for this ticket shop.|
||The total gross amount of income generated with this ticket shop.|
||The total gross amount of fees generated with this ticket shop.|
||Should user data be collected in the ticketshop?||Default: true|
||The maximum number of participants for this event.|
||The number of checked tickets of this ticket shop.|
||The VAT ID of this ticket shop.|
||URL to the organizer's terms and conditions.|
|Description||This request will return the ticket shop object of the event with the specified internal id. The response contains all properties marked with R.|
|Needed key type||Any|
|Errors||See General Errorcodes.|
|Parameters||All properties marked with W.|
|Description||This request will update the properties of the ticket shop of the event with the internal id <id>. Only properties which are provided as parameters will be updated.|
|Needed key type||Administrator, Editor|
See General Errorcodes.