API docs by Redocly

Ticketpark API (1.0.0)

The Ticketpark API

AccessCheck

An AccessCheck is used in the context of entrance control. An AccessCheck represents a historic record of a single ticket entering or exiting an AccessPoint. Once created, an AccessCheck should not be edited anymore (unless of course it was created wrongly).

Get all access checks

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "direction": "string",
  • "origin": "string",
  • "device_identifier": "string",
  • "checked": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Create one or multiple access checks

Request Body schema: application/json
access_point
required
string

Public identifier (pid) of an access point

checked
required
string <date-time>

Time of access check

device_identifier
required
string

Identifier of the used access control device (e.q. device UUID)

direction
required
string
Enum: "in" "out"

Direction of access check

origin
required
string

Description of the access control origin (e.q. app name and version)

Responses

Request samples

Content type
application/json
{
  • "access_point": "string",
  • "checked": "2019-08-24T14:15:22Z",
  • "device_identifier": "string",
  • "direction": "in",
  • "origin": "string"
}

Get only head data of GET request

Responses

Update one or multiple access checks

Request Body schema: application/json
access_point
required
string

Public identifier (pid) of an access point

checked
required
string <date-time>

Time of access check

device_identifier
required
string

Identifier of the used access control device (e.q. device UUID)

direction
required
string
Enum: "in" "out"

Direction of access check

origin
required
string

Description of the access control origin (e.q. app name and version)

Responses

Request samples

Content type
application/json
{
  • "access_point": "string",
  • "checked": "2019-08-24T14:15:22Z",
  • "device_identifier": "string",
  • "direction": "in",
  • "origin": "string"
}

Get a single access check

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "direction": "string",
  • "origin": "string",
  • "device_identifier": "string",
  • "checked": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the ticket of an access check

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "_links": {
    },
  • "discr": "ticket"
}

AccessPoint

An AccessPoint represents a single point of entrance control. Each Show has by default one AccessPoint.

Get all access points

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "end_check_in": "2019-08-24T14:15:22Z",
  • "dooropening": "2019-08-24T14:15:22Z",
  • "pid": "string",
  • "order": 0,
  • "counter_max": 1
}

Get only head data of GET request

Responses

Get a single access point

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "end_check_in": "2019-08-24T14:15:22Z",
  • "dooropening": "2019-08-24T14:15:22Z",
  • "pid": "string",
  • "order": 0,
  • "counter_max": 1
}

Get the access keys of an access point

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "_links": {
    },
  • "discr": "ticket"
}

AcquisitionChannel

An AcquisitionChannel is an option for a ticket buyer to choose from as an answer to the question «How did you hear from us?» in the booking process.

Get all acquisition channels

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "translation_key": "string",
  • "order": 0,
  • "_links": {
    }
}

Create one or multiple acquisition channels

Request Body schema: application/json
host
required
string

Public identifier (pid) of a host

name
required
string

Name

order
integer

Order index in lists (lowest to highest)

Responses

Request samples

Content type
application/json
{
  • "host": "string",
  • "name": "string",
  • "order": 0
}

Get only head data of GET request

Responses

Update one or multiple acquisition channels

Request Body schema: application/json
host
required
string

Public identifier (pid) of a host

name
required
string

Name

order
integer

Order index in lists (lowest to highest)

Responses

Request samples

Content type
application/json
{
  • "host": "string",
  • "name": "string",
  • "order": 0
}

Get a single acquisition channel

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "translation_key": "string",
  • "order": 0,
  • "_links": {
    }
}

Delete an acquisition channel

path Parameters
pid
required
string

Responses

Update a single acquisition channel

path Parameters
pid
required
string
Request Body schema: application/json
host
required
string

Public identifier (pid) of a host

name
required
string

Name

order
integer

Order index in lists (lowest to highest)

Responses

Request samples

Content type
application/json
{
  • "host": "string",
  • "name": "string",
  • "order": 0
}

Get the client of an acquisition channel

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "legal_name": "string",
  • "address": "string",
  • "zip": "string",
  • "city": "string",
  • "country": "string",
  • "internal_email": "string",
  • "public_email": "string",
  • "public_email_sender_name": "string",
  • "fee_minimal_commission": "string",
  • "fee_free_ticket_commission": "string",
  • "fee_included_free_tickets_percentage": 100,
  • "fee_ticket_options_percentage": "0.00",
  • "fee_options_percentage": "0.00",
  • "important_host_info": "string",
  • "enable_waiting_room": false,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the host of an acquisition channel

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "care_of": "string",
  • "address1": "string",
  • "address2": "string",
  • "zip": "string",
  • "city": "string",
  • "country": "string",
  • "will_call_label": "string",
  • "will_call_instructions": "string",
  • "send_reminders": true,
  • "delete_unpaid_bookings": true,
  • "public_email": "string",
  • "public_email_sender_name": "string",
  • "public_phone": "string",
  • "website": "string",
  • "bank_account": "string",
  • "bank_account_owner": "string",
  • "bank_account_city": "string",
  • "invoice_address": "string",
  • "vat_number": "string",
  • "thank_you_close": "string",
  • "complimentary_close": "string",
  • "contact_text": "string",
  • "confirmation_extras_template": "string",
  • "tos_title": "string",
  • "tos": "string",
  • "saferpay_terminal_id": "string",
  • "shared_secret": "string",
  • "prompt_newsletter": false,
  • "prompt_acquisition_channel": false,
  • "execute_deliveries": true,
  • "check_newsletter_by_default": false,
  • "address_right": false,
  • "enable_crm": false,
  • "enable_staff": false,
  • "enable_invitations": false,
  • "enable_seat_category_changes": false,
  • "enable_remaining_voucher_value_handling": false,
  • "enable_donations": false,
  • "execute_payouts": true,
  • "cancellation_policy": "strict",
  • "enable_salutation": true,
  • "use_security_code": true,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "allow_user_to_delete_booking": true,
  • "allow_embed_session_id": true,
  • "allow_single_empty_seats": true,
  • "setup_information": "string",
  • "support_info": "string",
  • "notify_on_new_booking": false,
  • "notification_email": "string",
  • "fee_percentage": "string",
  • "fee_minimal_commission": "string",
  • "fee_free_ticket_commission": "string",
  • "fee_included_free_tickets_percentage": 100,
  • "fee_payment_base_commission": "string",
  • "fee_payment_percentage": "string",
  • "_links": {
    }
}

Address

An Address represents the postal address of a Person. It is to be created along with a Person record.

Get all addresses

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "address1": "string",
  • "address2": "string",
  • "zip": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get only head data of GET request

Responses

Update one or multiple addresses

Request Body schema: application/json
person
required
string

Public identifier (pid) of a person

address1
string

First address line

address2
string

Second address line

city
string

City

country
string

Country (2 letters, ISO 3166-1 alpha-2)

state
string

State

zip
string

ZIP code

Responses

Request samples

Content type
application/json
{
  • "person": "string",
  • "address1": "string",
  • "address2": "string",
  • "zip": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string"
}

Get a single address

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "address1": "string",
  • "address2": "string",
  • "zip": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Update a single address

path Parameters
pid
required
string
Request Body schema: application/json
person
required
string

Public identifier (pid) of a person

address1
string

First address line

address2
string

Second address line

city
string

City

country
string

Country (2 letters, ISO 3166-1 alpha-2)

state
string

State

zip
string

ZIP code

Responses

Request samples

Content type
application/json
{
  • "person": "string",
  • "address1": "string",
  • "address2": "string",
  • "zip": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string"
}

Get the person of an address

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "address1": "string",
  • "address2": "string",
  • "zip": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "translations": { },
  • "pid": "string",
  • "salutation": "string",
  • "title": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "company": "string",
  • "department": "string",
  • "position": "string",
  • "phone": "string",
  • "phone2": "string",
  • "phone3": "string",
  • "email": "string",
  • "birthday": "2019-08-24T14:15:22Z",
  • "newsletter": true,
  • "mailing": true,
  • "website": "string",
  • "locale": "string",
  • "address": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Annotation

An Annotation allows to add additional text values connected to a specific target. The values are stored as AnnotationValues. Annotations are usually used to ask for additional information per ticket, like names of accompanying persons.

Get all annotations

Responses

Response samples

Content type
application/json
{
  • "access_role": "string",
  • "translations": { },
  • "pid": "string",
  • "target": "booking",
  • "identifier": "string",
  • "name": "string",
  • "description": "string",
  • "placeholder": "string",
  • "order": 0,
  • "required": false,
  • "max_chars": 0,
  • "regex": "string",
  • "show_type": "all",
  • "access_by": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "editable_by_buyer": false,
  • "_links": {
    }
}

Create one or multiple annotations

Request Body schema: application/json
event
required
string

Public identifier (pid) of an event

name
required
string

Annotation name

target
required
string
Enum: "booking" "ticket" "show" "event" "ticketOption"

Target entity

access_by
string
Value: "host"

Who may see this annotation. Set to null for public.

based_on_annotation_template
string

Public identifier (pid) of an annotation template

depends_on
string

Public identifier (pid) of a ticket option

description
string

Additional description

editable_by_buyer
boolean

Flag whether the annotation value is editable by the buyer on existing bookings

enable_apply_to_all_tickets
boolean

Flag whether the annotation gets a gui element for easy application of its value to all tickets within the booking

identifier
string

Annotation identifier

max_chars
integer

Maximum allowed characters for annotation values

order
integer

Order index in lists (lowest to highest)

placeholder
string

Placeholder text

prices
Array of strings

List of prices for which this annotation is available

regex
string

Regular expression to be matched by annotation values

required
boolean

Flag whether this annotation must be filled in

show_type
string
Enum: "all" "physical" "online"

Type of shows where this annotation is available

Responses

Request samples

Content type
application/json
{
  • "event": "string",
  • "name": "string",
  • "target": "booking",
  • "access_by": "host",
  • "based_on_annotation_template": "string",
  • "description": "string",
  • "depends_on": "string",
  • "editable_by_buyer": true,
  • "enable_apply_to_all_tickets": true,
  • "identifier": "string",
  • "max_chars": 0,
  • "order": 0,
  • "placeholder": "string",
  • "prices": [
    ],
  • "regex": "string",
  • "required": true,
  • "show_type": "all"
}

Get only head data of GET request

Responses

Update one or multiple annotations

Request Body schema: application/json
any (AnnotationsType)

Responses

Request samples

Content type
application/json
null

Get a single annotation

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "access_role": "string",
  • "translations": { },
  • "pid": "string",
  • "target": "booking",
  • "identifier": "string",
  • "name": "string",
  • "description": "string",
  • "placeholder": "string",
  • "order": 0,
  • "required": false,
  • "max_chars": 0,
  • "regex": "string",
  • "show_type": "all",
  • "access_by": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "editable_by_buyer": false,
  • "_links": {
    }
}

Delete an annotation

path Parameters
pid
required
string

Responses

Update a single annotation

path Parameters
pid
required
string
Request Body schema: application/json
event
required
string

Public identifier (pid) of an event

name
required
string

Annotation name

target
required
string
Enum: "booking" "ticket" "show" "event" "ticketOption"

Target entity

access_by
string
Value: "host"

Who may see this annotation. Set to null for public.

based_on_annotation_template
string

Public identifier (pid) of an annotation template

depends_on
string

Public identifier (pid) of a ticket option

description
string

Additional description

editable_by_buyer
boolean

Flag whether the annotation value is editable by the buyer on existing bookings

enable_apply_to_all_tickets
boolean

Flag whether the annotation gets a gui element for easy application of its value to all tickets within the booking

identifier
string

Annotation identifier

max_chars
integer

Maximum allowed characters for annotation values

order
integer

Order index in lists (lowest to highest)

placeholder
string

Placeholder text

prices
Array of strings

List of prices for which this annotation is available

regex
string

Regular expression to be matched by annotation values

required
boolean

Flag whether this annotation must be filled in

show_type
string
Enum: "all" "physical" "online"

Type of shows where this annotation is available

Responses

Request samples

Content type
application/json
{
  • "event": "string",
  • "name": "string",
  • "target": "booking",
  • "access_by": "host",
  • "based_on_annotation_template": "string",
  • "description": "string",
  • "depends_on": "string",
  • "editable_by_buyer": true,
  • "enable_apply_to_all_tickets": true,
  • "identifier": "string",
  • "max_chars": 0,
  • "order": 0,
  • "placeholder": "string",
  • "prices": [
    ],
  • "regex": "string",
  • "required": true,
  • "show_type": "all"
}

Get the event of an annotation

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "timespan": { },
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "performer": "string",
  • "ticketdescription": "string",
  • "description": "string",
  • "delivery_info": "string",
  • "confirmation_extras_template": "string",
  • "will_call_label": "string",
  • "pay_before_dispatch": false,
  • "immediate_payment_only": false,
  • "send_reminders": true,
  • "delete_unpaid_bookings_mode": "never",
  • "allow_digital_dispatch": true,
  • "allow_deliveries": false,
  • "allow_will_call": false,
  • "issue_tickets": true,
  • "enable_passbook_tickets": true,
  • "require_customer_company": false,
  • "require_customer_address": true,
  • "require_customer_phone": false,
  • "prompt_customer_position": false,
  • "prompt_customer_department": false,
  • "prompt_customer_title": false,
  • "prompt_customer_birthday": false,
  • "allow_customer_notes": false,
  • "allow_invoice_address": false,
  • "allow_single_empty_seats": true,
  • "is_hidden": false,
  • "excluded_from_revenue_stats": false,
  • "tickets_per_booking": 1,
  • "tickets_in_listings": 1,
  • "refine_info": "string",
  • "reservation_info": "string",
  • "sales_point_info": "string",
  • "support_info": "string",
  • "payout_interval": "string",
  • "payout_interval_specification": "string",
  • "is_cancelled": true,
  • "will_be_postponed": true,
  • "cancellation_info": "string",
  • "invoice_address": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "notify_on_new_booking": false,
  • "notification_email": "string",
  • "fee_percentage": "string",
  • "fee_minimal_commission": "string",
  • "fee_free_ticket_commission": "string",
  • "fee_included_free_tickets_percentage": 100,
  • "fee_payment_base_commission": "string",
  • "fee_payment_percentage": "string",
  • "_links": {
    }
}

Get the annotation values of an annotation

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "value": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the prices of an annotation

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "_links": {
    },
  • "discr": "price"
}

AnnotationValue

An AnnotationValue contains the text value of an Annotation connected to a specific target.

Get all annotation values

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "value": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Create one or multiple new annotation values

Request Body schema: application/json
annotation
required
string

Public identifier (pid) of an annotation

value
required
string

Annotation value

booking
string

Public identifier (pid) of a booking

show
string

Public identifier (pid) of a show

ticket
string

Public identifier (pid) of a ticket

ticket_option
string

Public identifier (pid) of a ticket option

Responses

Request samples

Content type
application/json
{
  • "annotation": "string",
  • "value": "string",
  • "booking": "string",
  • "show": "string",
  • "ticket": "string",
  • "ticket_option": "string"
}

Get only head data of GET request

Responses

Update one or multiple annotation values

Request Body schema: application/json
any (AnnotationValuesType)

Responses

Request samples

Content type
application/json
null

Get a single annotation value

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "value": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Delete an annotation value

path Parameters
pid
required
string

Responses

Update a single annotation value

path Parameters
pid
required
string
Request Body schema: application/json
annotation
required
string

Public identifier (pid) of an annotation

value
required
string

Annotation value

booking
string

Public identifier (pid) of a booking

show
string

Public identifier (pid) of a show

ticket
string

Public identifier (pid) of a ticket

ticket_option
string

Public identifier (pid) of a ticket option

Responses

Request samples

Content type
application/json
{
  • "annotation": "string",
  • "value": "string",
  • "booking": "string",
  • "show": "string",
  • "ticket": "string",
  • "ticket_option": "string"
}

Get the annotation of an annotation value

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "access_role": "string",
  • "translations": { },
  • "pid": "string",
  • "target": "booking",
  • "identifier": "string",
  • "name": "string",
  • "description": "string",
  • "placeholder": "string",
  • "order": 0,
  • "required": false,
  • "max_chars": 0,
  • "regex": "string",
  • "show_type": "all",
  • "access_by": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "editable_by_buyer": false,
  • "_links": {
    }
}

Get the booking of an annotation value

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid_readable": "string",
  • "confirmation": true,
  • "delivery_method": "string",
  • "tickets_breakdown": { },
  • "pay_before_dispatch": true,
  • "is_dispatchable": true,
  • "urls": { },
  • "invoice_urls": { },
  • "denormalized_customer_pid": "string",
  • "denormalized_customer_fullname": "string",
  • "denormalized_customer_name_and_city": "string",
  • "denormalized_customer_country": "string",
  • "pid": 0,
  • "destination_country": "string",
  • "affiliate_id": "string",
  • "origin": "string",
  • "user_agent": "string",
  • "remote_address": "string",
  • "from_embed": true,
  • "source": "string",
  • "embed_session_id": "string",
  • "tos": true,
  • "digital_dispatch": true,
  • "delivery": true,
  • "will_call": true,
  • "deleted_by_customer": true,
  • "pos": true,
  • "internal_notes": "string",
  • "external_notes": "string",
  • "invoice_address": "string",
  • "checkbox_values": [
    ],
  • "payment_status_code": 0,
  • "first_full_payment": "2019-08-24T14:15:22Z",
  • "due_date": "2019-08-24T14:15:22Z",
  • "send_reminders": true,
  • "delete_if_unpaid": true,
  • "reminded_that_unpaid_at": "2019-08-24T14:15:22Z",
  • "next_reminder": "2019-08-24T14:15:22Z",
  • "refund_bank_account": "string",
  • "refund_bank_account_owner": "string",
  • "refund_bank_account_city": "string",
  • "approved": "2019-08-24T14:15:22Z",
  • "rejected": "2019-08-24T14:15:22Z",
  • "approval_requested": true,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": null,
  • "_links": {
    }
}

Get the ticket of an annotation value

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "_links": {
    },
  • "discr": "ticket"
}

Get the show of an annotation value

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "access_role": "string",
  • "beacon_data": { },
  • "translations": { },
  • "pid": "string",
  • "performer": "string",
  • "ticketdescription": "string",
  • "description": "string",
  • "subtitle": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "end_check_in": "2019-08-24T14:15:22Z",
  • "start_public_sales": "2019-08-24T14:15:22Z",
  • "end_sales": "2019-08-24T14:15:22Z",
  • "end_sales_alternative": "string",
  • "dooropening": "2019-08-24T14:15:22Z",
  • "specific_capacity": 1,
  • "allow_sales_while_current": false,
  • "allow_single_empty_seats": true,
  • "always_display_start_time": false,
  • "reservation_info": "string",
  • "request_ratings": false,
  • "order": 0,
  • "is_cancelled": true,
  • "will_be_postponed": true,
  • "is_online_show": true,
  • "online_show": {
    },
  • "tickets_per_booking": 1,
  • "enable_passbook_tickets": true,
  • "access_by": "string",
  • "ratings_requested": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the ticket option of an annotation value

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "ticket_option_group_pid": "string",
  • "ticket_option_group_name": "string",
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "ticket_info": "string",
  • "description": "string",
  • "all_or_nothing": false,
  • "order": 0,
  • "notify_on_new_booking": true,
  • "notification_email_address": "string",
  • "access_by": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "available_until_minutes_before_show_start": 0,
  • "custom_fee_percentage": "string",
  • "price": "string",
  • "_links": {
    }
}

Booker

A Booker represents a specific ticket booking interface which is used for shows with specific partner booking requirements.

Get a single booker

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "slug": "string",
  • "introtext": "string",
  • "close_sales_at": "2019-08-24T14:15:22Z"
}

Delete a booker

path Parameters
pid
required
string

Responses

Update a single booker

path Parameters
pid
required
string
Request Body schema: application/json
slug
required
string

Slug to be used in url

event
string

Public identifier (pid) of an event

introtext
string

Introtext displayed in booker

show
string

Public identifier (pid) of a show

Responses

Request samples

Content type
application/json
{
  • "slug": "string",
  • "introtext": "string",
  • "event": "string",
  • "show": "string"
}

Create one or multiple bookers

Request Body schema: application/json
slug
required
string

Slug to be used in url

event
string

Public identifier (pid) of an event

introtext
string

Introtext displayed in booker

show
string

Public identifier (pid) of a show

Responses

Request samples

Content type
application/json
{
  • "slug": "string",
  • "introtext": "string",
  • "event": "string",
  • "show": "string"
}

Update one or multiple bookers

Request Body schema: application/json
slug
required
string

Slug to be used in url

event
string

Public identifier (pid) of an event

introtext
string

Introtext displayed in booker

show
string

Public identifier (pid) of a show

Responses

Request samples

Content type
application/json
{
  • "slug": "string",
  • "introtext": "string",
  • "event": "string",
  • "show": "string"
}

Get the event of a booker

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "timespan": { },
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "performer": "string",
  • "ticketdescription": "string",
  • "description": "string",
  • "delivery_info": "string",
  • "confirmation_extras_template": "string",
  • "will_call_label": "string",
  • "pay_before_dispatch": false,
  • "immediate_payment_only": false,
  • "send_reminders": true,
  • "delete_unpaid_bookings_mode": "never",
  • "allow_digital_dispatch": true,
  • "allow_deliveries": false,
  • "allow_will_call": false,
  • "issue_tickets": true,
  • "enable_passbook_tickets": true,
  • "require_customer_company": false,
  • "require_customer_address": true,
  • "require_customer_phone": false,
  • "prompt_customer_position": false,
  • "prompt_customer_department": false,
  • "prompt_customer_title": false,
  • "prompt_customer_birthday": false,
  • "allow_customer_notes": false,
  • "allow_invoice_address": false,
  • "allow_single_empty_seats": true,
  • "is_hidden": false,
  • "excluded_from_revenue_stats": false,
  • "tickets_per_booking": 1,
  • "tickets_in_listings": 1,
  • "refine_info": "string",
  • "reservation_info": "string",
  • "sales_point_info": "string",
  • "support_info": "string",
  • "payout_interval": "string",
  • "payout_interval_specification": "string",
  • "is_cancelled": true,
  • "will_be_postponed": true,
  • "cancellation_info": "string",
  • "invoice_address": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "notify_on_new_booking": false,
  • "notification_email": "string",
  • "fee_percentage": "string",
  • "fee_minimal_commission": "string",
  • "fee_free_ticket_commission": "string",
  • "fee_included_free_tickets_percentage": 100,
  • "fee_payment_base_commission": "string",
  • "fee_payment_percentage": "string",
  • "_links": {
    }
}

Get the show of a booker

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "access_role": "string",
  • "beacon_data": { },
  • "translations": { },
  • "pid": "string",
  • "performer": "string",
  • "ticketdescription": "string",
  • "description": "string",
  • "subtitle": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "end_check_in": "2019-08-24T14:15:22Z",
  • "start_public_sales": "2019-08-24T14:15:22Z",
  • "end_sales": "2019-08-24T14:15:22Z",
  • "end_sales_alternative": "string",
  • "dooropening": "2019-08-24T14:15:22Z",
  • "specific_capacity": 1,
  • "allow_sales_while_current": false,
  • "allow_single_empty_seats": true,
  • "always_display_start_time": false,
  • "reservation_info": "string",
  • "request_ratings": false,
  • "order": 0,
  • "is_cancelled": true,
  • "will_be_postponed": true,
  • "is_online_show": true,
  • "online_show": {
    },
  • "tickets_per_booking": 1,
  • "enable_passbook_tickets": true,
  • "access_by": "string",
  • "ratings_requested": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Booking

A Booking represents a ticket booking.

Get all bookings

Responses

Response samples

Content type
application/json
{
  • "pid_readable": "string",
  • "confirmation": true,
  • "delivery_method": "string",
  • "tickets_breakdown": { },
  • "pay_before_dispatch": true,
  • "is_dispatchable": true,
  • "urls": { },
  • "invoice_urls": { },
  • "denormalized_customer_pid": "string",
  • "denormalized_customer_fullname": "string",
  • "denormalized_customer_name_and_city": "string",
  • "denormalized_customer_country": "string",
  • "pid": 0,
  • "destination_country": "string",
  • "affiliate_id": "string",
  • "origin": "string",
  • "user_agent": "string",
  • "remote_address": "string",
  • "from_embed": true,
  • "source": "string",
  • "embed_session_id": "string",
  • "tos": true,
  • "digital_dispatch": true,
  • "delivery": true,
  • "will_call": true,
  • "deleted_by_customer": true,
  • "pos": true,
  • "internal_notes": "string",
  • "external_notes": "string",
  • "invoice_address": "string",
  • "checkbox_values": [
    ],
  • "payment_status_code": 0,
  • "first_full_payment": "2019-08-24T14:15:22Z",
  • "due_date": "2019-08-24T14:15:22Z",
  • "send_reminders": true,
  • "delete_if_unpaid": true,
  • "reminded_that_unpaid_at": "2019-08-24T14:15:22Z",
  • "next_reminder": "2019-08-24T14:15:22Z",
  • "refund_bank_account": "string",
  • "refund_bank_account_owner": "string",
  • "refund_bank_account_city": "string",
  • "approved": "2019-08-24T14:15:22Z",
  • "rejected": "2019-08-24T14:15:22Z",
  • "approval_requested": true,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": null,
  • "_links": {
    }
}

Create one or multiple bookings

Request Body schema: application/json
affiliate_id
string

Affiliate id - a custom string to identify the origin of a booking

approval_requested
boolean

Flag whether approval is requested for this booking

confirmation
boolean

Set true to confirm a booking. A booking must have a customer and tickets to be confirmed.

customer
string

Public identifier (pid) of a person

delete_if_unpaid
boolean

Flag whether the booking should be deleted if it remains unpaid, if applicable

delivery
boolean

Flag whether this booking is dispatched by snail mail

digital_dispatch
boolean

Flag whether this booking is dispatched digitally

due_date
string <date>

Due date until when the booking needs to be paid

external_notes
string

External notes, visible for the customer

host
string

Public identifier (pid) of a host

internal_notes
string

Internal notes

invitation
string

Public identifier (pid) of an invitation

invoice_address
string

Alternative invoice address

is_approved
boolean

Set true to approve a booking for which approval was requested.

is_rejected
boolean

Set true to reject a booking for which approval was requested.

next_reminder
string <date>

Date when the next payment reminder will be sent, if needed

origin
string

Origin where this booking was created, e.q. url of a website, name of an app, etc.

remote_address
string

IP address of the ticket buyer

send_reminders
boolean

Flag whether payment reminders should be sent for this booking, if applicable

user_agent
string

User agent string of the ticket buyer

will_call
boolean

Flag whether this booking will be picked up at the boxoffice

Responses

Request samples

Content type
application/json
{
  • "affiliate_id": "string",
  • "approval_requested": true,
  • "confirmation": true,
  • "customer": "string",
  • "delete_if_unpaid": true,
  • "delivery": true,
  • "digital_dispatch": true,
  • "due_date": "2019-08-24",
  • "external_notes": "string",
  • "host": "string",
  • "invitation": "string",
  • "internal_notes": "string",
  • "invoice_address": "string",
  • "is_approved": true,
  • "is_rejected": true,
  • "next_reminder": "2019-08-24",
  • "origin": "string",
  • "remote_address": "string",
  • "send_reminders": true,
  • "user_agent": "string",
  • "will_call": true
}

Get only head data of GET request

Responses

Update one or multiple bookings

Responses

Response samples

Content type
application/json
{
  • "affiliate_id": "string",
  • "approval_requested": true,
  • "confirmation": true,
  • "customer": "string",
  • "delete_if_unpaid": true,
  • "delivery": true,
  • "digital_dispatch": true,
  • "due_date": "2019-08-24",
  • "external_notes": "string",
  • "host": "string",
  • "invitation": "string",
  • "internal_notes": "string",
  • "invoice_address": "string",
  • "is_approved": true,
  • "is_rejected": true,
  • "next_reminder": "2019-08-24",
  • "origin": "string",
  • "remote_address": "string",
  • "send_reminders": true,
  • "user_agent": "string",
  • "will_call": true
}

Get a single booking

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid_readable": "string",
  • "confirmation": true,
  • "delivery_method": "string",
  • "tickets_breakdown": { },
  • "pay_before_dispatch": true,
  • "is_dispatchable": true,
  • "urls": { },
  • "invoice_urls": { },
  • "denormalized_customer_pid": "string",
  • "denormalized_customer_fullname": "string",
  • "denormalized_customer_name_and_city": "string",
  • "denormalized_customer_country": "string",
  • "pid": 0,
  • "destination_country": "string",
  • "affiliate_id": "string",
  • "origin": "string",
  • "user_agent": "string",
  • "remote_address": "string",
  • "from_embed": true,
  • "source": "string",
  • "embed_session_id": "string",
  • "tos": true,
  • "digital_dispatch": true,
  • "delivery": true,
  • "will_call": true,
  • "deleted_by_customer": true,
  • "pos": true,
  • "internal_notes": "string",
  • "external_notes": "string",
  • "invoice_address": "string",
  • "checkbox_values": [
    ],
  • "payment_status_code": 0,
  • "first_full_payment": "2019-08-24T14:15:22Z",
  • "due_date": "2019-08-24T14:15:22Z",
  • "send_reminders": true,
  • "delete_if_unpaid": true,
  • "reminded_that_unpaid_at": "2019-08-24T14:15:22Z",
  • "next_reminder": "2019-08-24T14:15:22Z",
  • "refund_bank_account": "string",
  • "refund_bank_account_owner": "string",
  • "refund_bank_account_city": "string",
  • "approved": "2019-08-24T14:15:22Z",
  • "rejected": "2019-08-24T14:15:22Z",
  • "approval_requested": true,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": null,
  • "_links": {
    }
}

Delete a booking

path Parameters
pid
required
string

Responses

Update a single booking

path Parameters
pid
required
string
Request Body schema: application/json
affiliate_id
string

Affiliate id - a custom string to identify the origin of a booking

approval_requested
boolean

Flag whether approval is requested for this booking

confirmation
boolean

Set true to confirm a booking. A booking must have a customer and tickets to be confirmed.

customer
string

Public identifier (pid) of a person

delete_if_unpaid
boolean

Flag whether the booking should be deleted if it remains unpaid, if applicable

delivery
boolean

Flag whether this booking is dispatched by snail mail

digital_dispatch
boolean

Flag whether this booking is dispatched digitally

due_date
string <date>

Due date until when the booking needs to be paid

external_notes
string

External notes, visible for the customer

host
string

Public identifier (pid) of a host

internal_notes
string

Internal notes

invitation
string

Public identifier (pid) of an invitation

invoice_address
string

Alternative invoice address

is_approved
boolean

Set true to approve a booking for which approval was requested.

is_rejected
boolean

Set true to reject a booking for which approval was requested.

next_reminder
string <date>

Date when the next payment reminder will be sent, if needed

origin
string

Origin where this booking was created, e.q. url of a website, name of an app, etc.

remote_address
string

IP address of the ticket buyer

send_reminders
boolean

Flag whether payment reminders should be sent for this booking, if applicable

user_agent
string

User agent string of the ticket buyer

will_call
boolean

Flag whether this booking will be picked up at the boxoffice

Responses

Request samples

Content type
application/json
{
  • "affiliate_id": "string",
  • "approval_requested": true,
  • "confirmation": true,
  • "customer": "string",
  • "delete_if_unpaid": true,
  • "delivery": true,
  • "digital_dispatch": true,
  • "due_date": "2019-08-24",
  • "external_notes": "string",
  • "host": "string",
  • "invitation": "string",
  • "internal_notes": "string",
  • "invoice_address": "string",
  • "is_approved": true,
  • "is_rejected": true,
  • "next_reminder": "2019-08-24",
  • "origin": "string",
  • "remote_address": "string",
  • "send_reminders": true,
  • "user_agent": "string",
  • "will_call": true
}

Get the host of a booking

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "care_of": "string",
  • "address1": "string",
  • "address2": "string",
  • "zip": "string",
  • "city": "string",
  • "country": "string",
  • "will_call_label": "string",
  • "will_call_instructions": "string",
  • "send_reminders": true,
  • "delete_unpaid_bookings": true,
  • "public_email": "string",
  • "public_email_sender_name": "string",
  • "public_phone": "string",
  • "website": "string",
  • "bank_account": "string",
  • "bank_account_owner": "string",
  • "bank_account_city": "string",
  • "invoice_address": "string",
  • "vat_number": "string",
  • "thank_you_close": "string",
  • "complimentary_close": "string",
  • "contact_text": "string",
  • "confirmation_extras_template": "string",
  • "tos_title": "string",
  • "tos": "string",
  • "saferpay_terminal_id": "string",
  • "shared_secret": "string",
  • "prompt_newsletter": false,
  • "prompt_acquisition_channel": false,
  • "execute_deliveries": true,
  • "check_newsletter_by_default": false,
  • "address_right": false,
  • "enable_crm": false,
  • "enable_staff": false,
  • "enable_invitations": false,
  • "enable_seat_category_changes": false,
  • "enable_remaining_voucher_value_handling": false,
  • "enable_donations": false,
  • "execute_payouts": true,
  • "cancellation_policy": "strict",
  • "enable_salutation": true,
  • "use_security_code": true,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "allow_user_to_delete_booking": true,
  • "allow_embed_session_id": true,
  • "allow_single_empty_seats": true,
  • "setup_information": "string",
  • "support_info": "string",
  • "notify_on_new_booking": false,
  • "notification_email": "string",
  • "fee_percentage": "string",
  • "fee_minimal_commission": "string",
  • "fee_free_ticket_commission": "string",
  • "fee_included_free_tickets_percentage": 100,
  • "fee_payment_base_commission": "string",
  • "fee_payment_percentage": "string",
  • "_links": {
    }
}

Get the customer of a booking

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "address1": "string",
  • "address2": "string",
  • "zip": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "translations": { },
  • "pid": "string",
  • "salutation": "string",
  • "title": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "company": "string",
  • "department": "string",
  • "position": "string",
  • "phone": "string",
  • "phone2": "string",
  • "phone3": "string",
  • "email": "string",
  • "birthday": "2019-08-24T14:15:22Z",
  • "newsletter": true,
  • "mailing": true,
  • "website": "string",
  • "locale": "string",
  • "address": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the invitation of a booking

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "code": "string",
  • "expiration": "2019-08-24T14:15:22Z",
  • "personal": true,
  • "single_use": true,
  • "tickets_max_per_show": 0,
  • "tickets_max_per_event": 0,
  • "tickets_max_total": 0,
  • "tickets_max_per_booking": 0,
  • "max_different_shows": 0,
  • "rsvp": true,
  • "declined_at": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get option items of a booking

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "denormalized_option_pid": "string",
  • "denormalized_option_name": "string",
  • "denormalized_option_description": "string",
  • "denormalized_event_pid": "string",
  • "denormalized_event_name": "string",
  • "denormalized_vat_pid": "string",
  • "denormalized_vat_rate": "string",
  • "denormalized_vat_included": "string",
  • "denormalized_price": "string",
  • "denormalized_price_including_vat": "string",
  • "denormalized_price_excluding_vat": "string",
  • "denormalized_vat_amount": "string",
  • "denormalized_currency_pid": "string",
  • "pid": "string",
  • "option_variable_values": [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get tickets of a booking

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "_links": {
    },
  • "discr": "ticket"
}

Get payments of a booking

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "confirmation": true,
  • "payment_date": "2019-08-24T14:15:22Z",
  • "pid": "string",
  • "amount": "string",
  • "fee": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get emails of a booking

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "receiver_email": "string",
  • "from_email": "string",
  • "from_name": "string",
  • "reply_to_email": "string",
  • "reply_to_name": "string",
  • "subject": "string",
  • "text": "string",
  • "text_moved_to_storage": false,
  • "html": "string",
  • "html_moved_to_storage": false,
  • "attachments": [ ],
  • "sent": "2019-08-24T14:15:22Z",
  • "failed": "2019-08-24T14:15:22Z",
  • "failed_type": "string",
  • "opened": "2019-08-24T14:15:22Z",
  • "bounced": "2019-08-24T14:15:22Z",
  • "bounced_type": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get annotation values of a booking

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "value": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get deliveries of a booking

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "confirmation": true,
  • "price_excluding_vat": 0,
  • "price_including_vat": 0,
  • "vat_amount": 0,
  • "vat_rate": 0,
  • "price": 0,
  • "pid": "string",
  • "status_updated_at": "2019-08-24T14:15:22Z",
  • "paid_for_by_receiver": true,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get vats of a booking

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "country": "string",
  • "rate": "string",
  • "included": false,
  • "default_for_country": false,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

BoxOffice

A BoxOffice is the physical place where tickets are sold right at the venue.

Get all box offices

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Create one or multiple box offices

Request Body schema: application/json
group
required
string

Public identifier (pid) of a user group

host
required
string

Public identifier (pid) of a host

name
required
string

Name

enable_switch_show
boolean

Flag whether to enable to change shows / dates in box office

force_public_scope_on_date_switch
boolean

Flag whether to force public booking scope when date is changed

Responses

Request samples

Content type
application/json
{
  • "group": "string",
  • "host": "string",
  • "name": "string",
  • "enable_switch_show": true,
  • "force_public_scope_on_date_switch": true
}

Get only head data of GET request

Responses

Update one or multiple BoxOffices

Request Body schema: application/json
group
required
string

Public identifier (pid) of a user group

host
required
string

Public identifier (pid) of a host

name
required
string

Name

enable_switch_show
boolean

Flag whether to enable to change shows / dates in box office

force_public_scope_on_date_switch
boolean

Flag whether to force public booking scope when date is changed

Responses

Request samples

Content type
application/json
{
  • "group": "string",
  • "host": "string",
  • "name": "string",
  • "enable_switch_show": true,
  • "force_public_scope_on_date_switch": true
}

Get a single box office

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Delete a box office

path Parameters
pid
required
string

Responses

Update a single box office

path Parameters
pid
required
string
Request Body schema: application/json
group
required
string

Public identifier (pid) of a user group

host
required
string

Public identifier (pid) of a host

name
required
string

Name

enable_switch_show
boolean

Flag whether to enable to change shows / dates in box office

force_public_scope_on_date_switch
boolean

Flag whether to force public booking scope when date is changed

Responses

Request samples

Content type
application/json
{
  • "group": "string",
  • "host": "string",
  • "name": "string",
  • "enable_switch_show": true,
  • "force_public_scope_on_date_switch": true
}

Get the host of a box office

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "care_of": "string",
  • "address1": "string",
  • "address2": "string",
  • "zip": "string",
  • "city": "string",
  • "country": "string",
  • "will_call_label": "string",
  • "will_call_instructions": "string",
  • "send_reminders": true,
  • "delete_unpaid_bookings": true,
  • "public_email": "string",
  • "public_email_sender_name": "string",
  • "public_phone": "string",
  • "website": "string",
  • "bank_account": "string",
  • "bank_account_owner": "string",
  • "bank_account_city": "string",
  • "invoice_address": "string",
  • "vat_number": "string",
  • "thank_you_close": "string",
  • "complimentary_close": "string",
  • "contact_text": "string",
  • "confirmation_extras_template": "string",
  • "tos_title": "string",
  • "tos": "string",
  • "saferpay_terminal_id": "string",
  • "shared_secret": "string",
  • "prompt_newsletter": false,
  • "prompt_acquisition_channel": false,
  • "execute_deliveries": true,
  • "check_newsletter_by_default": false,
  • "address_right": false,
  • "enable_crm": false,
  • "enable_staff": false,
  • "enable_invitations": false,
  • "enable_seat_category_changes": false,
  • "enable_remaining_voucher_value_handling": false,
  • "enable_donations": false,
  • "execute_payouts": true,
  • "cancellation_policy": "strict",
  • "enable_salutation": true,
  • "use_security_code": true,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "allow_user_to_delete_booking": true,
  • "allow_embed_session_id": true,
  • "allow_single_empty_seats": true,
  • "setup_information": "string",
  • "support_info": "string",
  • "notify_on_new_booking": false,
  • "notification_email": "string",
  • "fee_percentage": "string",
  • "fee_minimal_commission": "string",
  • "fee_free_ticket_commission": "string",
  • "fee_included_free_tickets_percentage": 100,
  • "fee_payment_base_commission": "string",
  • "fee_payment_percentage": "string",
  • "_links": {
    }
}

Get the group of a box office

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z"
}

Cashbox

A Cashbox represents a payment mean at a BoxOffice or at the Host.

Get all cashboxes

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "host": {
    },
  • "payment_method": {
    },
  • "name": "string",
  • "_links": {
    }
}

Create one or multiple cashboxes

Request Body schema: application/json
host
required
string

Public identifier (pid) of a host

name
required
string
payment_method
required
string
Enum: "cash" "creditcard" "twint"

Payment method applied to this cashbox. Use "cash" for all payments collected directly by the host (for example via their own creditcard terminal).

Responses

Request samples

Content type
application/json
{
  • "host": "string",
  • "payment_method": "cash",
  • "name": "string"
}

Get only head data of GET request

Responses

Update one or multiple cashboxes

Request Body schema: application/json
host
required
string

Public identifier (pid) of a host

name
required
string
payment_method
required
string
Enum: "cash" "creditcard" "twint"

Payment method applied to this cashbox. Use "cash" for all payments collected directly by the host (for example via their own creditcard terminal).

Responses

Request samples

Content type
application/json
{
  • "host": "string",
  • "payment_method": "cash",
  • "name": "string"
}

Get a single cashbox

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "host": {
    },
  • "payment_method": {
    },
  • "name": "string",
  • "_links": {
    }
}

Delete a cashbox

path Parameters
pid
required
string

Responses

Update a cashbox

path Parameters
pid
required
string
Request Body schema: application/json
host
required
string

Public identifier (pid) of a host

name
required
string
payment_method
required
string
Enum: "cash" "creditcard" "twint"

Payment method applied to this cashbox. Use "cash" for all payments collected directly by the host (for example via their own creditcard terminal).

Responses

Request samples

Content type
application/json
{
  • "host": "string",
  • "payment_method": "cash",
  • "name": "string"
}

CheckboxDefinition

A CheckboxDefinition represent a checkbox which is shown at the end of the ticket booking process. It can be used for example if the ticket buyer needs to actively agree to specific conditions.

Get all Checkbox definitions

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "host": {
    },
  • "title": "string",
  • "label": "string",
  • "required": true,
  • "default_value": true,
  • "order": 0
}

Create one or multiple Checkbox definitions

Request Body schema: application/json
host
required
string

Public identifier (pid) of a Host

label
required
string

Checkbox label

title
required
string

Checkbox title

default_value
boolean

Default value for the checkbox

order
integer

Order index in lists (lowest to highest)

required
boolean

Flag whether the checkbox must be checked during booking process

Responses

Request samples

Content type
application/json
{
  • "host": "string",
  • "title": "string",
  • "label": "string",
  • "required": true,
  • "default_value": true,
  • "order": 0
}

Get only head data of GET request

Responses

Update one or multiple Checkbox definitions

Request Body schema: application/json
host
required
string

Public identifier (pid) of a Host

label
required
string

Checkbox label

title
required
string

Checkbox title

default_value
boolean

Default value for the checkbox

order
integer

Order index in lists (lowest to highest)

required
boolean

Flag whether the checkbox must be checked during booking process

Responses

Request samples

Content type
application/json
{
  • "host": "string",
  • "title": "string",
  • "label": "string",
  • "required": true,
  • "default_value": true,
  • "order": 0
}

Get a single Checkbox definition

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "host": {
    },
  • "title": "string",
  • "label": "string",
  • "required": true,
  • "default_value": true,
  • "order": 0
}

Delete a Checkbox definition

path Parameters
pid
required
string

Responses

Update a Checkbox definition

path Parameters
pid
required
string
Request Body schema: application/json
host
required
string

Public identifier (pid) of a Host

label
required
string

Checkbox label

title
required
string

Checkbox title

default_value
boolean

Default value for the checkbox

order
integer

Order index in lists (lowest to highest)

required
boolean

Flag whether the checkbox must be checked during booking process

Responses

Request samples

Content type
application/json
{
  • "host": "string",
  • "title": "string",
  • "label": "string",
  • "required": true,
  • "default_value": true,
  • "order": 0
}

Update a Checkbox definition

path Parameters
pid
required
string
Request Body schema: application/json
host
required
string

Public identifier (pid) of a Host

label
required
string

Checkbox label

title
required
string

Checkbox title

default_value
boolean

Default value for the checkbox

order
integer

Order index in lists (lowest to highest)

required
boolean

Flag whether the checkbox must be checked during booking process

Responses

Request samples

Content type
application/json
{
  • "host": "string",
  • "title": "string",
  • "label": "string",
  • "required": true,
  • "default_value": true,
  • "order": 0
}

Client

A Client represents a ticketing company. Like Ticketpark.

Get all clients

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "legal_name": "string",
  • "address": "string",
  • "zip": "string",
  • "city": "string",
  • "country": "string",
  • "internal_email": "string",
  • "public_email": "string",
  • "public_email_sender_name": "string",
  • "fee_minimal_commission": "string",
  • "fee_free_ticket_commission": "string",
  • "fee_included_free_tickets_percentage": 100,
  • "fee_ticket_options_percentage": "0.00",
  • "fee_options_percentage": "0.00",
  • "important_host_info": "string",
  • "enable_waiting_room": false,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get only head data of GET request

Responses

Get a single client

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "legal_name": "string",
  • "address": "string",
  • "zip": "string",
  • "city": "string",
  • "country": "string",
  • "internal_email": "string",
  • "public_email": "string",
  • "public_email_sender_name": "string",
  • "fee_minimal_commission": "string",
  • "fee_free_ticket_commission": "string",
  • "fee_included_free_tickets_percentage": 100,
  • "fee_ticket_options_percentage": "0.00",
  • "fee_options_percentage": "0.00",
  • "important_host_info": "string",
  • "enable_waiting_room": false,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the delivery costs of a client

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "destination_country": "string",
  • "rate": "string",
  • "include_tickets": true,
  • "handling_period": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the currencies of a client

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "round_to_cents": 0,
  • "_links": {
    }
}

Get the acquisition channels of a client

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "translation_key": "string",
  • "order": 0,
  • "_links": {
    }
}

Coupon

A Coupon is a form of payment.

Get all coupons

Responses

Response samples

Content type
application/json
Example
{
  • "_links": {
    },
  • "discr": "coupon"
}

Create one or multiple coupons

Request Body schema: application/json
code
required
string

Code of the coupon

coupon_group
required
string

Public identifier (pid) of a coupon group

booking
string

Public identifier (pid) of a booking, when the coupon is bought in a coupon shop

disabled
boolean

Flag whether the coupon is disabled

expiration
string <date-time>

Expiration date of the coupon

multi_coupons
Array of strings

A list of codes of multi coupons the coupon belongs to

value_absolute
any

Absolute value of the coupon

Responses

Request samples

Content type
application/json
{
  • "coupon_group": "string",
  • "code": "string",
  • "multi_coupons": [
    ],
  • "booking": "string",
  • "disabled": true,
  • "value_absolute": null,
  • "expiration": "2019-08-24T14:15:22Z"
}

Get only head data of GET request

Responses

Update one or multiple coupons

Request Body schema: application/json
code
required
string

Code of the coupon

coupon_group
required
string

Public identifier (pid) of a coupon group

booking
string

Public identifier (pid) of a booking, when the coupon is bought in a coupon shop

disabled
boolean

Flag whether the coupon is disabled

expiration
string <date-time>

Expiration date of the coupon

multi_coupons
Array of strings

A list of codes of multi coupons the coupon belongs to

value_absolute
any

Absolute value of the coupon

Responses

Request samples

Content type
application/json
{
  • "coupon_group": "string",
  • "code": "string",
  • "multi_coupons": [
    ],
  • "booking": "string",
  • "disabled": true,
  • "value_absolute": null,
  • "expiration": "2019-08-24T14:15:22Z"
}

Get a single coupon

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "_links": {
    },
  • "discr": "coupon"
}

Delete a coupon

path Parameters
pid
required
string

Responses

Update a coupon

path Parameters
pid
required
string
Request Body schema: application/json
code
required
string

Code of the coupon

coupon_group
required
string

Public identifier (pid) of a coupon group

booking
string

Public identifier (pid) of a booking, when the coupon is bought in a coupon shop

disabled
boolean

Flag whether the coupon is disabled

expiration
string <date-time>

Expiration date of the coupon

multi_coupons
Array of strings

A list of codes of multi coupons the coupon belongs to

value_absolute
any

Absolute value of the coupon

Responses

Request samples

Content type
application/json
{
  • "coupon_group": "string",
  • "code": "string",
  • "multi_coupons": [
    ],
  • "booking": "string",
  • "disabled": true,
  • "value_absolute": null,
  • "expiration": "2019-08-24T14:15:22Z"
}

Update a coupon

path Parameters
pid
required
string
Request Body schema: application/json
code
required
string

Code of the coupon

coupon_group
required
string

Public identifier (pid) of a coupon group

booking
string

Public identifier (pid) of a booking, when the coupon is bought in a coupon shop

disabled
boolean

Flag whether the coupon is disabled

expiration
string <date-time>

Expiration date of the coupon

multi_coupons
Array of strings

A list of codes of multi coupons the coupon belongs to

value_absolute
any

Absolute value of the coupon

Responses

Request samples

Content type
application/json
{
  • "coupon_group": "string",
  • "code": "string",
  • "multi_coupons": [
    ],
  • "booking": "string",
  • "disabled": true,
  • "value_absolute": null,
  • "expiration": "2019-08-24T14:15:22Z"
}

Get the coupon group of a coupon

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": null,
  • "name": "string",
  • "code_format": "string",
  • "value_absolute": "string",
  • "value_percent": 1,
  • "value_max": "string",
  • "value_one_ticket": true,
  • "apply_to_tickets_only": false,
  • "allow_redemptions": 1,
  • "maximal_ticket_value": "string",
  • "minimal_booking_value": "string",
  • "max_coupons_per_booking": 0,
  • "expiration": "2019-08-24T14:15:22Z",
  • "available_in_shop": false,
  • "paid": false,
  • "for_individual_values": false,
  • "order": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the payments of a coupon.

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "confirmation": true,
  • "payment_date": "2019-08-24T14:15:22Z",
  • "pid": "string",
  • "amount": "string",
  • "fee": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Generate coupons

Request Body schema: application/json
coupon_group
required
string

Public identifier (pid) of a coupon group

quantity
required
integer

The number of coupons to generate

Responses

Request samples

Content type
application/json
{
  • "coupon_group": "string",
  • "quantity": 0
}

CouponGroup

A CouponGroup defines basic like value or scope of validity for the Coupons that it contains.

Get all coupon groups

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": null,
  • "name": "string",
  • "code_format": "string",
  • "value_absolute": "string",
  • "value_percent": 1,
  • "value_max": "string",
  • "value_one_ticket": true,
  • "apply_to_tickets_only": false,
  • "allow_redemptions": 1,
  • "maximal_ticket_value": "string",
  • "minimal_booking_value": "string",
  • "max_coupons_per_booking": 0,
  • "expiration": "2019-08-24T14:15:22Z",
  • "available_in_shop": false,
  • "paid": false,
  • "for_individual_values": false,
  • "order": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Create one or multiple groups

Request Body schema: application/json
code_format
required
string

Code format

is_for_individual_values
required
boolean

Flag whether coupons of this coupon group have individual values

is_paid
required
boolean

Flag whether coupons of this coupon group are sold or given away

name
required
string

Name

allow_redemptions
integer

Number of allowed redemptions of contained coupons. Set to null for unlimited redemptions.

apply_to_ticket_only
boolean

Flag whether coupons in this group can only be applied to tickets (but not to options or ticket options)

available_in_shop
boolean

Flag whether this coupon group is available in public coupon shop

currency
string
Enum: "CHF" "EUR" "USD"

Currency of the coupon, if sold in coupon shop

events
Array of strings

List of public identifiers (pid) of events where the coupons should be valid

expiration
string <date-time>

Expiration date of coupons

host
string

Public identifier (pid) of a host

max_coupons_per_booking
integer

Maximum number of coupons of this coupon group allowed within the same booking. Set null or 0 for unlimited usage. Set -1 to allow as many coupons as there are tickets in the booking.

maximal_ticket_value
any

Maximal value a ticket may have in order to be considered by a value_one_ticket coupon

minimal_booking_value
any

Minimal value the booking must have in order to accept the coupon

order
integer
prices
Array of strings

List of public identifiers (pid) of prices where the coupons should be valid

shows
Array of strings

List of public identifiers (pid) of shows where the coupons should be valid

value_absolute
any

Absolute value of the coupon

value_max
any

Maximum absolute value of the percentage coupon

value_one_ticket
boolean

Flag whether the value of the coupons equals one ticket of any price

value_percent
number

Percent value of the coupon

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "code_format": "string",
  • "allow_redemptions": 0,
  • "apply_to_ticket_only": true,
  • "available_in_shop": true,
  • "is_paid": true,
  • "is_for_individual_values": true,
  • "currency": "CHF",
  • "events": [
    ],
  • "expiration": "2019-08-24T14:15:22Z",
  • "host": "string",
  • "maximal_ticket_value": null,
  • "minimal_booking_value": null,
  • "max_coupons_per_booking": 0,
  • "order": 0,
  • "prices": [
    ],
  • "shows": [
    ],
  • "value_absolute": null,
  • "value_one_ticket": true,
  • "value_percent": 0,
  • "value_max": null
}

Get only head data of GET request

Responses

Update one or multiple coupon groups

Request Body schema: application/json
code_format
required
string

Code format

is_for_individual_values
required
boolean

Flag whether coupons of this coupon group have individual values

is_paid
required
boolean

Flag whether coupons of this coupon group are sold or given away

name
required
string

Name

allow_redemptions
integer

Number of allowed redemptions of contained coupons. Set to null for unlimited redemptions.

apply_to_ticket_only
boolean

Flag whether coupons in this group can only be applied to tickets (but not to options or ticket options)

available_in_shop
boolean

Flag whether this coupon group is available in public coupon shop

currency
string
Enum: "CHF" "EUR" "USD"

Currency of the coupon, if sold in coupon shop

events
Array of strings

List of public identifiers (pid) of events where the coupons should be valid

expiration
string <date-time>

Expiration date of coupons

host
string

Public identifier (pid) of a host

max_coupons_per_booking
integer

Maximum number of coupons of this coupon group allowed within the same booking. Set null or 0 for unlimited usage. Set -1 to allow as many coupons as there are tickets in the booking.

maximal_ticket_value
any

Maximal value a ticket may have in order to be considered by a value_one_ticket coupon

minimal_booking_value
any

Minimal value the booking must have in order to accept the coupon

order
integer
prices
Array of strings

List of public identifiers (pid) of prices where the coupons should be valid

shows
Array of strings

List of public identifiers (pid) of shows where the coupons should be valid

value_absolute
any

Absolute value of the coupon

value_max
any

Maximum absolute value of the percentage coupon

value_one_ticket
boolean

Flag whether the value of the coupons equals one ticket of any price

value_percent
number

Percent value of the coupon

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "code_format": "string",
  • "allow_redemptions": 0,
  • "apply_to_ticket_only": true,
  • "available_in_shop": true,
  • "is_paid": true,
  • "is_for_individual_values": true,
  • "currency": "CHF",
  • "events": [
    ],
  • "expiration": "2019-08-24T14:15:22Z",
  • "host": "string",
  • "maximal_ticket_value": null,
  • "minimal_booking_value": null,
  • "max_coupons_per_booking": 0,
  • "order": 0,
  • "prices": [
    ],
  • "shows": [
    ],
  • "value_absolute": null,
  • "value_one_ticket": true,
  • "value_percent": 0,
  • "value_max": null
}

Get a single coupon group

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": null,
  • "name": "string",
  • "code_format": "string",
  • "value_absolute": "string",
  • "value_percent": 1,
  • "value_max": "string",
  • "value_one_ticket": true,
  • "apply_to_tickets_only": false,
  • "allow_redemptions": 1,
  • "maximal_ticket_value": "string",
  • "minimal_booking_value": "string",
  • "max_coupons_per_booking": 0,
  • "expiration": "2019-08-24T14:15:22Z",
  • "available_in_shop": false,
  • "paid": false,
  • "for_individual_values": false,
  • "order": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Delete a coupon group

path Parameters
pid
required
string

Responses

Update a coupon group

path Parameters
pid
required
string
Request Body schema: application/json
code_format
required
string

Code format

is_for_individual_values
required
boolean

Flag whether coupons of this coupon group have individual values

is_paid
required
boolean

Flag whether coupons of this coupon group are sold or given away

name
required
string

Name

allow_redemptions
integer

Number of allowed redemptions of contained coupons. Set to null for unlimited redemptions.

apply_to_ticket_only
boolean

Flag whether coupons in this group can only be applied to tickets (but not to options or ticket options)

available_in_shop
boolean

Flag whether this coupon group is available in public coupon shop

currency
string
Enum: "CHF" "EUR" "USD"

Currency of the coupon, if sold in coupon shop

events
Array of strings

List of public identifiers (pid) of events where the coupons should be valid

expiration
string <date-time>

Expiration date of coupons

host
string

Public identifier (pid) of a host

max_coupons_per_booking
integer

Maximum number of coupons of this coupon group allowed within the same booking. Set null or 0 for unlimited usage. Set -1 to allow as many coupons as there are tickets in the booking.

maximal_ticket_value
any

Maximal value a ticket may have in order to be considered by a value_one_ticket coupon

minimal_booking_value
any

Minimal value the booking must have in order to accept the coupon

order
integer
prices
Array of strings

List of public identifiers (pid) of prices where the coupons should be valid

shows
Array of strings

List of public identifiers (pid) of shows where the coupons should be valid

value_absolute
any

Absolute value of the coupon

value_max
any

Maximum absolute value of the percentage coupon

value_one_ticket
boolean

Flag whether the value of the coupons equals one ticket of any price

value_percent
number

Percent value of the coupon

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "code_format": "string",
  • "allow_redemptions": 0,
  • "apply_to_ticket_only": true,
  • "available_in_shop": true,
  • "is_paid": true,
  • "is_for_individual_values": true,
  • "currency": "CHF",
  • "events": [
    ],
  • "expiration": "2019-08-24T14:15:22Z",
  • "host": "string",
  • "maximal_ticket_value": null,
  • "minimal_booking_value": null,
  • "max_coupons_per_booking": 0,
  • "order": 0,
  • "prices": [
    ],
  • "shows": [
    ],
  • "value_absolute": null,
  • "value_one_ticket": true,
  • "value_percent": 0,
  • "value_max": null
}

Get the host of a coupon group

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "care_of": "string",
  • "address1": "string",
  • "address2": "string",
  • "zip": "string",
  • "city": "string",
  • "country": "string",
  • "will_call_label": "string",
  • "will_call_instructions": "string",
  • "send_reminders": true,
  • "delete_unpaid_bookings": true,
  • "public_email": "string",
  • "public_email_sender_name": "string",
  • "public_phone": "string",
  • "website": "string",
  • "bank_account": "string",
  • "bank_account_owner": "string",
  • "bank_account_city": "string",
  • "invoice_address": "string",
  • "vat_number": "string",
  • "thank_you_close": "string",
  • "complimentary_close": "string",
  • "contact_text": "string",
  • "confirmation_extras_template": "string",
  • "tos_title": "string",
  • "tos": "string",
  • "saferpay_terminal_id": "string",
  • "shared_secret": "string",
  • "prompt_newsletter": false,
  • "prompt_acquisition_channel": false,
  • "execute_deliveries": true,
  • "check_newsletter_by_default": false,
  • "address_right": false,
  • "enable_crm": false,
  • "enable_staff": false,
  • "enable_invitations": false,
  • "enable_seat_category_changes": false,
  • "enable_remaining_voucher_value_handling": false,
  • "enable_donations": false,
  • "execute_payouts": true,
  • "cancellation_policy": "strict",
  • "enable_salutation": true,
  • "use_security_code": true,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "allow_user_to_delete_booking": true,
  • "allow_embed_session_id": true,
  • "allow_single_empty_seats": true,
  • "setup_information": "string",
  • "support_info": "string",
  • "notify_on_new_booking": false,
  • "notification_email": "string",
  • "fee_percentage": "string",
  • "fee_minimal_commission": "string",
  • "fee_free_ticket_commission": "string",
  • "fee_included_free_tickets_percentage": 100,
  • "fee_payment_base_commission": "string",
  • "fee_payment_percentage": "string",
  • "_links": {
    }
}

Get the events of a coupon group

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "timespan": { },
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "performer": "string",
  • "ticketdescription": "string",
  • "description": "string",
  • "delivery_info": "string",
  • "confirmation_extras_template": "string",
  • "will_call_label": "string",
  • "pay_before_dispatch": false,
  • "immediate_payment_only": false,
  • "send_reminders": true,
  • "delete_unpaid_bookings_mode": "never",
  • "allow_digital_dispatch": true,
  • "allow_deliveries": false,
  • "allow_will_call": false,
  • "issue_tickets": true,
  • "enable_passbook_tickets": true,
  • "require_customer_company": false,
  • "require_customer_address": true,
  • "require_customer_phone": false,
  • "prompt_customer_position": false,
  • "prompt_customer_department": false,
  • "prompt_customer_title": false,
  • "prompt_customer_birthday": false,
  • "allow_customer_notes": false,
  • "allow_invoice_address": false,
  • "allow_single_empty_seats": true,
  • "is_hidden": false,
  • "excluded_from_revenue_stats": false,
  • "tickets_per_booking": 1,
  • "tickets_in_listings": 1,
  • "refine_info": "string",
  • "reservation_info": "string",
  • "sales_point_info": "string",
  • "support_info": "string",
  • "payout_interval": "string",
  • "payout_interval_specification": "string",
  • "is_cancelled": true,
  • "will_be_postponed": true,
  • "cancellation_info": "string",
  • "invoice_address": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "notify_on_new_booking": false,
  • "notification_email": "string",
  • "fee_percentage": "string",
  • "fee_minimal_commission": "string",
  • "fee_free_ticket_commission": "string",
  • "fee_included_free_tickets_percentage": 100,
  • "fee_payment_base_commission": "string",
  • "fee_payment_percentage": "string",
  • "_links": {
    }
}

Get the shows of a coupon group

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "access_role": "string",
  • "beacon_data": { },
  • "translations": { },
  • "pid": "string",
  • "performer": "string",
  • "ticketdescription": "string",
  • "description": "string",
  • "subtitle": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "end_check_in": "2019-08-24T14:15:22Z",
  • "start_public_sales": "2019-08-24T14:15:22Z",
  • "end_sales": "2019-08-24T14:15:22Z",
  • "end_sales_alternative": "string",
  • "dooropening": "2019-08-24T14:15:22Z",
  • "specific_capacity": 1,
  • "allow_sales_while_current": false,
  • "allow_single_empty_seats": true,
  • "always_display_start_time": false,
  • "reservation_info": "string",
  • "request_ratings": false,
  • "order": 0,
  • "is_cancelled": true,
  • "will_be_postponed": true,
  • "is_online_show": true,
  • "online_show": {
    },
  • "tickets_per_booking": 1,
  • "enable_passbook_tickets": true,
  • "access_by": "string",
  • "ratings_requested": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the prices of a coupon group

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "_links": {
    },
  • "discr": "price"
}

Get the coupons of a coupon group

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": null,
  • "name": "string",
  • "code_format": "string",
  • "value_absolute": "string",
  • "value_percent": 1,
  • "value_max": "string",
  • "value_one_ticket": true,
  • "apply_to_tickets_only": false,
  • "allow_redemptions": 1,
  • "maximal_ticket_value": "string",
  • "minimal_booking_value": "string",
  • "max_coupons_per_booking": 0,
  • "expiration": "2019-08-24T14:15:22Z",
  • "available_in_shop": false,
  • "paid": false,
  • "for_individual_values": false,
  • "order": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Currency

Currency – you know, as in Swiss Franc or Euro.

Get all currencies

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "round_to_cents": 0,
  • "_links": {
    }
}

Get only head data of GET request

Responses

Get a single currency

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "round_to_cents": 0,
  • "_links": {
    }
}

Delivery

A Delivery represents a postal delivery, when tickets and/or the invoice are mailed to a ticket buyer's house.

Get all deliveries

Responses

Response samples

Content type
application/json
{
  • "confirmation": true,
  • "price_excluding_vat": 0,
  • "price_including_vat": 0,
  • "vat_amount": 0,
  • "vat_rate": 0,
  • "price": 0,
  • "pid": "string",
  • "status_updated_at": "2019-08-24T14:15:22Z",
  • "paid_for_by_receiver": true,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Create one or multiple deliveries

Request Body schema: application/json
booking
required
string

Public identifier (pid) of a booking

delivery_rate
required
string

Public identifier (pid) of a delivery cost

confirmation
boolean

Set true to confirm a delivery

paid_for_by_receiver
boolean

Flag whether the receiver will pay the delivery costs. If false, the host will cover the costs.

Responses

Request samples

Content type
application/json
{
  • "booking": "string",
  • "delivery_rate": "string",
  • "paid_for_by_receiver": true,
  • "confirmation": true
}

Get only head data of GET request

Responses

Update one or multiple deliveries

Request Body schema: application/json
booking
required
string

Public identifier (pid) of a booking

delivery_rate
required
string

Public identifier (pid) of a delivery cost

confirmation
boolean

Set true to confirm a delivery

paid_for_by_receiver
boolean

Flag whether the receiver will pay the delivery costs. If false, the host will cover the costs.

Responses

Request samples

Content type
application/json
{
  • "booking": "string",
  • "delivery_rate": "string",
  • "paid_for_by_receiver": true,
  • "confirmation": true
}

Get a single delivery

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "confirmation": true,
  • "price_excluding_vat": 0,
  • "price_including_vat": 0,
  • "vat_amount": 0,
  • "vat_rate": 0,
  • "price": 0,
  • "pid": "string",
  • "status_updated_at": "2019-08-24T14:15:22Z",
  • "paid_for_by_receiver": true,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Delete a delivery

path Parameters
pid
required
string

Responses

Update a delivery

path Parameters
pid
required
string
Request Body schema: application/json
booking
required
string

Public identifier (pid) of a booking

delivery_rate
required
string

Public identifier (pid) of a delivery cost

confirmation
boolean

Set true to confirm a delivery

paid_for_by_receiver
boolean

Flag whether the receiver will pay the delivery costs. If false, the host will cover the costs.

Responses

Request samples

Content type
application/json
{
  • "booking": "string",
  • "delivery_rate": "string",
  • "paid_for_by_receiver": true,
  • "confirmation": true
}

Get the booking of a delivery

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid_readable": "string",
  • "confirmation": true,
  • "delivery_method": "string",
  • "tickets_breakdown": { },
  • "pay_before_dispatch": true,
  • "is_dispatchable": true,
  • "urls": { },
  • "invoice_urls": { },
  • "denormalized_customer_pid": "string",
  • "denormalized_customer_fullname": "string",
  • "denormalized_customer_name_and_city": "string",
  • "denormalized_customer_country": "string",
  • "pid": 0,
  • "destination_country": "string",
  • "affiliate_id": "string",
  • "origin": "string",
  • "user_agent": "string",
  • "remote_address": "string",
  • "from_embed": true,
  • "source": "string",
  • "embed_session_id": "string",
  • "tos": true,
  • "digital_dispatch": true,
  • "delivery": true,
  • "will_call": true,
  • "deleted_by_customer": true,
  • "pos": true,
  • "internal_notes": "string",
  • "external_notes": "string",
  • "invoice_address": "string",
  • "checkbox_values": [
    ],
  • "payment_status_code": 0,
  • "first_full_payment": "2019-08-24T14:15:22Z",
  • "due_date": "2019-08-24T14:15:22Z",
  • "send_reminders": true,
  • "delete_if_unpaid": true,
  • "reminded_that_unpaid_at": "2019-08-24T14:15:22Z",
  • "next_reminder": "2019-08-24T14:15:22Z",
  • "refund_bank_account": "string",
  • "refund_bank_account_owner": "string",
  • "refund_bank_account_city": "string",
  • "approved": "2019-08-24T14:15:22Z",
  • "rejected": "2019-08-24T14:15:22Z",
  • "approval_requested": true,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": null,
  • "_links": {
    }
}

Get the delivery rate of a delivery

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "destination_country": "string",
  • "rate": "string",
  • "include_tickets": true,
  • "handling_period": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

DeliveryRate

A DeliveryRate defines the price that needs to be paid to execute a Delivery.

Get all delivery rates

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "destination_country": "string",
  • "rate": "string",
  • "include_tickets": true,
  • "handling_period": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Create one or multiple delivery rates

Request Body schema: application/json
currency
required
string
Enum: "CHF" "EUR" "USD"

Public identifier (pid) of a currency

destination_country
required
string

Destination country (2 letters, ISO 3166-1 alpha-2)

handling_period
required
integer

How long the delivery takes to arrive at the receiver's (in seconds)

host
required
string

Public identifier (pid) of a host

include_tickets
required
boolean

Flag whether the tickets are included in the delivery

rate
required
any

Price

Responses

Request samples

Content type
application/json
{
  • "destination_country": "string",
  • "currency": "CHF",
  • "handling_period": 0,
  • "host": "string",
  • "include_tickets": true,
  • "rate": null
}

Get only head data of GET request

Responses

Update one or multiple DeliveryRates

Request Body schema: application/json
currency
required
string
Enum: "CHF" "EUR" "USD"

Public identifier (pid) of a currency

destination_country
required
string

Destination country (2 letters, ISO 3166-1 alpha-2)

handling_period
required
integer

How long the delivery takes to arrive at the receiver's (in seconds)

host
required
string

Public identifier (pid) of a host

include_tickets
required
boolean

Flag whether the tickets are included in the delivery

rate
required
any

Price

Responses

Request samples

Content type
application/json
{
  • "destination_country": "string",
  • "currency": "CHF",
  • "handling_period": 0,
  • "host": "string",
  • "include_tickets": true,
  • "rate": null
}

Get a single delivery rate

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "destination_country": "string",
  • "rate": "string",
  • "include_tickets": true,
  • "handling_period": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Delete a delivery rate

path Parameters
pid
required
string

Responses

Update a DeliveryRate

path Parameters
pid
required
string
Request Body schema: application/json
currency
required
string
Enum: "CHF" "EUR" "USD"

Public identifier (pid) of a currency

destination_country
required
string

Destination country (2 letters, ISO 3166-1 alpha-2)

handling_period
required
integer

How long the delivery takes to arrive at the receiver's (in seconds)

host
required
string

Public identifier (pid) of a host

include_tickets
required
boolean

Flag whether the tickets are included in the delivery

rate
required
any

Price

Responses

Request samples

Content type
application/json
{
  • "destination_country": "string",
  • "currency": "CHF",
  • "handling_period": 0,
  • "host": "string",
  • "include_tickets": true,
  • "rate": null
}

Get the client of a delivery rate

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "legal_name": "string",
  • "address": "string",
  • "zip": "string",
  • "city": "string",
  • "country": "string",
  • "internal_email": "string",
  • "public_email": "string",
  • "public_email_sender_name": "string",
  • "fee_minimal_commission": "string",
  • "fee_free_ticket_commission": "string",
  • "fee_included_free_tickets_percentage": 100,
  • "fee_ticket_options_percentage": "0.00",
  • "fee_options_percentage": "0.00",
  • "important_host_info": "string",
  • "enable_waiting_room": false,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the host of a delivery rate

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "care_of": "string",
  • "address1": "string",
  • "address2": "string",
  • "zip": "string",
  • "city": "string",
  • "country": "string",
  • "will_call_label": "string",
  • "will_call_instructions": "string",
  • "send_reminders": true,
  • "delete_unpaid_bookings": true,
  • "public_email": "string",
  • "public_email_sender_name": "string",
  • "public_phone": "string",
  • "website": "string",
  • "bank_account": "string",
  • "bank_account_owner": "string",
  • "bank_account_city": "string",
  • "invoice_address": "string",
  • "vat_number": "string",
  • "thank_you_close": "string",
  • "complimentary_close": "string",
  • "contact_text": "string",
  • "confirmation_extras_template": "string",
  • "tos_title": "string",
  • "tos": "string",
  • "saferpay_terminal_id": "string",
  • "shared_secret": "string",
  • "prompt_newsletter": false,
  • "prompt_acquisition_channel": false,
  • "execute_deliveries": true,
  • "check_newsletter_by_default": false,
  • "address_right": false,
  • "enable_crm": false,
  • "enable_staff": false,
  • "enable_invitations": false,
  • "enable_seat_category_changes": false,
  • "enable_remaining_voucher_value_handling": false,
  • "enable_donations": false,
  • "execute_payouts": true,
  • "cancellation_policy": "strict",
  • "enable_salutation": true,
  • "use_security_code": true,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "allow_user_to_delete_booking": true,
  • "allow_embed_session_id": true,
  • "allow_single_empty_seats": true,
  • "setup_information": "string",
  • "support_info": "string",
  • "notify_on_new_booking": false,
  • "notification_email": "string",
  • "fee_percentage": "string",
  • "fee_minimal_commission": "string",
  • "fee_free_ticket_commission": "string",
  • "fee_included_free_tickets_percentage": 100,
  • "fee_payment_base_commission": "string",
  • "fee_payment_percentage": "string",
  • "_links": {
    }
}

Get the currency of a delivery rate

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "round_to_cents": 0,
  • "_links": {
    }
}

Department

A Department represents an area where work can be assigned within the staff module.

Get all departments

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "pid": "string",
  • "name": "string",
  • "head": null,
  • "deputy_head": null,
  • "project": {
    },
  • "jobs": [
    ],
  • "staff_members": [
    ],
  • "batch_id": "string",
  • "batch_order": 0,
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get a single department

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "pid": "string",
  • "name": "string",
  • "head": null,
  • "deputy_head": null,
  • "project": {
    },
  • "jobs": [
    ],
  • "staff_members": [
    ],
  • "batch_id": "string",
  • "batch_order": 0,
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete a Department

path Parameters
pid
required
string

Responses

Distributor

A distributor represents a specific interface which is used to distribute tickets.

Get a single distributor

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "slug": "string",
  • "introtext": "string",
  • "prices_to_be_booked": [
    ]
}

Delete a distributor

path Parameters
pid
required
string

Responses

Update a single distributor

path Parameters
pid
required
string
Request Body schema: application/json
slug
required
string

Slug to be used in url

default_price_to_be_booked
string

Public identifier (pid) of a price

default_sector_to_be_booked
string

Public identifier (pid) of a sector

event
string

Public identifier (pid) of an event

introtext
string

Introtext displayed in distributor

single_shows_event
string

Public identifier (pid) of an event

Responses

Request samples

Content type
application/json
{
  • "slug": "string",
  • "introtext": "string",
  • "event": "string",
  • "single_shows_event": "string",
  • "default_price_to_be_booked": "string",
  • "default_sector_to_be_booked": "string"
}

Create one or multiple distributors

Request Body schema: application/json
slug
required
string

Slug to be used in url

default_price_to_be_booked
string

Public identifier (pid) of a price

default_sector_to_be_booked
string

Public identifier (pid) of a sector

event
string

Public identifier (pid) of an event

introtext
string

Introtext displayed in distributor

single_shows_event
string

Public identifier (pid) of an event

Responses

Request samples

Content type
application/json
{
  • "slug": "string",
  • "introtext": "string",
  • "event": "string",
  • "single_shows_event": "string",
  • "default_price_to_be_booked": "string",
  • "default_sector_to_be_booked": "string"
}

Update one or multiple distributors

Request Body schema: application/json
slug
required
string

Slug to be used in url

default_price_to_be_booked
string

Public identifier (pid) of a price

default_sector_to_be_booked
string

Public identifier (pid) of a sector

event
string

Public identifier (pid) of an event

introtext
string

Introtext displayed in distributor

single_shows_event
string

Public identifier (pid) of an event

Responses

Request samples

Content type
application/json
{
  • "slug": "string",
  • "introtext": "string",
  • "event": "string",
  • "single_shows_event": "string",
  • "default_price_to_be_booked": "string",
  • "default_sector_to_be_booked": "string"
}

Get the event of a distributor

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "timespan": { },
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "performer": "string",
  • "ticketdescription": "string",
  • "description": "string",
  • "delivery_info": "string",
  • "confirmation_extras_template": "string",
  • "will_call_label": "string",
  • "pay_before_dispatch": false,
  • "immediate_payment_only": false,
  • "send_reminders": true,
  • "delete_unpaid_bookings_mode": "never",
  • "allow_digital_dispatch": true,
  • "allow_deliveries": false,
  • "allow_will_call": false,
  • "issue_tickets": true,
  • "enable_passbook_tickets": true,
  • "require_customer_company": false,
  • "require_customer_address": true,
  • "require_customer_phone": false,
  • "prompt_customer_position": false,
  • "prompt_customer_department": false,
  • "prompt_customer_title": false,
  • "prompt_customer_birthday": false,
  • "allow_customer_notes": false,
  • "allow_invoice_address": false,
  • "allow_single_empty_seats": true,
  • "is_hidden": false,
  • "excluded_from_revenue_stats": false,
  • "tickets_per_booking": 1,
  • "tickets_in_listings": 1,
  • "refine_info": "string",
  • "reservation_info": "string",
  • "sales_point_info": "string",
  • "support_info": "string",
  • "payout_interval": "string",
  • "payout_interval_specification": "string",
  • "is_cancelled": true,
  • "will_be_postponed": true,
  • "cancellation_info": "string",
  • "invoice_address": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "notify_on_new_booking": false,
  • "notification_email": "string",
  • "fee_percentage": "string",
  • "fee_minimal_commission": "string",
  • "fee_free_ticket_commission": "string",
  • "fee_included_free_tickets_percentage": 100,
  • "fee_payment_base_commission": "string",
  • "fee_payment_percentage": "string",
  • "_links": {
    }
}

DistributorPriceToBeBooked

A DistributorPriceToBeBooked represents a pair of Prices used in Distributor interface to distribute tickets

Get a single PriceToBeBooked

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "pid": "string",
  • "distributor": {
    },
  • "price": {
    },
  • "price_to_be_booked": {
    },
  • "sector_to_be_booked": {
    },
  • "batch_id": "string",
  • "batch_order": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete a distributor

path Parameters
pid
required
string

Responses

Update a single distributor

path Parameters
pid
required
string
Request Body schema: application/json
slug
required
string

Slug to be used in url

default_price_to_be_booked
string

Public identifier (pid) of a price

default_sector_to_be_booked
string

Public identifier (pid) of a sector

event
string

Public identifier (pid) of an event

introtext
string

Introtext displayed in distributor

single_shows_event
string

Public identifier (pid) of an event

Responses

Request samples

Content type
application/json
{
  • "slug": "string",
  • "introtext": "string",
  • "event": "string",
  • "single_shows_event": "string",
  • "default_price_to_be_booked": "string",
  • "default_sector_to_be_booked": "string"
}

Get all prices to bee booked

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "pid": "string",
  • "distributor": {
    },
  • "price": {
    },
  • "price_to_be_booked": {
    },
  • "sector_to_be_booked": {
    },
  • "batch_id": "string",
  • "batch_order": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Create one or multiple distributors

Request Body schema: application/json
batch_id
string (optional batchId string (probably a UUID), helps identify a batch of entities processed in one request)
batch_order
integer (optional batchOrder int, to maintain the order of elements in a batch)
created_at
string or null <date-time>
object (Distributor2)
id
integer
pid
string
object (Price2)
object (Price2)
object (Sector2)
updated_at
string or null <date-time>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "pid": "string",
  • "distributor": {
    },
  • "price": { },
  • "price_to_be_booked": { },
  • "sector_to_be_booked": {
    },
  • "batch_id": "string",
  • "batch_order": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update one or multiple distributors

Request Body schema: application/json
slug
required
string

Slug to be used in url

default_price_to_be_booked
string

Public identifier (pid) of a price

default_sector_to_be_booked
string

Public identifier (pid) of a sector

event
string

Public identifier (pid) of an event

introtext
string

Introtext displayed in distributor

single_shows_event
string

Public identifier (pid) of an event

Responses

Request samples

Content type
application/json
{
  • "slug": "string",
  • "introtext": "string",
  • "event": "string",
  • "single_shows_event": "string",
  • "default_price_to_be_booked": "string",
  • "default_sector_to_be_booked": "string"
}

DividedPriceValue

A split of price values among shows

Get all divided price values

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "price": {
    },
  • "show": {
    },
  • "value": "string"
}

Create one or multiple divided price values

Request Body schema: application/json
price
required
string

Public identifier (pid) of a (multi-show) price

show
required
string

Public identifier (pid) of a (single) show

value
required
any

Multi-show Price value part for single Show

Responses

Request samples

Content type
application/json
{
  • "price": "string",
  • "show": "string",
  • "value": null
}

Get only head data of GET request

Responses

Get a single divided price value

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "price": {
    },
  • "show": {
    },
  • "value": "string"
}

Delete a divided price value

path Parameters
pid
required
string

Responses

Update a single divided price value

path Parameters
pid
required
string
Request Body schema: application/json
price
required
string

Public identifier (pid) of a (multi-show) price

show
required
string

Public identifier (pid) of a (single) show

value
required
any

Multi-show Price value part for single Show

Responses

Request samples

Content type
application/json
{
  • "price": "string",
  • "show": "string",
  • "value": null
}

Email

An Email, like what you receive in Gmail or Outlook. They can be sent for many reasons, but mostly for booking and payment confirmations.

Get all emails

Responses

Get only head data of GET request

Responses

Get a single email

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "receiver_email": "string",
  • "from_email": "string",
  • "from_name": "string",
  • "reply_to_email": "string",
  • "reply_to_name": "string",
  • "subject": "string",
  • "text": "string",
  • "text_moved_to_storage": false,
  • "html": "string",
  • "html_moved_to_storage": false,
  • "attachments": [ ],
  • "sent": "2019-08-24T14:15:22Z",
  • "failed": "2019-08-24T14:15:22Z",
  • "failed_type": "string",
  • "opened": "2019-08-24T14:15:22Z",
  • "bounced": "2019-08-24T14:15:22Z",
  • "bounced_type": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the booking of an email

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid_readable": "string",
  • "confirmation": true,
  • "delivery_method": "string",
  • "tickets_breakdown": { },
  • "pay_before_dispatch": true,
  • "is_dispatchable": true,
  • "urls": { },
  • "invoice_urls": { },
  • "denormalized_customer_pid": "string",
  • "denormalized_customer_fullname": "string",
  • "denormalized_customer_name_and_city": "string",
  • "denormalized_customer_country": "string",
  • "pid": 0,
  • "destination_country": "string",
  • "affiliate_id": "string",
  • "origin": "string",
  • "user_agent": "string",
  • "remote_address": "string",
  • "from_embed": true,
  • "source": "string",
  • "embed_session_id": "string",
  • "tos": true,
  • "digital_dispatch": true,
  • "delivery": true,
  • "will_call": true,
  • "deleted_by_customer": true,
  • "pos": true,
  • "internal_notes": "string",
  • "external_notes": "string",
  • "invoice_address": "string",
  • "checkbox_values": [
    ],
  • "payment_status_code": 0,
  • "first_full_payment": "2019-08-24T14:15:22Z",
  • "due_date": "2019-08-24T14:15:22Z",
  • "send_reminders": true,
  • "delete_if_unpaid": true,
  • "reminded_that_unpaid_at": "2019-08-24T14:15:22Z",
  • "next_reminder": "2019-08-24T14:15:22Z",
  • "refund_bank_account": "string",
  • "refund_bank_account_owner": "string",
  • "refund_bank_account_city": "string",
  • "approved": "2019-08-24T14:15:22Z",
  • "rejected": "2019-08-24T14:15:22Z",
  • "approval_requested": true,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": null,
  • "_links": {
    }
}

Get the ticket of an email

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "_links": {
    },
  • "discr": "ticket"
}

Get the invitation of an email

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "code": "string",
  • "expiration": "2019-08-24T14:15:22Z",
  • "personal": true,
  • "single_use": true,
  • "tickets_max_per_show": 0,
  • "tickets_max_per_event": 0,
  • "tickets_max_total": 0,
  • "tickets_max_per_booking": 0,
  • "max_different_shows": 0,
  • "rsvp": true,
  • "declined_at": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Send an email. Additional parameters may be required depending on the email type.

Responses

Event

An Event defines the basics of what can be booked in ticketing. It bookable Event contains at least one Show.

Get all events

Responses

Response samples

Content type
application/json
{
  • "timespan": { },
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "performer": "string",
  • "ticketdescription": "string",
  • "description": "string",
  • "delivery_info": "string",
  • "confirmation_extras_template": "string",
  • "will_call_label": "string",
  • "pay_before_dispatch": false,
  • "immediate_payment_only": false,
  • "send_reminders": true,
  • "delete_unpaid_bookings_mode": "never",
  • "allow_digital_dispatch": true,
  • "allow_deliveries": false,
  • "allow_will_call": false,
  • "issue_tickets": true,
  • "enable_passbook_tickets": true,
  • "require_customer_company": false,
  • "require_customer_address": true,
  • "require_customer_phone": false,
  • "prompt_customer_position": false,
  • "prompt_customer_department": false,
  • "prompt_customer_title": false,
  • "prompt_customer_birthday": false,
  • "allow_customer_notes": false,
  • "allow_invoice_address": false,
  • "allow_single_empty_seats": true,
  • "is_hidden": false,
  • "excluded_from_revenue_stats": false,
  • "tickets_per_booking": 1,
  • "tickets_in_listings": 1,
  • "refine_info": "string",
  • "reservation_info": "string",
  • "sales_point_info": "string",
  • "support_info": "string",
  • "payout_interval": "string",
  • "payout_interval_specification": "string",
  • "is_cancelled": true,
  • "will_be_postponed": true,
  • "cancellation_info": "string",
  • "invoice_address": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "notify_on_new_booking": false,
  • "notification_email": "string",
  • "fee_percentage": "string",
  • "fee_minimal_commission": "string",
  • "fee_free_ticket_commission": "string",
  • "fee_included_free_tickets_percentage": 100,
  • "fee_payment_base_commission": "string",
  • "fee_payment_percentage": "string",
  • "_links": {
    }
}

Create one or multiple events

Request Body schema: application/json
currency
required
string
Enum: "CHF" "EUR" "USD"

Public identifier (pid) of a currency

host
required
string

Public identifier (pid) of a host

name
required
string

Event name

allow_customer_notes
boolean

Flag whether the customer is allowed to add notes while booking

allow_deliveries
boolean

Flag whether dispatch method delivery is allowed

allow_digital_dispatch
boolean

Flag whether dispatch method digital is allowed

allow_invoice_address
boolean

Flag whether the customer is allowed to provide a separate invoice address

allow_single_empty_seats
boolean

Flag whether the customer is allowed to leave single empty seats in Embed Shop. Defaults to true

allow_will_call
boolean

Flag whether dispatch method will call is allowed

confirmation_extras_template
string

Additional text to appear in confirmation emails. May contain html and twig logic.

delete_unpaid_bookings_mode
string
Enum: "never" "always" "highUsage"

Mode to determine how unpaids bookings shoud be deleted

delivery_info
string

Additional delivery information displayed to the ticket buyer - use this if no tickets are issued.

description
string

An public event description. May contain basic HTML.

enable_passbook_tickets
boolean

Flag whether wallet tickets are enabled on this event.

excluded_from_revenue_stats
boolean

Flag whether an event should be excluded from Revenue Stats

image
string

Public identifier (pid) of an image

invoice_address
string

An optional invoice address used for payouts and invoices. If null, value from Host is used

is_cancelled
boolean

Flag whether the event has been cancelled.

issue_tickets
boolean

Flag whether tickets are issued for this event

notification_email
string

Email address to receive notifications about new bookings, if activated

notify_on_new_booking
boolean

Flag whether the host shall be notified on new bookings. Defaults to false.

operator_group
string

Public identifier (pid) of an operator group

passbook_image
string

Public identifier (pid) of an image

pay_before_dispatch
boolean

Flag whether bookings must be paid before tickets can be delivered

payout_interval
string
Enum: "monthly" "weekly" "day-of-month" "workday-of-month"

Payouts interval

payout_interval_specification
string

Payouts interval specification. Used only for day-of-month and workday-of-month intervals

performer
string

Name of performer (artist, band, etc.)

prompt_customer_birthday
boolean

Flag whether the customer's birthday should be asked for

prompt_customer_department
boolean

Flag whether the customer's department should be asked for

prompt_customer_position
boolean

Flag whether the customer's position should be asked for

ProtectionConceptDataType (object)

Protection concept

refine_info
string

Information to be displayed on refine screen

require_customer_address
boolean

Flag whether the customer's address should be mandatory. There might be setups when it's always required, even if this is set to false.

require_customer_phone
boolean

Flag whether the customer's phone should be mandatory

reservation_info
string

Information to be displayed on public reservation screens

sales_point_info
string

Information to be displayed for sales points

send_reminders
boolean

Flag whether payment reminders should be sent for this event, if applicable

tags
Array of strings

List of tags to be connected to entity

ticket_image
string

Public identifier (pid) of an image

tickets_in_listings
integer

Maximum allowed number of individually listed tickets in mails and invoice.

tickets_per_booking
integer

Maximum allowed number of tickets per booking.

will_call_label
string

Label for delivery method will call

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "currency": "CHF",
  • "host": "string",
  • "allow_customer_notes": true,
  • "allow_deliveries": true,
  • "allow_digital_dispatch": true,
  • "allow_invoice_address": true,
  • "excluded_from_revenue_stats": true,
  • "allow_will_call": true,
  • "allow_single_empty_seats": true,
  • "confirmation_extras_template": "string",
  • "delete_unpaid_bookings_mode": "never",
  • "delivery_info": "string",
  • "enable_passbook_tickets": true,
  • "image": "string",
  • "is_cancelled": true,
  • "issue_tickets": true,
  • "operator_group": "string",
  • "passbook_image": "string",
  • "pay_before_dispatch": true,
  • "performer": "string",
  • "prompt_customer_position": true,
  • "prompt_customer_department": true,
  • "prompt_customer_birthday": true,
  • "protection_concept": {
    },
  • "refine_info": "string",
  • "reservation_info": "string",
  • "require_customer_address": true,
  • "require_customer_phone": true,
  • "sales_point_info": "string",
  • "send_reminders": true,
  • "ticket_image": "string",
  • "tickets_per_booking": 0,
  • "tickets_in_listings": 0,
  • "will_call_label": "string",
  • "notification_email": "string",
  • "notify_on_new_booking": true,
  • "invoice_address": "string",
  • "payout_interval": "monthly",
  • "payout_interval_specification": "string",
  • "description": "string",
  • "tags": [
    ]
}

Get only head data of GET request

Responses

Update one or multiple events

Request Body schema: application/json
currency
required
string
Enum: "CHF" "EUR" "USD"

Public identifier (pid) of a currency

host
required
string

Public identifier (pid) of a host

name
required
string

Event name

allow_customer_notes
boolean

Flag whether the customer is allowed to add notes while booking

allow_deliveries
boolean

Flag whether dispatch method delivery is allowed

allow_digital_dispatch
boolean

Flag whether dispatch method digital is allowed

allow_invoice_address
boolean

Flag whether the customer is allowed to provide a separate invoice address

allow_single_empty_seats
boolean

Flag whether the customer is allowed to leave single empty seats in Embed Shop. Defaults to true

allow_will_call
boolean

Flag whether dispatch method will call is allowed

confirmation_extras_template
string

Additional text to appear in confirmation emails. May contain html and twig logic.

delete_unpaid_bookings_mode
string
Enum: "never" "always" "highUsage"

Mode to determine how unpaids bookings shoud be deleted

delivery_info
string

Additional delivery information displayed to the ticket buyer - use this if no tickets are issued.

description
string

An public event description. May contain basic HTML.

enable_passbook_tickets
boolean

Flag whether wallet tickets are enabled on this event.

excluded_from_revenue_stats
boolean

Flag whether an event should be excluded from Revenue Stats

image
string

Public identifier (pid) of an image

invoice_address
string

An optional invoice address used for payouts and invoices. If null, value from Host is used

is_cancelled
boolean

Flag whether the event has been cancelled.

issue_tickets
boolean

Flag whether tickets are issued for this event

notification_email
string

Email address to receive notifications about new bookings, if activated

notify_on_new_booking
boolean

Flag whether the host shall be notified on new bookings. Defaults to false.

operator_group
string

Public identifier (pid) of an operator group

passbook_image
string

Public identifier (pid) of an image

pay_before_dispatch
boolean

Flag whether bookings must be paid before tickets can be delivered

payout_interval
string
Enum: "monthly" "weekly" "day-of-month" "workday-of-month"

Payouts interval

payout_interval_specification
string

Payouts interval specification. Used only for day-of-month and workday-of-month intervals

performer
string

Name of performer (artist, band, etc.)

prompt_customer_birthday
boolean

Flag whether the customer's birthday should be asked for

prompt_customer_department
boolean

Flag whether the customer's department should be asked for

prompt_customer_position
boolean

Flag whether the customer's position should be asked for

ProtectionConceptDataType (object)

Protection concept

refine_info
string

Information to be displayed on refine screen

require_customer_address
boolean

Flag whether the customer's address should be mandatory. There might be setups when it's always required, even if this is set to false.

require_customer_phone
boolean

Flag whether the customer's phone should be mandatory

reservation_info
string

Information to be displayed on public reservation screens

sales_point_info
string

Information to be displayed for sales points

send_reminders
boolean

Flag whether payment reminders should be sent for this event, if applicable

tags
Array of strings

List of tags to be connected to entity

ticket_image
string

Public identifier (pid) of an image

tickets_in_listings
integer

Maximum allowed number of individually listed tickets in mails and invoice.

tickets_per_booking
integer

Maximum allowed number of tickets per booking.

will_call_label
string

Label for delivery method will call

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "currency": "CHF",
  • "host": "string",
  • "allow_customer_notes": true,
  • "allow_deliveries": true,
  • "allow_digital_dispatch": true,
  • "allow_invoice_address": true,
  • "excluded_from_revenue_stats": true,
  • "allow_will_call": true,
  • "allow_single_empty_seats": true,
  • "confirmation_extras_template": "string",
  • "delete_unpaid_bookings_mode": "never",
  • "delivery_info": "string",
  • "enable_passbook_tickets": true,
  • "image": "string",
  • "is_cancelled": true,
  • "issue_tickets": true,
  • "operator_group": "string",
  • "passbook_image": "string",
  • "pay_before_dispatch": true,
  • "performer": "string",
  • "prompt_customer_position": true,
  • "prompt_customer_department": true,
  • "prompt_customer_birthday": true,
  • "protection_concept": {
    },
  • "refine_info": "string",
  • "reservation_info": "string",
  • "require_customer_address": true,
  • "require_customer_phone": true,
  • "sales_point_info": "string",
  • "send_reminders": true,
  • "ticket_image": "string",
  • "tickets_per_booking": 0,
  • "tickets_in_listings": 0,
  • "will_call_label": "string",
  • "notification_email": "string",
  • "notify_on_new_booking": true,
  • "invoice_address": "string",
  • "payout_interval": "monthly",
  • "payout_interval_specification": "string",
  • "description": "string",
  • "tags": [
    ]
}

Get a single event

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "timespan": { },
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "performer": "string",
  • "ticketdescription": "string",
  • "description": "string",
  • "delivery_info": "string",
  • "confirmation_extras_template": "string",
  • "will_call_label": "string",
  • "pay_before_dispatch": false,
  • "immediate_payment_only": false,
  • "send_reminders": true,
  • "delete_unpaid_bookings_mode": "never",
  • "allow_digital_dispatch": true,
  • "allow_deliveries": false,
  • "allow_will_call": false,
  • "issue_tickets": true,
  • "enable_passbook_tickets": true,
  • "require_customer_company": false,
  • "require_customer_address": true,
  • "require_customer_phone": false,
  • "prompt_customer_position": false,
  • "prompt_customer_department": false,
  • "prompt_customer_title": false,
  • "prompt_customer_birthday": false,
  • "allow_customer_notes": false,
  • "allow_invoice_address": false,
  • "allow_single_empty_seats": true,
  • "is_hidden": false,
  • "excluded_from_revenue_stats": false,
  • "tickets_per_booking": 1,
  • "tickets_in_listings": 1,
  • "refine_info": "string",
  • "reservation_info": "string",
  • "sales_point_info": "string",
  • "support_info": "string",
  • "payout_interval": "string",
  • "payout_interval_specification": "string",
  • "is_cancelled": true,
  • "will_be_postponed": true,
  • "cancellation_info": "string",
  • "invoice_address": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "notify_on_new_booking": false,
  • "notification_email": "string",
  • "fee_percentage": "string",
  • "fee_minimal_commission": "string",
  • "fee_free_ticket_commission": "string",
  • "fee_included_free_tickets_percentage": 100,
  • "fee_payment_base_commission": "string",
  • "fee_payment_percentage": "string",
  • "_links": {
    }
}

Delete an event

path Parameters
pid
required
string

Responses

Update a single event

path Parameters
pid
required
string
Request Body schema: application/json
currency
required
string
Enum: "CHF" "EUR" "USD"

Public identifier (pid) of a currency

host
required
string

Public identifier (pid) of a host

name
required
string

Event name

allow_customer_notes
boolean

Flag whether the customer is allowed to add notes while booking

allow_deliveries
boolean

Flag whether dispatch method delivery is allowed

allow_digital_dispatch
boolean

Flag whether dispatch method digital is allowed

allow_invoice_address
boolean

Flag whether the customer is allowed to provide a separate invoice address

allow_single_empty_seats
boolean

Flag whether the customer is allowed to leave single empty seats in Embed Shop. Defaults to true

allow_will_call
boolean

Flag whether dispatch method will call is allowed

confirmation_extras_template
string

Additional text to appear in confirmation emails. May contain html and twig logic.

delete_unpaid_bookings_mode
string
Enum: "never" "always" "highUsage"

Mode to determine how unpaids bookings shoud be deleted

delivery_info
string

Additional delivery information displayed to the ticket buyer - use this if no tickets are issued.

description
string

An public event description. May contain basic HTML.

enable_passbook_tickets
boolean

Flag whether wallet tickets are enabled on this event.

excluded_from_revenue_stats
boolean

Flag whether an event should be excluded from Revenue Stats

image
string

Public identifier (pid) of an image

invoice_address
string

An optional invoice address used for payouts and invoices. If null, value from Host is used

is_cancelled
boolean

Flag whether the event has been cancelled.

issue_tickets
boolean

Flag whether tickets are issued for this event

notification_email
string

Email address to receive notifications about new bookings, if activated

notify_on_new_booking
boolean

Flag whether the host shall be notified on new bookings. Defaults to false.

operator_group
string

Public identifier (pid) of an operator group

passbook_image
string

Public identifier (pid) of an image

pay_before_dispatch
boolean

Flag whether bookings must be paid before tickets can be delivered

payout_interval
string
Enum: "monthly" "weekly" "day-of-month" "workday-of-month"

Payouts interval

payout_interval_specification
string

Payouts interval specification. Used only for day-of-month and workday-of-month intervals

performer
string

Name of performer (artist, band, etc.)

prompt_customer_birthday
boolean

Flag whether the customer's birthday should be asked for

prompt_customer_department
boolean

Flag whether the customer's department should be asked for

prompt_customer_position
boolean

Flag whether the customer's position should be asked for

ProtectionConceptDataType (object)

Protection concept

refine_info
string

Information to be displayed on refine screen

require_customer_address
boolean

Flag whether the customer's address should be mandatory. There might be setups when it's always required, even if this is set to false.

require_customer_phone
boolean

Flag whether the customer's phone should be mandatory

reservation_info
string

Information to be displayed on public reservation screens

sales_point_info
string

Information to be displayed for sales points

send_reminders
boolean

Flag whether payment reminders should be sent for this event, if applicable

tags
Array of strings

List of tags to be connected to entity

ticket_image
string

Public identifier (pid) of an image

tickets_in_listings
integer

Maximum allowed number of individually listed tickets in mails and invoice.

tickets_per_booking
integer

Maximum allowed number of tickets per booking.

will_call_label
string

Label for delivery method will call

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "currency": "CHF",
  • "host": "string",
  • "allow_customer_notes": true,
  • "allow_deliveries": true,
  • "allow_digital_dispatch": true,
  • "allow_invoice_address": true,
  • "excluded_from_revenue_stats": true,
  • "allow_will_call": true,
  • "allow_single_empty_seats": true,
  • "confirmation_extras_template": "string",
  • "delete_unpaid_bookings_mode": "never",
  • "delivery_info": "string",
  • "enable_passbook_tickets": true,
  • "image": "string",
  • "is_cancelled": true,
  • "issue_tickets": true,
  • "operator_group": "string",
  • "passbook_image": "string",
  • "pay_before_dispatch": true,
  • "performer": "string",
  • "prompt_customer_position": true,
  • "prompt_customer_department": true,
  • "prompt_customer_birthday": true,
  • "protection_concept": {
    },
  • "refine_info": "string",
  • "reservation_info": "string",
  • "require_customer_address": true,
  • "require_customer_phone": true,
  • "sales_point_info": "string",
  • "send_reminders": true,
  • "ticket_image": "string",
  • "tickets_per_booking": 0,
  • "tickets_in_listings": 0,
  • "will_call_label": "string",
  • "notification_email": "string",
  • "notify_on_new_booking": true,
  • "invoice_address": "string",
  • "payout_interval": "monthly",
  • "payout_interval_specification": "string",
  • "description": "string",
  • "tags": [
    ]
}

Get the image of an event

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "description": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the ticket image of an event

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "description": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the host of an event

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "care_of": "string",
  • "address1": "string",
  • "address2": "string",
  • "zip": "string",
  • "city": "string",
  • "country": "string",
  • "will_call_label": "string",
  • "will_call_instructions": "string",
  • "send_reminders": true,
  • "delete_unpaid_bookings": true,
  • "public_email": "string",
  • "public_email_sender_name": "string",
  • "public_phone": "string",
  • "website": "string",
  • "bank_account": "string",
  • "bank_account_owner": "string",
  • "bank_account_city": "string",
  • "invoice_address": "string",
  • "vat_number": "string",
  • "thank_you_close": "string",
  • "complimentary_close": "string",
  • "contact_text": "string",
  • "confirmation_extras_template": "string",
  • "tos_title": "string",
  • "tos": "string",
  • "saferpay_terminal_id": "string",
  • "shared_secret": "string",
  • "prompt_newsletter": false,
  • "prompt_acquisition_channel": false,
  • "execute_deliveries": true,
  • "check_newsletter_by_default": false,
  • "address_right": false,
  • "enable_crm": false,
  • "enable_staff": false,
  • "enable_invitations": false,
  • "enable_seat_category_changes": false,
  • "enable_remaining_voucher_value_handling": false,
  • "enable_donations": false,
  • "execute_payouts": true,
  • "cancellation_policy": "strict",
  • "enable_salutation": true,
  • "use_security_code": true,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "allow_user_to_delete_booking": true,
  • "allow_embed_session_id": true,
  • "allow_single_empty_seats": true,
  • "setup_information": "string",
  • "support_info": "string",
  • "notify_on_new_booking": false,
  • "notification_email": "string",
  • "fee_percentage": "string",
  • "fee_minimal_commission": "string",
  • "fee_free_ticket_commission": "string",
  • "fee_included_free_tickets_percentage": 100,
  • "fee_payment_base_commission": "string",
  • "fee_payment_percentage": "string",
  • "_links": {
    }
}

Get the protection concept of an event

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "pid": "string",
  • "facemask_required": false,
  • "health_certificate_mode": "3G",
  • "batch_id": "string",
  • "batch_order": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the currency of an event

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "round_to_cents": 0,
  • "_links": {
    }
}

Get the options of an event

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "price_excluding_vat": 0,
  • "price_including_vat": 0,
  • "vat_amount": 0,
  • "vat_rate": 0,
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "description": "string",
  • "order": 0,
  • "limitation": 0,
  • "margin": 0,
  • "items_per_booking": 1,
  • "requires_code": false,
  • "option_variables": [
    ],
  • "access_by": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "custom_fee_percentage": "string",
  • "price": "string",
  • "_links": {
    }
}

Get the ticket option groups of an event

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "description": "string",
  • "placeholder": "string",
  • "order": 0,
  • "searchable": false,
  • "required": false,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "editable_by_buyer": true,
  • "_links": {
    }
}

Get the prices of an event

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "_links": {
    },
  • "discr": "price"
}

Get the shows of an event

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "access_role": "string",
  • "beacon_data": { },
  • "translations": { },
  • "pid": "string",
  • "performer": "string",
  • "ticketdescription": "string",
  • "description": "string",
  • "subtitle": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "end_check_in": "2019-08-24T14:15:22Z",
  • "start_public_sales": "2019-08-24T14:15:22Z",
  • "end_sales": "2019-08-24T14:15:22Z",
  • "end_sales_alternative": "string",
  • "dooropening": "2019-08-24T14:15:22Z",
  • "specific_capacity": 1,
  • "allow_sales_while_current": false,
  • "allow_single_empty_seats": true,
  • "always_display_start_time": false,
  • "reservation_info": "string",
  • "request_ratings": false,
  • "order": 0,
  • "is_cancelled": true,
  • "will_be_postponed": true,
  • "is_online_show": true,
  • "online_show": {
    },
  • "tickets_per_booking": 1,
  • "enable_passbook_tickets": true,
  • "access_by": "string",
  • "ratings_requested": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the coupon groups of a event

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": null,
  • "name": "string",
  • "code_format": "string",
  • "value_absolute": "string",
  • "value_percent": 1,
  • "value_max": "string",
  • "value_one_ticket": true,
  • "apply_to_tickets_only": false,
  • "allow_redemptions": 1,
  • "maximal_ticket_value": "string",
  • "minimal_booking_value": "string",
  • "max_coupons_per_booking": 0,
  • "expiration": "2019-08-24T14:15:22Z",
  • "available_in_shop": false,
  • "paid": false,
  • "for_individual_values": false,
  • "order": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the bookings of an event.

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid_readable": "string",
  • "confirmation": true,
  • "delivery_method": "string",
  • "tickets_breakdown": { },
  • "pay_before_dispatch": true,
  • "is_dispatchable": true,
  • "urls": { },
  • "invoice_urls": { },
  • "denormalized_customer_pid": "string",
  • "denormalized_customer_fullname": "string",
  • "denormalized_customer_name_and_city": "string",
  • "denormalized_customer_country": "string",
  • "pid": 0,
  • "destination_country": "string",
  • "affiliate_id": "string",
  • "origin": "string",
  • "user_agent": "string",
  • "remote_address": "string",
  • "from_embed": true,
  • "source": "string",
  • "embed_session_id": "string",
  • "tos": true,
  • "digital_dispatch": true,
  • "delivery": true,
  • "will_call": true,
  • "deleted_by_customer": true,
  • "pos": true,
  • "internal_notes": "string",
  • "external_notes": "string",
  • "invoice_address": "string",
  • "checkbox_values": [
    ],
  • "payment_status_code": 0,
  • "first_full_payment": "2019-08-24T14:15:22Z",
  • "due_date": "2019-08-24T14:15:22Z",
  • "send_reminders": true,
  • "delete_if_unpaid": true,
  • "reminded_that_unpaid_at": "2019-08-24T14:15:22Z",
  • "next_reminder": "2019-08-24T14:15:22Z",
  • "refund_bank_account": "string",
  • "refund_bank_account_owner": "string",
  • "refund_bank_account_city": "string",
  • "approved": "2019-08-24T14:15:22Z",
  • "rejected": "2019-08-24T14:15:22Z",
  • "approval_requested": true,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": null,
  • "_links": {
    }
}

Get the annotations of an event

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "access_role": "string",
  • "translations": { },
  • "pid": "string",
  • "target": "booking",
  • "identifier": "string",
  • "name": "string",
  • "description": "string",
  • "placeholder": "string",
  • "order": 0,
  • "required": false,
  • "max_chars": 0,
  • "regex": "string",
  • "show_type": "all",
  • "access_by": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "editable_by_buyer": false,
  • "_links": {
    }
}

Get the excel lists of an event

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "name": "string",
  • "iterator": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the invitations of an event

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "code": "string",
  • "expiration": "2019-08-24T14:15:22Z",
  • "personal": true,
  • "single_use": true,
  • "tickets_max_per_show": 0,
  • "tickets_max_per_event": 0,
  • "tickets_max_total": 0,
  • "tickets_max_per_booking": 0,
  • "max_different_shows": 0,
  • "rsvp": true,
  • "declined_at": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the invitation setups of an event

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "name": "string",
  • "shop_url": "string",
  • "code_prefix": "string",
  • "_links": {
    }
}

Get the seats of a row

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "access_role": "string",
  • "translations": { },
  • "pid": "string",
  • "label": "string",
  • "chart_seat_id": "string",
  • "price_category": {
    },
  • "seat_string_template": "string",
  • "capacity_count": 0,
  • "access_by": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

ExcelList

An ExcelList defines a custom list that can be downloaded per Event or Show. Similar, but more flexible and powerful, are Exports.

Get all excel lists

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "name": "string",
  • "iterator": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Create one or multiple excel lists

Request Body schema: application/json
iterator
required
string
Enum: "bookings" "tickets"

Iterator entity type

name
required
string

Name of the excel list

event
string

Public identifier (pid) of an event

host
string

Public identifier (pid) of a host

show
string

Public identifier (pid) of a show

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "iterator": "bookings",
  • "event": "string",
  • "host": "string",
  • "show": "string"
}

Get only head data of GET request

Responses

Update one or multiple excel lists

Request Body schema: application/json
iterator
required
string
Enum: "bookings" "tickets"

Iterator entity type

name
required
string

Name of the excel list

event
string

Public identifier (pid) of an event

host
string

Public identifier (pid) of a host

show
string

Public identifier (pid) of a show

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "iterator": "bookings",
  • "event": "string",
  • "host": "string",
  • "show": "string"
}

Get a single excel list

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "name": "string",
  • "iterator": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Delete an excel list

path Parameters
pid
required
string

Responses

Update a single excel list

path Parameters
pid
required
string
Request Body schema: application/json
iterator
required
string
Enum: "bookings" "tickets"

Iterator entity type

name
required
string

Name of the excel list

event
string

Public identifier (pid) of an event

host
string

Public identifier (pid) of a host

show
string

Public identifier (pid) of a show

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "iterator": "bookings",
  • "event": "string",
  • "host": "string",
  • "show": "string"
}

Get the host of an excel list

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "care_of": "string",
  • "address1": "string",
  • "address2": "string",
  • "zip": "string",
  • "city": "string",
  • "country": "string",
  • "will_call_label": "string",
  • "will_call_instructions": "string",
  • "send_reminders": true,
  • "delete_unpaid_bookings": true,
  • "public_email": "string",
  • "public_email_sender_name": "string",
  • "public_phone": "string",
  • "website": "string",
  • "bank_account": "string",
  • "bank_account_owner": "string",
  • "bank_account_city": "string",
  • "invoice_address": "string",
  • "vat_number": "string",
  • "thank_you_close": "string",
  • "complimentary_close": "string",
  • "contact_text": "string",
  • "confirmation_extras_template": "string",
  • "tos_title": "string",
  • "tos": "string",
  • "saferpay_terminal_id": "string",
  • "shared_secret": "string",
  • "prompt_newsletter": false,
  • "prompt_acquisition_channel": false,
  • "execute_deliveries": true,
  • "check_newsletter_by_default": false,
  • "address_right": false,
  • "enable_crm": false,
  • "enable_staff": false,
  • "enable_invitations": false,
  • "enable_seat_category_changes": false,
  • "enable_remaining_voucher_value_handling": false,
  • "enable_donations": false,
  • "execute_payouts": true,
  • "cancellation_policy": "strict",
  • "enable_salutation": true,
  • "use_security_code": true,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "allow_user_to_delete_booking": true,
  • "allow_embed_session_id": true,
  • "allow_single_empty_seats": true,
  • "setup_information": "string",
  • "support_info": "string",
  • "notify_on_new_booking": false,
  • "notification_email": "string",
  • "fee_percentage": "string",
  • "fee_minimal_commission": "string",
  • "fee_free_ticket_commission": "string",
  • "fee_included_free_tickets_percentage": 100,
  • "fee_payment_base_commission": "string",
  • "fee_payment_percentage": "string",
  • "_links": {
    }
}

Get the host of an excel list

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "care_of": "string",
  • "address1": "string",
  • "address2": "string",
  • "zip": "string",
  • "city": "string",
  • "country": "string",
  • "will_call_label": "string",
  • "will_call_instructions": "string",
  • "send_reminders": true,
  • "delete_unpaid_bookings": true,
  • "public_email": "string",
  • "public_email_sender_name": "string",
  • "public_phone": "string",
  • "website": "string",
  • "bank_account": "string",
  • "bank_account_owner": "string",
  • "bank_account_city": "string",
  • "invoice_address": "string",
  • "vat_number": "string",
  • "thank_you_close": "string",
  • "complimentary_close": "string",
  • "contact_text": "string",
  • "confirmation_extras_template": "string",
  • "tos_title": "string",
  • "tos": "string",
  • "saferpay_terminal_id": "string",
  • "shared_secret": "string",
  • "prompt_newsletter": false,
  • "prompt_acquisition_channel": false,
  • "execute_deliveries": true,
  • "check_newsletter_by_default": false,
  • "address_right": false,
  • "enable_crm": false,
  • "enable_staff": false,
  • "enable_invitations": false,
  • "enable_seat_category_changes": false,
  • "enable_remaining_voucher_value_handling": false,
  • "enable_donations": false,
  • "execute_payouts": true,
  • "cancellation_policy": "strict",
  • "enable_salutation": true,
  • "use_security_code": true,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "allow_user_to_delete_booking": true,
  • "allow_embed_session_id": true,
  • "allow_single_empty_seats": true,
  • "setup_information": "string",
  • "support_info": "string",
  • "notify_on_new_booking": false,
  • "notification_email": "string",
  • "fee_percentage": "string",
  • "fee_minimal_commission": "string",
  • "fee_free_ticket_commission": "string",
  • "fee_included_free_tickets_percentage": 100,
  • "fee_payment_base_commission": "string",
  • "fee_payment_percentage": "string",
  • "_links": {
    }
}

Get the event of an excel list

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "timespan": { },
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "performer": "string",
  • "ticketdescription": "string",
  • "description": "string",
  • "delivery_info": "string",
  • "confirmation_extras_template": "string",
  • "will_call_label": "string",
  • "pay_before_dispatch": false,
  • "immediate_payment_only": false,
  • "send_reminders": true,
  • "delete_unpaid_bookings_mode": "never",
  • "allow_digital_dispatch": true,
  • "allow_deliveries": false,
  • "allow_will_call": false,
  • "issue_tickets": true,
  • "enable_passbook_tickets": true,
  • "require_customer_company": false,
  • "require_customer_address": true,
  • "require_customer_phone": false,
  • "prompt_customer_position": false,
  • "prompt_customer_department": false,
  • "prompt_customer_title": false,
  • "prompt_customer_birthday": false,
  • "allow_customer_notes": false,
  • "allow_invoice_address": false,
  • "allow_single_empty_seats": true,
  • "is_hidden": false,
  • "excluded_from_revenue_stats": false,
  • "tickets_per_booking": 1,
  • "tickets_in_listings": 1,
  • "refine_info": "string",
  • "reservation_info": "string",
  • "sales_point_info": "string",
  • "support_info": "string",
  • "payout_interval": "string",
  • "payout_interval_specification": "string",
  • "is_cancelled": true,
  • "will_be_postponed": true,
  • "cancellation_info": "string",
  • "invoice_address": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "notify_on_new_booking": false,
  • "notification_email": "string",
  • "fee_percentage": "string",
  • "fee_minimal_commission": "string",
  • "fee_free_ticket_commission": "string",
  • "fee_included_free_tickets_percentage": 100,
  • "fee_payment_base_commission": "string",
  • "fee_payment_percentage": "string",
  • "_links": {
    }
}

Get the show of an excel list

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "access_role": "string",
  • "beacon_data": { },
  • "translations": { },
  • "pid": "string",
  • "performer": "string",
  • "ticketdescription": "string",
  • "description": "string",
  • "subtitle": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "end_check_in": "2019-08-24T14:15:22Z",
  • "start_public_sales": "2019-08-24T14:15:22Z",
  • "end_sales": "2019-08-24T14:15:22Z",
  • "end_sales_alternative": "string",
  • "dooropening": "2019-08-24T14:15:22Z",
  • "specific_capacity": 1,
  • "allow_sales_while_current": false,
  • "allow_single_empty_seats": true,
  • "always_display_start_time": false,
  • "reservation_info": "string",
  • "request_ratings": false,
  • "order": 0,
  • "is_cancelled": true,
  • "will_be_postponed": true,
  • "is_online_show": true,
  • "online_show": {
    },
  • "tickets_per_booking": 1,
  • "enable_passbook_tickets": true,
  • "access_by": "string",
  • "ratings_requested": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the excel list columns of an excel list

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "field": "string",
  • "order": 0,
  • "filter": false,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

ExcelListColumn

An ExcelListColumn defines a single column within an ExcelList.

Get all excel lists

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "field": "string",
  • "order": 0,
  • "filter": false,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Create one or multiple excel columns

Request Body schema: application/json
excel_list
required
string

Public identifier (pid) of an excel list

field
required
string

Field identifier

annotation
string

Public identifier (pid) of an annotation

filter
boolean

Flag whether the list should be filtered by this column

option
string

Public identifier (pid) of an option

order
integer

Order index (lowest to highest)

ticket_option
string

Public identifier (pid) of a ticket option

ticket_option_group
string

Public identifier (pid) of a ticket option group

Responses

Request samples

Content type
application/json
{
  • "excel_list": "string",
  • "field": "string",
  • "annotation": "string",
  • "filter": true,
  • "option": "string",
  • "order": 0,
  • "ticket_option": "string",
  • "ticket_option_group": "string"
}

Get only head data of GET request

Responses

Update one or multiple excel columns

Request Body schema: application/json
excel_list
required
string

Public identifier (pid) of an excel list

field
required
string

Field identifier

annotation
string

Public identifier (pid) of an annotation

filter
boolean

Flag whether the list should be filtered by this column

option
string

Public identifier (pid) of an option

order
integer

Order index (lowest to highest)

ticket_option
string

Public identifier (pid) of a ticket option

ticket_option_group
string

Public identifier (pid) of a ticket option group

Responses

Request samples

Content type
application/json
{
  • "excel_list": "string",
  • "field": "string",
  • "annotation": "string",
  • "filter": true,
  • "option": "string",
  • "order": 0,
  • "ticket_option": "string",
  • "ticket_option_group": "string"
}

Get a single excel list column

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "field": "string",
  • "order": 0,
  • "filter": false,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Delete an excel list column

path Parameters
pid
required
string

Responses

Update a single excel list column

path Parameters
pid
required
string
Request Body schema: application/json
excel_list
required
string

Public identifier (pid) of an excel list

field
required
string

Field identifier

annotation
string

Public identifier (pid) of an annotation

filter
boolean

Flag whether the list should be filtered by this column

option
string

Public identifier (pid) of an option

order
integer

Order index (lowest to highest)

ticket_option
string

Public identifier (pid) of a ticket option

ticket_option_group
string

Public identifier (pid) of a ticket option group

Responses

Request samples

Content type
application/json
{
  • "excel_list": "string",
  • "field": "string",
  • "annotation": "string",
  • "filter": true,
  • "option": "string",
  • "order": 0,
  • "ticket_option": "string",
  • "ticket_option_group": "string"
}

Get the excel list of an excel list column

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "name": "string",
  • "iterator": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Export

An Export represents a individualized excel report for a specific Host, Event or Show. Its actual content must be configured by Ticketpark support as it is able to dynamically fetch from all available data in the database.

Get all exports

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "content_level": "crm",
  • "_links": {
    }
}

Create one or multiple exports

Request Body schema: application/json
content_level
required
string
Enum: "crm" "ticketing" "event" "show"

The content level where the export will be displayed

name
required
string

Export name

event
string

Public identifier (pid) of an event

host
string

Public identifier (pid) of a host

show
string

Public identifier (pid) of a show

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "content_level": "crm",
  • "host": "string",
  • "event": "string",
  • "show": "string"
}

Get only head data of GET request

Responses

Update one or multiple exports

Request Body schema: application/json
content_level
required
string
Enum: "crm" "ticketing" "event" "show"

The content level where the export will be displayed

name
required
string

Export name

event
string

Public identifier (pid) of an event

host
string

Public identifier (pid) of a host

show
string

Public identifier (pid) of a show

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "content_level": "crm",
  • "host": "string",
  • "event": "string",
  • "show": "string"
}

Get a single export

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "content_level": "crm",
  • "_links": {
    }
}

Delete an export

path Parameters
pid
required
string

Responses

Update a single export

path Parameters
pid
required
string
Request Body schema: application/json
content_level
required
string
Enum: "crm" "ticketing" "event" "show"

The content level where the export will be displayed

name
required
string

Export name

event
string

Public identifier (pid) of an event

host
string

Public identifier (pid) of a host

show
string

Public identifier (pid) of a show

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "content_level": "crm",
  • "host": "string",
  • "event": "string",
  • "show": "string"
}

File

A File is a document or an image. Most often it is used for images to be used within Events and their tickets and other documents.

Get a single file

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "description": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Update a single file

path Parameters
pid
required
string
Request Body schema: application/json
file
required
any

File contents

host
required
string

Public identifier (pid) of a host

description
string

Description

Responses

Request samples

Content type
application/json
{
  • "file": null,
  • "host": "string",
  • "description": "string"
}

Upload one or multiple files

Request Body schema: application/json
file
required
any

File contents

host
required
string

Public identifier (pid) of a host

description
string

Description

Responses

Request samples

Content type
application/json
{
  • "file": null,
  • "host": "string",
  • "description": "string"
}

Update one or multiple Files

Request Body schema: application/json
file
required
any

File contents

host
required
string

Public identifier (pid) of a host

description
string

Description

Responses

Request samples

Content type
application/json
{
  • "file": null,
  • "host": "string",
  • "description": "string"
}

FormFieldDefinition

Get all form field definitions

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "key": "string",
  • "label": "string",
  • "explanation": "string",
  • "required": true,
  • "max_chars": 0,
  • "regex": "string",
  • "max_number": 0,
  • "max_date": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Create one or multiple form field definitions

Request Body schema: application/json
key
required
string

Unique key of field

label
required
string

Label for field

options
required
Array of strings

Form field options (in JSON format)

set
required
string

Public identifier (pid) of a set

explanation
string

An explanation text displayed near the form field

max_chars
integer

Max length constraint for validation

max_date
string <date>

Max date constraint for validation

max_number
integer

Max number constraint for validation

order
integer

Order for field in form

person_group_field_definition
string

Public identifier (pid) of a person group field fefinition

property
string

A Person property the content refer to

regex
string

Regex constraint for validation

required
boolean

Required constraint for validation

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "label": "string",
  • "set": "string",
  • "explanation": "string",
  • "max_chars": 0,
  • "max_date": "2019-08-24",
  • "max_number": 0,
  • "order": 0,
  • "person_group_field_definition": "string",
  • "property": "string",
  • "regex": "string",
  • "required": true,
  • "options": [
    ]
}

Get only head data of GET request

Responses

Update one or multiple form field definitions

Request Body schema: application/json
key
required
string

Unique key of field

label
required
string

Label for field

options
required
Array of strings

Form field options (in JSON format)

set
required
string

Public identifier (pid) of a set

explanation
string

An explanation text displayed near the form field

max_chars
integer

Max length constraint for validation

max_date
string <date>

Max date constraint for validation

max_number
integer

Max number constraint for validation

order
integer

Order for field in form

person_group_field_definition
string

Public identifier (pid) of a person group field fefinition

property
string

A Person property the content refer to

regex
string

Regex constraint for validation

required
boolean

Required constraint for validation

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "label": "string",
  • "set": "string",
  • "explanation": "string",
  • "max_chars": 0,
  • "max_date": "2019-08-24",
  • "max_number": 0,
  • "order": 0,
  • "person_group_field_definition": "string",
  • "property": "string",
  • "regex": "string",
  • "required": true,
  • "options": [
    ]
}

Get a single form field definition

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "key": "string",
  • "label": "string",
  • "explanation": "string",
  • "required": true,
  • "max_chars": 0,
  • "regex": "string",
  • "max_number": 0,
  • "max_date": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Delete a form field definition

path Parameters
pid
required
string

Responses

Update a single form field definition

path Parameters
pid
required
string
Request Body schema: application/json
key
required
string

Unique key of field

label
required
string

Label for field

options
required
Array of strings

Form field options (in JSON format)

set
required
string

Public identifier (pid) of a set

explanation
string

An explanation text displayed near the form field

max_chars
integer

Max length constraint for validation

max_date
string <date>

Max date constraint for validation

max_number
integer

Max number constraint for validation

order
integer

Order for field in form

person_group_field_definition
string

Public identifier (pid) of a person group field fefinition

property
string

A Person property the content refer to

regex
string

Regex constraint for validation

required
boolean

Required constraint for validation

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "label": "string",
  • "set": "string",
  • "explanation": "string",
  • "max_chars": 0,
  • "max_date": "2019-08-24",
  • "max_number": 0,
  • "order": 0,
  • "person_group_field_definition": "string",
  • "property": "string",
  • "regex": "string",
  • "required": true,
  • "options": [
    ]
}

GlobalOptionItem

An GlobalOptionItem represents a single booked item of an GlobalOption.

Get all option items

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "booking": {
    },
  • "type": "string",
  • "price": "string"
}

Create one or multiple option items

Request Body schema: application/json
booking
required
string

Public identifier (pid) of booking

payment
required
string

Public identifier (pid) of (voucher) Payment

price
required
any

Price

type
required
string
Enum: "donation" "voucher"

Type of global option

vat
string

Public identifier (pid) of vat

Responses

Request samples

Content type
application/json
{
  • "booking": "string",
  • "type": "donation",
  • "price": null,
  • "vat": "string",
  • "payment": "string"
}

Get only head data of GET request

Responses

Update one or multiple option items

Request Body schema: application/json
booking
required
string

Public identifier (pid) of booking

payment
required
string

Public identifier (pid) of (voucher) Payment

price
required
any

Price

type
required
string
Enum: "donation" "voucher"

Type of global option

vat
string

Public identifier (pid) of vat

Responses

Request samples

Content type
application/json
{
  • "booking": "string",
  • "type": "donation",
  • "price": null,
  • "vat": "string",
  • "payment": "string"
}

Get a single option item

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "booking": {
    },
  • "type": "string",
  • "price": "string"
}

Delete an option item

path Parameters
pid
required
string

Responses

Update a single option item

path Parameters
pid
required
string
Request Body schema: application/json
booking
required
string

Public identifier (pid) of booking

payment
required
string

Public identifier (pid) of (voucher) Payment

price
required
any

Price

type
required
string
Enum: "donation" "voucher"

Type of global option

vat
string

Public identifier (pid) of vat

Responses

Request samples

Content type
application/json
{
  • "booking": "string",
  • "type": "donation",
  • "price": null,
  • "vat": "string",
  • "payment": "string"
}

Get the booking of an option item

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid_readable": "string",
  • "confirmation": true,
  • "delivery_method": "string",
  • "tickets_breakdown": { },
  • "pay_before_dispatch": true,
  • "is_dispatchable": true,
  • "urls": { },
  • "invoice_urls": { },
  • "denormalized_customer_pid": "string",
  • "denormalized_customer_fullname": "string",
  • "denormalized_customer_name_and_city": "string",
  • "denormalized_customer_country": "string",
  • "pid": 0,
  • "destination_country": "string",
  • "affiliate_id": "string",
  • "origin": "string",
  • "user_agent": "string",
  • "remote_address": "string",
  • "from_embed": true,
  • "source": "string",
  • "embed_session_id": "string",
  • "tos": true,
  • "digital_dispatch": true,
  • "delivery": true,
  • "will_call": true,
  • "deleted_by_customer": true,
  • "pos": true,
  • "internal_notes": "string",
  • "external_notes": "string",
  • "invoice_address": "string",
  • "checkbox_values": [
    ],
  • "payment_status_code": 0,
  • "first_full_payment": "2019-08-24T14:15:22Z",
  • "due_date": "2019-08-24T14:15:22Z",
  • "send_reminders": true,
  • "delete_if_unpaid": true,
  • "reminded_that_unpaid_at": "2019-08-24T14:15:22Z",
  • "next_reminder": "2019-08-24T14:15:22Z",
  • "refund_bank_account": "string",
  • "refund_bank_account_owner": "string",
  • "refund_bank_account_city": "string",
  • "approved": "2019-08-24T14:15:22Z",
  • "rejected": "2019-08-24T14:15:22Z",
  • "approval_requested": true,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": null,
  • "_links": {
    }
}

Get the option of an option item

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
null

Group

A Group represents a user group. They are usually managed automatically. Not to be confused with PersonGroup.

Get all groups

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z"
}

Create one or multiple groups

Request Body schema: application/json
name
required
string

Group name

box_offices
string

List of public identifiers (pid) of boxoffices

operator_events
string

List of public identifiers (pid) of events

operator_host
string

Public identifier (pid) of host

operator_shows
string

List of public identifiers (pid) of shows

sales_points
string

List of public identifiers (pid) of salespoints

users
string

List of public identifiers (pid) of users

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "operator_events": "string",
  • "operator_host": "string",
  • "operator_shows": "string",
  • "box_offices": "string",
  • "sales_points": "string",
  • "users": "string"
}

Get only head data of GET request

Responses

Update one or multiple groups

Request Body schema: application/json
name
required
string

Group name

box_offices
string

List of public identifiers (pid) of boxoffices

operator_events
string

List of public identifiers (pid) of events

operator_host
string

Public identifier (pid) of host

operator_shows
string

List of public identifiers (pid) of shows

sales_points
string

List of public identifiers (pid) of salespoints

users
string

List of public identifiers (pid) of users

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "operator_events": "string",
  • "operator_host": "string",
  • "operator_shows": "string",
  • "box_offices": "string",
  • "sales_points": "string",
  • "users": "string"
}

Get a single group

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z"
}

Delete a group

path Parameters
pid
required
string

Responses

Update a group

path Parameters
pid
required
string
Request Body schema: application/json
name
required
string

Group name

box_offices
string

List of public identifiers (pid) of boxoffices

operator_events
string

List of public identifiers (pid) of events

operator_host
string

Public identifier (pid) of host

operator_shows
string

List of public identifiers (pid) of shows

sales_points
string

List of public identifiers (pid) of salespoints

users
string

List of public identifiers (pid) of users

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "operator_events": "string",
  • "operator_host": "string",
  • "operator_shows": "string",
  • "box_offices": "string",
  • "sales_points": "string",
  • "users": "string"
}

Get the users in a group

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "person": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z"
}

Get the operator host of a user group

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "care_of": "string",
  • "address1": "string",
  • "address2": "string",
  • "zip": "string",
  • "city": "string",
  • "country": "string",
  • "will_call_label": "string",
  • "will_call_instructions": "string",
  • "send_reminders": true,
  • "delete_unpaid_bookings": true,
  • "public_email": "string",
  • "public_email_sender_name": "string",
  • "public_phone": "string",
  • "website": "string",
  • "bank_account": "string",
  • "bank_account_owner": "string",
  • "bank_account_city": "string",
  • "invoice_address": "string",
  • "vat_number": "string",
  • "thank_you_close": "string",
  • "complimentary_close": "string",
  • "contact_text": "string",
  • "confirmation_extras_template": "string",
  • "tos_title": "string",
  • "tos": "string",
  • "saferpay_terminal_id": "string",
  • "shared_secret": "string",
  • "prompt_newsletter": false,
  • "prompt_acquisition_channel": false,
  • "execute_deliveries": true,
  • "check_newsletter_by_default": false,
  • "address_right": false,
  • "enable_crm": false,
  • "enable_staff": false,
  • "enable_invitations": false,
  • "enable_seat_category_changes": false,
  • "enable_remaining_voucher_value_handling": false,
  • "enable_donations": false,
  • "execute_payouts": true,
  • "cancellation_policy": "strict",
  • "enable_salutation": true,
  • "use_security_code": true,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "allow_user_to_delete_booking": true,
  • "allow_embed_session_id": true,
  • "allow_single_empty_seats": true,
  • "setup_information": "string",
  • "support_info": "string",
  • "notify_on_new_booking": false,
  • "notification_email": "string",
  • "fee_percentage": "string",
  • "fee_minimal_commission": "string",
  • "fee_free_ticket_commission": "string",
  • "fee_included_free_tickets_percentage": 100,
  • "fee_payment_base_commission": "string",
  • "fee_payment_percentage": "string",
  • "_links": {
    }
}

Host

A Host represents the actual event organizer. It all starts with a Host.

Get all hosts

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "care_of": "string",
  • "address1": "string",
  • "address2": "string",
  • "zip": "string",
  • "city": "string",
  • "country": "string",
  • "will_call_label": "string",
  • "will_call_instructions": "string",
  • "send_reminders": true,
  • "delete_unpaid_bookings": true,
  • "public_email": "string",
  • "public_email_sender_name": "string",
  • "public_phone": "string",
  • "website": "string",
  • "bank_account": "string",
  • "bank_account_owner": "string",
  • "bank_account_city": "string",
  • "invoice_address": "string",
  • "vat_number": "string",
  • "thank_you_close": "string",
  • "complimentary_close": "string",
  • "contact_text": "string",
  • "confirmation_extras_template": "string",
  • "tos_title": "string",
  • "tos": "string",
  • "saferpay_terminal_id": "string",
  • "shared_secret": "string",
  • "prompt_newsletter": false,
  • "prompt_acquisition_channel": false,
  • "execute_deliveries": true,
  • "check_newsletter_by_default": false,
  • "address_right": false,
  • "enable_crm": false,
  • "enable_staff": false,
  • "enable_invitations": false,
  • "enable_seat_category_changes": false,
  • "enable_remaining_voucher_value_handling": false,
  • "enable_donations": false,
  • "execute_payouts": true,
  • "cancellation_policy": "strict",
  • "enable_salutation": true,
  • "use_security_code": true,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "allow_user_to_delete_booking": true,
  • "allow_embed_session_id": true,
  • "allow_single_empty_seats": true,
  • "setup_information": "string",
  • "support_info": "string",
  • "notify_on_new_booking": false,
  • "notification_email": "string",
  • "fee_percentage": "string",
  • "fee_minimal_commission": "string",
  • "fee_free_ticket_commission": "string",
  • "fee_included_free_tickets_percentage": 100,
  • "fee_payment_base_commission": "string",
  • "fee_payment_percentage": "string",
  • "_links": {
    }
}

Create a new host

Request Body schema: application/json
client
required
string

Public identifier (pid) of client

customer_group
required
string

Public identifier (pid) of user group

name
required
string

Name

operator_group
required
string

Public identifier (pid) of user group

public_email
required
string

Public email address

public_email_sender_name
required
string

Public email sender name

address1
string

Address 1

address2
string

Address 2

allow_single_empty_seats
boolean

Flag whether the customer is allowed to leave single empty seats in Embed Shop. Defaults to true

bank_account
string

Bank account (IBAN)

bank_account_owner
string

Name of bank account owner

cancellation_policy
string
Enum: "strict" "medium" "loose"

Cancellation policy of the Host.

care_of
string

c/o

check_newsletter_by_default
boolean

Flag whether the newsletter checkbox is selected by default when creating bookings for this host. Defaults to true.

city
string

City

complimentary_close
string

Complimentary close (final salutation) in documents

confirmation_extras_template
string

Additional text to appear in confirmation emails. May contain html and twig logic.

contact_text
string

Information about how to get in touch in documents

country
string

Country (2 letters, ISO 3166-1 alpha-2)

delete_unpaid_bookings
boolean

Flag whether unpaid bookings should be deleted, if applicable.

enable_salutation
boolean

Flag whether salutation is enabled for this host. Defaults to true.

invoice_address
string

An optional invoice address used for payouts and invoices.

logo
string

Public identifier (pid) of image

mail_header
string

Public identifier (pid) of image

notification_email
string

Email address to receive notifications about new bookings, if activated

notify_on_new_booking
boolean

Flag whether the host shall be notified on new bookings. Defaults to false.

prompt_acquisition_channel
boolean

Flag whether the acquisition channel is requested when creating bookings for this host. Defaults to false.

prompt_newsletter
boolean

Flag whether the newsletter checkbox is displayed when creating bookings for this host. Defaults to false.

public_phone
string

Public phone

send_reminders
boolean

Flag whether payment reminders should be sent for this host, if applicable. Defaults to true.

stationery_header
string

Public identifier (pid) of image

tos
string

Individual terms and conditions

use_security_code
boolean

Flag whether to use security codes in e-mails to customers and to protect access to customer area.

website
string

Website

will_call_instructions
string

Pick-up instructions for delivery method will call

will_call_label
string

Label for delivery method will call

zip
string

ZIP

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "public_email": "string",
  • "public_email_sender_name": "string",
  • "care_of": "string",
  • "address1": "string",
  • "address2": "string",
  • "zip": "string",
  • "city": "string",
  • "country": "string",
  • "bank_account": "string",
  • "bank_account_owner": "string",
  • "cancellation_policy": "strict",
  • "check_newsletter_by_default": true,
  • "client": "string",
  • "complimentary_close": "string",
  • "confirmation_extras_template": "string",
  • "contact_text": "string",
  • "customer_group": "string",
  • "delete_unpaid_bookings": true,
  • "enable_salutation": true,
  • "use_security_code": true,
  • "invoice_address": "string",
  • "logo": "string",
  • "mail_header": "string",
  • "notification_email": "string",
  • "notify_on_new_booking": true,
  • "operator_group": "string",
  • "prompt_acquisition_channel": true,
  • "prompt_newsletter": true,
  • "public_phone": "string",
  • "send_reminders": true,
  • "stationery_header": "string",
  • "tos": "string",
  • "website": "string",
  • "will_call_instructions": "string",
  • "will_call_label": "string",
  • "allow_single_empty_seats": true
}

Get only head data of GET request

Responses

Get a single host

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "care_of": "string",
  • "address1": "string",
  • "address2": "string",
  • "zip": "string",
  • "city": "string",
  • "country": "string",
  • "will_call_label": "string",
  • "will_call_instructions": "string",
  • "send_reminders": true,
  • "delete_unpaid_bookings": true,
  • "public_email": "string",
  • "public_email_sender_name": "string",
  • "public_phone": "string",
  • "website": "string",
  • "bank_account": "string",
  • "bank_account_owner": "string",
  • "bank_account_city": "string",
  • "invoice_address": "string",
  • "vat_number": "string",
  • "thank_you_close": "string",
  • "complimentary_close": "string",
  • "contact_text": "string",
  • "confirmation_extras_template": "string",
  • "tos_title": "string",
  • "tos": "string",
  • "saferpay_terminal_id": "string",
  • "shared_secret": "string",
  • "prompt_newsletter": false,
  • "prompt_acquisition_channel": false,
  • "execute_deliveries": true,
  • "check_newsletter_by_default": false,
  • "address_right": false,
  • "enable_crm": false,
  • "enable_staff": false,
  • "enable_invitations": false,
  • "enable_seat_category_changes": false,
  • "enable_remaining_voucher_value_handling": false,
  • "enable_donations": false,
  • "execute_payouts": true,
  • "cancellation_policy": "strict",
  • "enable_salutation": true,
  • "use_security_code": true,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "allow_user_to_delete_booking": true,
  • "allow_embed_session_id": true,
  • "allow_single_empty_seats": true,
  • "setup_information": "string",
  • "support_info": "string",
  • "notify_on_new_booking": false,
  • "notification_email": "string",
  • "fee_percentage": "string",
  • "fee_minimal_commission": "string",
  • "fee_free_ticket_commission": "string",
  • "fee_included_free_tickets_percentage": 100,
  • "fee_payment_base_commission": "string",
  • "fee_payment_percentage": "string",
  • "_links": {
    }
}

Delete a host

path Parameters
pid
required
string

Responses

Update a single host

path Parameters
pid
required
string
Request Body schema: application/json
client
required
string

Public identifier (pid) of client

customer_group
required
string

Public identifier (pid) of user group

name
required
string

Name

operator_group
required
string

Public identifier (pid) of user group

public_email
required
string

Public email address

public_email_sender_name
required
string

Public email sender name

address1
string

Address 1

address2
string

Address 2

allow_single_empty_seats
boolean

Flag whether the customer is allowed to leave single empty seats in Embed Shop. Defaults to true

bank_account
string

Bank account (IBAN)

bank_account_owner
string

Name of bank account owner

cancellation_policy
string
Enum: "strict" "medium" "loose"

Cancellation policy of the Host.

care_of
string

c/o

check_newsletter_by_default
boolean

Flag whether the newsletter checkbox is selected by default when creating bookings for this host. Defaults to true.

city
string

City

complimentary_close
string

Complimentary close (final salutation) in documents

confirmation_extras_template
string

Additional text to appear in confirmation emails. May contain html and twig logic.

contact_text
string

Information about how to get in touch in documents

country
string

Country (2 letters, ISO 3166-1 alpha-2)

delete_unpaid_bookings
boolean

Flag whether unpaid bookings should be deleted, if applicable.

enable_salutation
boolean

Flag whether salutation is enabled for this host. Defaults to true.

invoice_address
string

An optional invoice address used for payouts and invoices.

logo
string

Public identifier (pid) of image

mail_header
string

Public identifier (pid) of image

notification_email
string

Email address to receive notifications about new bookings, if activated

notify_on_new_booking
boolean

Flag whether the host shall be notified on new bookings. Defaults to false.

prompt_acquisition_channel
boolean

Flag whether the acquisition channel is requested when creating bookings for this host. Defaults to false.

prompt_newsletter
boolean

Flag whether the newsletter checkbox is displayed when creating bookings for this host. Defaults to false.

public_phone
string

Public phone

send_reminders
boolean

Flag whether payment reminders should be sent for this host, if applicable. Defaults to true.

stationery_header
string

Public identifier (pid) of image

tos
string

Individual terms and conditions

use_security_code
boolean

Flag whether to use security codes in e-mails to customers and to protect access to customer area.

website
string

Website

will_call_instructions
string

Pick-up instructions for delivery method will call

will_call_label
string

Label for delivery method will call

zip
string

ZIP

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "public_email": "string",
  • "public_email_sender_name": "string",
  • "care_of": "string",
  • "address1": "string",
  • "address2": "string",
  • "zip": "string",
  • "city": "string",
  • "country": "string",
  • "bank_account": "string",
  • "bank_account_owner": "string",
  • "cancellation_policy": "strict",
  • "check_newsletter_by_default": true,
  • "client": "string",
  • "complimentary_close": "string",
  • "confirmation_extras_template": "string",
  • "contact_text": "string",
  • "customer_group": "string",
  • "delete_unpaid_bookings": true,
  • "enable_salutation": true,
  • "use_security_code": true,
  • "invoice_address": "string",
  • "logo": "string",
  • "mail_header": "string",
  • "notification_email": "string",
  • "notify_on_new_booking": true,
  • "operator_group": "string",
  • "prompt_acquisition_channel": true,
  • "prompt_newsletter": true,
  • "public_phone": "string",
  • "send_reminders": true,
  • "stationery_header": "string",
  • "tos": "string",
  • "website": "string",
  • "will_call_instructions": "string",
  • "will_call_label": "string",
  • "allow_single_empty_seats": true
}

Get the client of a host

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "legal_name": "string",
  • "address": "string",
  • "zip": "string",
  • "city": "string",
  • "country": "string",
  • "internal_email": "string",
  • "public_email": "string",
  • "public_email_sender_name": "string",
  • "fee_minimal_commission": "string",
  • "fee_free_ticket_commission": "string",
  • "fee_included_free_tickets_percentage": 100,
  • "fee_ticket_options_percentage": "0.00",
  • "fee_options_percentage": "0.00",
  • "important_host_info": "string",
  • "enable_waiting_room": false,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the category of a host

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "string"
}

Get the operator group of a host

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z"
}

Get the acquisition channels of a host

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "translation_key": "string",
  • "order": 0,
  • "_links": {
    }
}

Get the coupon groups of a host

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": null,
  • "name": "string",
  • "code_format": "string",
  • "value_absolute": "string",
  • "value_percent": 1,
  • "value_max": "string",
  • "value_one_ticket": true,
  • "apply_to_tickets_only": false,
  • "allow_redemptions": 1,
  • "maximal_ticket_value": "string",
  • "minimal_booking_value": "string",
  • "max_coupons_per_booking": 0,
  • "expiration": "2019-08-24T14:15:22Z",
  • "available_in_shop": false,
  • "paid": false,
  • "for_individual_values": false,
  • "order": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the events of a host

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "timespan": { },
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "performer": "string",
  • "ticketdescription": "string",
  • "description": "string",
  • "delivery_info": "string",
  • "confirmation_extras_template": "string",
  • "will_call_label": "string",
  • "pay_before_dispatch": false,
  • "immediate_payment_only": false,
  • "send_reminders": true,
  • "delete_unpaid_bookings_mode": "never",
  • "allow_digital_dispatch": true,
  • "allow_deliveries": false,
  • "allow_will_call": false,
  • "issue_tickets": true,
  • "enable_passbook_tickets": true,
  • "require_customer_company": false,
  • "require_customer_address": true,
  • "require_customer_phone": false,
  • "prompt_customer_position": false,
  • "prompt_customer_department": false,
  • "prompt_customer_title": false,
  • "prompt_customer_birthday": false,
  • "allow_customer_notes": false,
  • "allow_invoice_address": false,
  • "allow_single_empty_seats": true,
  • "is_hidden": false,
  • "excluded_from_revenue_stats": false,
  • "tickets_per_booking": 1,
  • "tickets_in_listings": 1,
  • "refine_info": "string",
  • "reservation_info": "string",
  • "sales_point_info": "string",
  • "support_info": "string",
  • "payout_interval": "string",
  • "payout_interval_specification": "string",
  • "is_cancelled": true,
  • "will_be_postponed": true,
  • "cancellation_info": "string",
  • "invoice_address": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "notify_on_new_booking": false,
  • "notification_email": "string",
  • "fee_percentage": "string",
  • "fee_minimal_commission": "string",
  • "fee_free_ticket_commission": "string",
  • "fee_included_free_tickets_percentage": 100,
  • "fee_payment_base_commission": "string",
  • "fee_payment_percentage": "string",
  • "_links": {
    }
}

Get the venues of a host

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "capacity": 0,
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "internalname": "string",
  • "address": "string",
  • "zip": "string",
  • "city": "string",
  • "country": "string",
  • "is_adhoc_venue": true,
  • "is_archived": true,
  • "is_virtual": true,
  • "skidata_uri": "string",
  • "skidata_receiver": 0,
  • "skidata_issuer": 0,
  • "skidata_white_list_record_class": "string",
  • "skidata_last_fetch": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the sales points of a host

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "name": "string",
  • "care_of": "string",
  • "address1": "string",
  • "address2": "string",
  • "zip": "string",
  • "city": "string",
  • "country": "string",
  • "pos_only": true,
  • "require_customer": false,
  • "customer_search_enabled": false,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the box offices of a host

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the bookings of a host

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid_readable": "string",
  • "confirmation": true,
  • "delivery_method": "string",
  • "tickets_breakdown": { },
  • "pay_before_dispatch": true,
  • "is_dispatchable": true,
  • "urls": { },
  • "invoice_urls": { },
  • "denormalized_customer_pid": "string",
  • "denormalized_customer_fullname": "string",
  • "denormalized_customer_name_and_city": "string",
  • "denormalized_customer_country": "string",
  • "pid": 0,
  • "destination_country": "string",
  • "affiliate_id": "string",
  • "origin": "string",
  • "user_agent": "string",
  • "remote_address": "string",
  • "from_embed": true,
  • "source": "string",
  • "embed_session_id": "string",
  • "tos": true,
  • "digital_dispatch": true,
  • "delivery": true,
  • "will_call": true,
  • "deleted_by_customer": true,
  • "pos": true,
  • "internal_notes": "string",
  • "external_notes": "string",
  • "invoice_address": "string",
  • "checkbox_values": [
    ],
  • "payment_status_code": 0,
  • "first_full_payment": "2019-08-24T14:15:22Z",
  • "due_date": "2019-08-24T14:15:22Z",
  • "send_reminders": true,
  • "delete_if_unpaid": true,
  • "reminded_that_unpaid_at": "2019-08-24T14:15:22Z",
  • "next_reminder": "2019-08-24T14:15:22Z",
  • "refund_bank_account": "string",
  • "refund_bank_account_owner": "string",
  • "refund_bank_account_city": "string",
  • "approved": "2019-08-24T14:15:22Z",
  • "rejected": "2019-08-24T14:15:22Z",
  • "approval_requested": true,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": null,
  • "_links": {
    }
}

Get the excel lists of a host

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "name": "string",
  • "iterator": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the exports of a host

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "content_level": "crm",
  • "_links": {
    }
}

Get the delivery rates of a host

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "destination_country": "string",
  • "rate": "string",
  • "include_tickets": true,
  • "handling_period": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the invitations of a host

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "code": "string",
  • "expiration": "2019-08-24T14:15:22Z",
  • "personal": true,
  • "single_use": true,
  • "tickets_max_per_show": 0,
  • "tickets_max_per_event": 0,
  • "tickets_max_total": 0,
  • "tickets_max_per_booking": 0,
  • "max_different_shows": 0,
  • "rsvp": true,
  • "declined_at": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

HostWebHook

A HostWebHook represents a webhook that posts a message to an external server when specific actions happen. After receiving a message, the consumer of a HostWebHook executes an API request to Ticketpark to fetch additional data.

Get all hosts web hooks

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "pid": "string",
  • "host": {
    },
  • "type": "new-booking",
  • "url": "string",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Create one or multiple host web hooks

Request Body schema: application/json
host
required
string

Public identifier (pid) of a host

type
required
string
Enum: "new-booking" "new-payment" "booking-cancelled" "booking-tickets-updated" "booking-tickets-deleted" "new-person" "person-updated"

Web hook type

url
required
string

Web hook url

Responses

Request samples

Content type
application/json
{
  • "host": "string",
  • "type": "new-booking",
  • "url": "string"
}

Get only head data of GET request

Responses

Get a single host

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "pid": "string",
  • "host": {
    },
  • "type": "new-booking",
  • "url": "string",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Delete a host web hook

path Parameters
pid
required
string

Responses

Update a single host web hook

path Parameters
pid
required
string
Request Body schema: application/json
host
required
string

Public identifier (pid) of a host

type
required
string
Enum: "new-booking" "new-payment" "booking-cancelled" "booking-tickets-updated" "booking-tickets-deleted" "new-person" "person-updated"

Web hook type

url
required
string

Web hook url

Responses

Request samples

Content type
application/json
{
  • "host": "string",
  • "type": "new-booking",
  • "url": "string"
}

Invitation

An Invitation allows to give ticket buyers access to non-public prices or shows. It is often used for specific groups of guests, like VIPs or media.

Get all invitations

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "code": "string",
  • "expiration": "2019-08-24T14:15:22Z",
  • "personal": true,
  • "single_use": true,
  • "tickets_max_per_show": 0,
  • "tickets_max_per_event": 0,
  • "tickets_max_total": 0,
  • "tickets_max_per_booking": 0,
  • "max_different_shows": 0,
  • "rsvp": true,
  • "declined_at": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Create one or multiple invitations

Request Body schema: application/json
code
string

Invitation code

events
Array of strings

A list of public identifiers (pid) of events

expiration
string <date-time>

Expiration date

invitation_setup
string

Public identifier (pid) of an invitation setup

invitee_person
string

Public identifier (pid) of the invited person

invitor_person
string

Public identifier (pid) of the invitor person

max_different_shows
integer

Maximum number of different Shows booked

personal
boolean

Flag whether invitation is personal or not Defaults to true.

prices
Array of strings

A list of public identifiers (pid) of prices

rsvp
boolean

Flag whether invitation needs respond about attendance

sales_quota_embed_set
string

Public identifier (pid) of a sales quota embed set

shows
Array of strings

A list of public identifiers (pid) of shows

single_use
boolean

Flag whether invitation is single use Defaults to true.

tickets_max_per_booking
integer

Maximal quantity of tickets per booking

tickets_max_per_event
integer

Maximal quantity of tickets per event

tickets_max_per_show
integer

Maximal quantity of tickets per show

tickets_max_total
integer

Minimal quantity of tickets

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "events": [
    ],
  • "expiration": "2019-08-24T14:15:22Z",
  • "invitation_setup": "string",
  • "invitee_person": "string",
  • "invitor_person": "string",
  • "personal": true,
  • "prices": [
    ],
  • "rsvp": true,
  • "sales_quota_embed_set": "string",
  • "single_use": true,
  • "shows": [
    ],
  • "max_different_shows": 0,
  • "tickets_max_per_booking": 0,
  • "tickets_max_per_event": 0,
  • "tickets_max_per_show": 0,
  • "tickets_max_total": 0
}

Get only head data of GET request

Responses

Update one or multiple invitations

Request Body schema: application/json
code
string

Invitation code

events
Array of strings

A list of public identifiers (pid) of events

expiration
string <date-time>

Expiration date

invitation_setup
string

Public identifier (pid) of an invitation setup

invitee_person
string

Public identifier (pid) of the invited person

invitor_person
string

Public identifier (pid) of the invitor person

max_different_shows
integer

Maximum number of different Shows booked

personal
boolean

Flag whether invitation is personal or not Defaults to true.

prices
Array of strings

A list of public identifiers (pid) of prices

rsvp
boolean

Flag whether invitation needs respond about attendance

sales_quota_embed_set
string

Public identifier (pid) of a sales quota embed set

shows
Array of strings

A list of public identifiers (pid) of shows

single_use
boolean

Flag whether invitation is single use Defaults to true.

tickets_max_per_booking
integer

Maximal quantity of tickets per booking

tickets_max_per_event
integer

Maximal quantity of tickets per event

tickets_max_per_show
integer

Maximal quantity of tickets per show

tickets_max_total
integer

Minimal quantity of tickets

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "events": [
    ],
  • "expiration": "2019-08-24T14:15:22Z",
  • "invitation_setup": "string",
  • "invitee_person": "string",
  • "invitor_person": "string",
  • "personal": true,
  • "prices": [
    ],
  • "rsvp": true,
  • "sales_quota_embed_set": "string",
  • "single_use": true,
  • "shows": [
    ],
  • "max_different_shows": 0,
  • "tickets_max_per_booking": 0,
  • "tickets_max_per_event": 0,
  • "tickets_max_per_show": 0,
  • "tickets_max_total": 0
}

Get a single invitation

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "code": "string",
  • "expiration": "2019-08-24T14:15:22Z",
  • "personal": true,
  • "single_use": true,
  • "tickets_max_per_show": 0,
  • "tickets_max_per_event": 0,
  • "tickets_max_total": 0,
  • "tickets_max_per_booking": 0,
  • "max_different_shows": 0,
  • "rsvp": true,
  • "declined_at": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Delete an invitation

path Parameters
pid
required
string

Responses

Update a single invitation

path Parameters
pid
required
string
Request Body schema: application/json
code
string

Invitation code

events
Array of strings

A list of public identifiers (pid) of events

expiration
string <date-time>

Expiration date

invitation_setup
string

Public identifier (pid) of an invitation setup

invitee_person
string

Public identifier (pid) of the invited person

invitor_person
string

Public identifier (pid) of the invitor person

max_different_shows
integer

Maximum number of different Shows booked

personal
boolean

Flag whether invitation is personal or not Defaults to true.

prices
Array of strings

A list of public identifiers (pid) of prices

rsvp
boolean

Flag whether invitation needs respond about attendance

sales_quota_embed_set
string

Public identifier (pid) of a sales quota embed set

shows
Array of strings

A list of public identifiers (pid) of shows

single_use
boolean

Flag whether invitation is single use Defaults to true.

tickets_max_per_booking
integer

Maximal quantity of tickets per booking

tickets_max_per_event
integer

Maximal quantity of tickets per event

tickets_max_per_show
integer

Maximal quantity of tickets per show

tickets_max_total
integer

Minimal quantity of tickets

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "events": [
    ],
  • "expiration": "2019-08-24T14:15:22Z",
  • "invitation_setup": "string",
  • "invitee_person": "string",
  • "invitor_person": "string",
  • "personal": true,
  • "prices": [
    ],
  • "rsvp": true,
  • "sales_quota_embed_set": "string",
  • "single_use": true,
  • "shows": [
    ],
  • "max_different_shows": 0,
  • "tickets_max_per_booking": 0,
  • "tickets_max_per_event": 0,
  • "tickets_max_per_show": 0,
  • "tickets_max_total": 0
}

Get the host of an invitation

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "care_of": "string",
  • "address1": "string",
  • "address2": "string",
  • "zip": "string",
  • "city": "string",
  • "country": "string",
  • "will_call_label": "string",
  • "will_call_instructions": "string",
  • "send_reminders": true,
  • "delete_unpaid_bookings": true,
  • "public_email": "string",
  • "public_email_sender_name": "string",
  • "public_phone": "string",
  • "website": "string",
  • "bank_account": "string",
  • "bank_account_owner": "string",
  • "bank_account_city": "string",
  • "invoice_address": "string",
  • "vat_number": "string",
  • "thank_you_close": "string",
  • "complimentary_close": "string",
  • "contact_text": "string",
  • "confirmation_extras_template": "string",
  • "tos_title": "string",
  • "tos": "string",
  • "saferpay_terminal_id": "string",
  • "shared_secret": "string",
  • "prompt_newsletter": false,
  • "prompt_acquisition_channel": false,
  • "execute_deliveries": true,
  • "check_newsletter_by_default": false,
  • "address_right": false,
  • "enable_crm": false,
  • "enable_staff": false,
  • "enable_invitations": false,
  • "enable_seat_category_changes": false,
  • "enable_remaining_voucher_value_handling": false,
  • "enable_donations": false,
  • "execute_payouts": true,
  • "cancellation_policy": "strict",
  • "enable_salutation": true,
  • "use_security_code": true,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "allow_user_to_delete_booking": true,
  • "allow_embed_session_id": true,
  • "allow_single_empty_seats": true,
  • "setup_information": "string",
  • "support_info": "string",
  • "notify_on_new_booking": false,
  • "notification_email": "string",
  • "fee_percentage": "string",
  • "fee_minimal_commission": "string",
  • "fee_free_ticket_commission": "string",
  • "fee_included_free_tickets_percentage": 100,
  • "fee_payment_base_commission": "string",
  • "fee_payment_percentage": "string",
  • "_links": {
    }
}

Get the invitee person of an invitation

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "address1": "string",
  • "address2": "string",
  • "zip": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "translations": { },
  • "pid": "string",
  • "salutation": "string",
  • "title": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "company": "string",
  • "department": "string",
  • "position": "string",
  • "phone": "string",
  • "phone2": "string",
  • "phone3": "string",
  • "email": "string",
  • "birthday": "2019-08-24T14:15:22Z",
  • "newsletter": true,
  • "mailing": true,
  • "website": "string",
  • "locale": "string",
  • "address": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the invitor person of an invitation

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "address1": "string",
  • "address2": "string",
  • "zip": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "translations": { },
  • "pid": "string",
  • "salutation": "string",
  • "title": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "company": "string",
  • "department": "string",
  • "position": "string",
  • "phone": "string",
  • "phone2": "string",
  • "phone3": "string",
  • "email": "string",
  • "birthday": "2019-08-24T14:15:22Z",
  • "newsletter": true,
  • "mailing": true,
  • "website": "string",
  • "locale": "string",
  • "address": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the shows of the invitation.

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "access_role": "string",
  • "beacon_data": { },
  • "translations": { },
  • "pid": "string",
  • "performer": "string",
  • "ticketdescription": "string",
  • "description": "string",
  • "subtitle": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "end_check_in": "2019-08-24T14:15:22Z",
  • "start_public_sales": "2019-08-24T14:15:22Z",
  • "end_sales": "2019-08-24T14:15:22Z",
  • "end_sales_alternative": "string",
  • "dooropening": "2019-08-24T14:15:22Z",
  • "specific_capacity": 1,
  • "allow_sales_while_current": false,
  • "allow_single_empty_seats": true,
  • "always_display_start_time": false,
  • "reservation_info": "string",
  • "request_ratings": false,
  • "order": 0,
  • "is_cancelled": true,
  • "will_be_postponed": true,
  • "is_online_show": true,
  • "online_show": {
    },
  • "tickets_per_booking": 1,
  • "enable_passbook_tickets": true,
  • "access_by": "string",
  • "ratings_requested": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the prices of invitation.

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "_links": {
    },
  • "discr": "price"
}

Get the events of the invitation.

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "timespan": { },
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "performer": "string",
  • "ticketdescription": "string",
  • "description": "string",
  • "delivery_info": "string",
  • "confirmation_extras_template": "string",
  • "will_call_label": "string",
  • "pay_before_dispatch": false,
  • "immediate_payment_only": false,
  • "send_reminders": true,
  • "delete_unpaid_bookings_mode": "never",
  • "allow_digital_dispatch": true,
  • "allow_deliveries": false,
  • "allow_will_call": false,
  • "issue_tickets": true,
  • "enable_passbook_tickets": true,
  • "require_customer_company": false,
  • "require_customer_address": true,
  • "require_customer_phone": false,
  • "prompt_customer_position": false,
  • "prompt_customer_department": false,
  • "prompt_customer_title": false,
  • "prompt_customer_birthday": false,
  • "allow_customer_notes": false,
  • "allow_invoice_address": false,
  • "allow_single_empty_seats": true,
  • "is_hidden": false,
  • "excluded_from_revenue_stats": false,
  • "tickets_per_booking": 1,
  • "tickets_in_listings": 1,
  • "refine_info": "string",
  • "reservation_info": "string",
  • "sales_point_info": "string",
  • "support_info": "string",
  • "payout_interval": "string",
  • "payout_interval_specification": "string",
  • "is_cancelled": true,
  • "will_be_postponed": true,
  • "cancellation_info": "string",
  • "invoice_address": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "notify_on_new_booking": false,
  • "notification_email": "string",
  • "fee_percentage": "string",
  • "fee_minimal_commission": "string",
  • "fee_free_ticket_commission": "string",
  • "fee_included_free_tickets_percentage": 100,
  • "fee_payment_base_commission": "string",
  • "fee_payment_percentage": "string",
  • "_links": {
    }
}

Get the bookings of the invitation.

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid_readable": "string",
  • "confirmation": true,
  • "delivery_method": "string",
  • "tickets_breakdown": { },
  • "pay_before_dispatch": true,
  • "is_dispatchable": true,
  • "urls": { },
  • "invoice_urls": { },
  • "denormalized_customer_pid": "string",
  • "denormalized_customer_fullname": "string",
  • "denormalized_customer_name_and_city": "string",
  • "denormalized_customer_country": "string",
  • "pid": 0,
  • "destination_country": "string",
  • "affiliate_id": "string",
  • "origin": "string",
  • "user_agent": "string",
  • "remote_address": "string",
  • "from_embed": true,
  • "source": "string",
  • "embed_session_id": "string",
  • "tos": true,
  • "digital_dispatch": true,
  • "delivery": true,
  • "will_call": true,
  • "deleted_by_customer": true,
  • "pos": true,
  • "internal_notes": "string",
  • "external_notes": "string",
  • "invoice_address": "string",
  • "checkbox_values": [
    ],
  • "payment_status_code": 0,
  • "first_full_payment": "2019-08-24T14:15:22Z",
  • "due_date": "2019-08-24T14:15:22Z",
  • "send_reminders": true,
  • "delete_if_unpaid": true,
  • "reminded_that_unpaid_at": "2019-08-24T14:15:22Z",
  • "next_reminder": "2019-08-24T14:15:22Z",
  • "refund_bank_account": "string",
  • "refund_bank_account_owner": "string",
  • "refund_bank_account_city": "string",
  • "approved": "2019-08-24T14:15:22Z",
  • "rejected": "2019-08-24T14:15:22Z",
  • "approval_requested": true,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": null,
  • "_links": {
    }
}

Get the emails of the invitation.

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "receiver_email": "string",
  • "from_email": "string",
  • "from_name": "string",
  • "reply_to_email": "string",
  • "reply_to_name": "string",
  • "subject": "string",
  • "text": "string",
  • "text_moved_to_storage": false,
  • "html": "string",
  • "html_moved_to_storage": false,
  • "attachments": [ ],
  • "sent": "2019-08-24T14:15:22Z",
  • "failed": "2019-08-24T14:15:22Z",
  • "failed_type": "string",
  • "opened": "2019-08-24T14:15:22Z",
  • "bounced": "2019-08-24T14:15:22Z",
  • "bounced_type": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the quotas of the invitation.

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "limitation": 0,
  • "code": "string",
  • "_links": {
    }
}

InvitationEventLimitation

An InvitationEventLimitation defines a ticket limitation for a combination of a specific event and a specific invitation.

Get all invitation event limitations

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "limitation": 0
}

Create one or multiple invitation event limitations

Request Body schema: application/json
event
required
string

Public identifier (pid) of an Event

invitation
required
string

Public identifier (pid) of an invitation

limitation
required
integer

Limitation

Responses

Request samples

Content type
application/json
{
  • "event": "string",
  • "invitation": "string",
  • "limitation": 0
}

Update one or multiple invitation event limitations

Request Body schema: application/json
event
required
string

Public identifier (pid) of an Event

invitation
required
string

Public identifier (pid) of an invitation

limitation
required
integer

Limitation

Responses

Request samples

Content type
application/json
{
  • "event": "string",
  • "invitation": "string",
  • "limitation": 0
}

Get a single invitation event limitation

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "limitation": 0
}

Delete an invitation event limitation

path Parameters
pid
required
string

Responses

Update a single invitation event limitation

path Parameters
pid
required
string
Request Body schema: application/json
event
required
string

Public identifier (pid) of an Event

invitation
required
string

Public identifier (pid) of an invitation

limitation
required
integer

Limitation

Responses

Request samples

Content type
application/json
{
  • "event": "string",
  • "invitation": "string",
  • "limitation": 0
}

Get the invitation of an invitation event limitation

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "code": "string",
  • "expiration": "2019-08-24T14:15:22Z",
  • "personal": true,
  • "single_use": true,
  • "tickets_max_per_show": 0,
  • "tickets_max_per_event": 0,
  • "tickets_max_total": 0,
  • "tickets_max_per_booking": 0,
  • "max_different_shows": 0,
  • "rsvp": true,
  • "declined_at": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the event of an invitation event limitation

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "timespan": { },
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "performer": "string",
  • "ticketdescription": "string",
  • "description": "string",
  • "delivery_info": "string",
  • "confirmation_extras_template": "string",
  • "will_call_label": "string",
  • "pay_before_dispatch": false,
  • "immediate_payment_only": false,
  • "send_reminders": true,
  • "delete_unpaid_bookings_mode": "never",
  • "allow_digital_dispatch": true,
  • "allow_deliveries": false,
  • "allow_will_call": false,
  • "issue_tickets": true,
  • "enable_passbook_tickets": true,
  • "require_customer_company": false,
  • "require_customer_address": true,
  • "require_customer_phone": false,
  • "prompt_customer_position": false,
  • "prompt_customer_department": false,
  • "prompt_customer_title": false,
  • "prompt_customer_birthday": false,
  • "allow_customer_notes": false,
  • "allow_invoice_address": false,
  • "allow_single_empty_seats": true,
  • "is_hidden": false,
  • "excluded_from_revenue_stats": false,
  • "tickets_per_booking": 1,
  • "tickets_in_listings": 1,
  • "refine_info": "string",
  • "reservation_info": "string",
  • "sales_point_info": "string",
  • "support_info": "string",
  • "payout_interval": "string",
  • "payout_interval_specification": "string",
  • "is_cancelled": true,
  • "will_be_postponed": true,
  • "cancellation_info": "string",
  • "invoice_address": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "notify_on_new_booking": false,
  • "notification_email": "string",
  • "fee_percentage": "string",
  • "fee_minimal_commission": "string",
  • "fee_free_ticket_commission": "string",
  • "fee_included_free_tickets_percentage": 100,
  • "fee_payment_base_commission": "string",
  • "fee_payment_percentage": "string",
  • "_links": {
    }
}

InvitationQuota

An InvitationQuota defines the maximum number of tickets that a specific Invitation may book for a specific Price.

Get all invitation quotas

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "limitation": 0,
  • "code": "string",
  • "_links": {
    }
}

Create one or multiple invitation quotas

Request Body schema: application/json
invitation
required
string

Public identifier (pid) of an invitation

limitation
required
integer

Limitation (null for unlimited)

prices
required
Array of strings

A list of public identifiers (pid) of prices

code
string

Invitation code

Responses

Request samples

Content type
application/json
{
  • "invitation": "string",
  • "limitation": 0,
  • "prices": [
    ],
  • "code": "string"
}

Get only head data of GET request

Responses

Update one or multiple invitation quotas

Request Body schema: application/json
invitation
required
string

Public identifier (pid) of an invitation

limitation
required
integer

Limitation (null for unlimited)

prices
required
Array of strings

A list of public identifiers (pid) of prices

code
string

Invitation code

Responses

Request samples

Content type
application/json
{
  • "invitation": "string",
  • "limitation": 0,
  • "prices": [
    ],
  • "code": "string"
}

Get a single invitation quota

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "limitation": 0,
  • "code": "string",
  • "_links": {
    }
}

Delete an invitation quota

path Parameters
pid
required
string

Responses

Update a single invitation quota

path Parameters
pid
required
string
Request Body schema: application/json
invitation
required
string

Public identifier (pid) of an invitation

limitation
required
integer

Limitation (null for unlimited)

prices
required
Array of strings

A list of public identifiers (pid) of prices

code
string

Invitation code

Responses

Request samples

Content type
application/json
{
  • "invitation": "string",
  • "limitation": 0,
  • "prices": [
    ],
  • "code": "string"
}

Get the prices of an invitation quota

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "_links": {
    },
  • "discr": "price"
}

Get the invitation of an invitation quota

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "code": "string",
  • "expiration": "2019-08-24T14:15:22Z",
  • "personal": true,
  • "single_use": true,
  • "tickets_max_per_show": 0,
  • "tickets_max_per_event": 0,
  • "tickets_max_total": 0,
  • "tickets_max_per_booking": 0,
  • "max_different_shows": 0,
  • "rsvp": true,
  • "declined_at": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

InvitationSetup

An InvitationSetup defines meta data of how and where an Invitation is used in order to make sending invitation emails possible.

Get all invitation setups

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "name": "string",
  • "shop_url": "string",
  • "code_prefix": "string",
  • "_links": {
    }
}

Create one or multiple invitation setups

Request Body schema: application/json
event
required
string

Public identifier (pid) of an event

name
required
string

Name of the setup

code_prefix
string

Prefix for invitation codes to be generated

shop_url
string

Url to the embed shop where invitations can be used

Responses

Request samples

Content type
application/json
{
  • "event": "string",
  • "name": "string",
  • "code_prefix": "string",
  • "shop_url": "string"
}

Get only head data of GET request

Responses

Update one or multiple invitation setups

Request Body schema: application/json
event
required
string

Public identifier (pid) of an event

name
required
string

Name of the setup

code_prefix
string

Prefix for invitation codes to be generated

shop_url
string

Url to the embed shop where invitations can be used

Responses

Request samples

Content type
application/json
{
  • "event": "string",
  • "name": "string",
  • "code_prefix": "string",
  • "shop_url": "string"
}

Get a single invitation setup

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "name": "string",
  • "shop_url": "string",
  • "code_prefix": "string",
  • "_links": {
    }
}

Delete an invitation setups

path Parameters
pid
required
string

Responses

Update a single invitation setup

path Parameters
pid
required
string
Request Body schema: application/json
event
required
string

Public identifier (pid) of an event

name
required
string

Name of the setup

code_prefix
string

Prefix for invitation codes to be generated

shop_url
string

Url to the embed shop where invitations can be used

Responses

Request samples

Content type
application/json
{
  • "event": "string",
  • "name": "string",
  • "code_prefix": "string",
  • "shop_url": "string"
}

Get the event of an invitation setups

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "timespan": { },
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "performer": "string",
  • "ticketdescription": "string",
  • "description": "string",
  • "delivery_info": "string",
  • "confirmation_extras_template": "string",
  • "will_call_label": "string",
  • "pay_before_dispatch": false,
  • "immediate_payment_only": false,
  • "send_reminders": true,
  • "delete_unpaid_bookings_mode": "never",
  • "allow_digital_dispatch": true,
  • "allow_deliveries": false,
  • "allow_will_call": false,
  • "issue_tickets": true,
  • "enable_passbook_tickets": true,
  • "require_customer_company": false,
  • "require_customer_address": true,
  • "require_customer_phone": false,
  • "prompt_customer_position": false,
  • "prompt_customer_department": false,
  • "prompt_customer_title": false,
  • "prompt_customer_birthday": false,
  • "allow_customer_notes": false,
  • "allow_invoice_address": false,
  • "allow_single_empty_seats": true,
  • "is_hidden": false,
  • "excluded_from_revenue_stats": false,
  • "tickets_per_booking": 1,
  • "tickets_in_listings": 1,
  • "refine_info": "string",
  • "reservation_info": "string",
  • "sales_point_info": "string",
  • "support_info": "string",
  • "payout_interval": "string",
  • "payout_interval_specification": "string",
  • "is_cancelled": true,
  • "will_be_postponed": true,
  • "cancellation_info": "string",
  • "invoice_address": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "notify_on_new_booking": false,
  • "notification_email": "string",
  • "fee_percentage": "string",
  • "fee_minimal_commission": "string",
  • "fee_free_ticket_commission": "string",
  • "fee_included_free_tickets_percentage": 100,
  • "fee_payment_base_commission": "string",
  • "fee_payment_percentage": "string",
  • "_links": {
    }
}

InvitationShowLimitation

An InvitationShowLimitation defines a ticket limitation for a combination of a specific show and a specific invitation.

Get all invitation show limitations

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "limitation": 0
}

Create one or multiple invitation show limitations

Request Body schema: application/json
invitation
required
string

Public identifier (pid) of an invitation

limitation
required
integer

Limitation

show
required
string

Public identifier (pid) of a show

Responses

Request samples

Content type
application/json
{
  • "invitation": "string",
  • "limitation": 0,
  • "show": "string"
}

Get only head data of GET request

Responses

Update one or multiple invitation show limitations

Request Body schema: application/json
invitation
required
string

Public identifier (pid) of an invitation

limitation
required
integer

Limitation

show
required
string

Public identifier (pid) of a show

Responses

Request samples

Content type
application/json
{
  • "invitation": "string",
  • "limitation": 0,
  • "show": "string"
}

Get a single invitation show limitation

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "limitation": 0
}

Delete an invitation show limitation

path Parameters
pid
required
string

Responses

Update a single invitation show limitation

path Parameters
pid
required
string
Request Body schema: application/json
invitation
required
string

Public identifier (pid) of an invitation

limitation
required
integer

Limitation

show
required
string

Public identifier (pid) of a show

Responses

Request samples

Content type
application/json
{
  • "invitation": "string",
  • "limitation": 0,
  • "show": "string"
}

Get the invitation of an invitation show limitation

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "code": "string",
  • "expiration": "2019-08-24T14:15:22Z",
  • "personal": true,
  • "single_use": true,
  • "tickets_max_per_show": 0,
  • "tickets_max_per_event": 0,
  • "tickets_max_total": 0,
  • "tickets_max_per_booking": 0,
  • "max_different_shows": 0,
  • "rsvp": true,
  • "declined_at": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the show of an invitation show limitation

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "access_role": "string",
  • "beacon_data": { },
  • "translations": { },
  • "pid": "string",
  • "performer": "string",
  • "ticketdescription": "string",
  • "description": "string",
  • "subtitle": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "end_check_in": "2019-08-24T14:15:22Z",
  • "start_public_sales": "2019-08-24T14:15:22Z",
  • "end_sales": "2019-08-24T14:15:22Z",
  • "end_sales_alternative": "string",
  • "dooropening": "2019-08-24T14:15:22Z",
  • "specific_capacity": 1,
  • "allow_sales_while_current": false,
  • "allow_single_empty_seats": true,
  • "always_display_start_time": false,
  • "reservation_info": "string",
  • "request_ratings": false,
  • "order": 0,
  • "is_cancelled": true,
  • "will_be_postponed": true,
  • "is_online_show": true,
  • "online_show": {
    },
  • "tickets_per_booking": 1,
  • "enable_passbook_tickets": true,
  • "access_by": "string",
  • "ratings_requested": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Job

A Job represents a specific task that can be assigned within the staff module.

Get all jobs

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "pid": "string",
  • "name": "string",
  • "description": null,
  • "meeting_point": null,
  • "location": null,
  • "equipment": null,
  • "additional_information": "string",
  • "department": {
    },
  • "head": null,
  • "deputy_head": null,
  • "slots": [
    ],
  • "batch_id": "string",
  • "batch_order": 0,
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get a single job

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "pid": "string",
  • "name": "string",
  • "description": null,
  • "meeting_point": null,
  • "location": null,
  • "equipment": null,
  • "additional_information": "string",
  • "department": {
    },
  • "head": null,
  • "deputy_head": null,
  • "slots": [
    ],
  • "batch_id": "string",
  • "batch_order": 0,
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete a job

path Parameters
pid
required
string

Responses

MailChimpAccount

A MailChimpAccount represents a Host's account at Mailchimp, to which data of Persons can be synced automatically.

Get all Mailchimp accounts

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "api_key": "string",
  • "list_id": "string",
  • "interest_category_id": "string",
  • "host": {
    },
  • "_links": {
    }
}

Create one or multiple Mailchimp accounts

Request Body schema: application/json
api_key
required
string

The Mailchimp API key

host
required
string

Public identifier (PID) of host

list_id
required
string

The id of the Mailchimp audience list

Responses

Request samples

Content type
application/json
{
  • "api_key": "string",
  • "host": "string",
  • "list_id": "string"
}

Get only head data of GET request

Responses

Get a single Mailchimp account

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "api_key": "string",
  • "list_id": "string",
  • "interest_category_id": "string",
  • "host": {
    },
  • "_links": {
    }
}

Delete a Mailchimp accounts

path Parameters
pid
required
string

Responses

Update a single Mailchimp account

path Parameters
pid
required
string
Request Body schema: application/json
api_key
required
string

The Mailchimp API key

host
required
string

Public identifier (PID) of host

list_id
required
string

The id of the Mailchimp audience list

Responses

Request samples

Content type
application/json
{
  • "api_key": "string",
  • "host": "string",
  • "list_id": "string"
}

MultiCoupon

A MultiCoupon represents a collection of connected Coupons. A Multicoupon allows to communicate just one coupon code to a potential guest in cases where the same coupon would be available many different times. It can in some cases be a helpful alternative to Invitations.

Get all multi coupons

Responses

Response samples

Content type
application/json
{
  • "code_formatted": "string",
  • "pid": "string",
  • "value_absolute": "string",
  • "expiration": "2019-08-24T14:15:22Z",
  • "code": "string",
  • "disabled": false,
  • "_links": {
    }
}

Create one or multiple multi coupons

Request Body schema: application/json
code
required
string

Code

coupons
required
Array of strings

A list of coupon codes

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "coupons": [
    ]
}

Get only head data of GET request

Responses

Update one or multiple multi coupons

Request Body schema: application/json
code
required
string

Code

coupons
required
Array of strings

A list of coupon codes

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "coupons": [
    ]
}

Get a single multi coupon

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "code_formatted": "string",
  • "pid": "string",
  • "value_absolute": "string",
  • "expiration": "2019-08-24T14:15:22Z",
  • "code": "string",
  • "disabled": false,
  • "_links": {
    }
}

Delete a multi coupon

path Parameters
pid
required
string

Responses

Update a multi coupon

path Parameters
pid
required
string
Request Body schema: application/json
code
required
string

Code

coupons
required
Array of strings

A list of coupon codes

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "coupons": [
    ]
}

Get the coupons of a multi coupon

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "_links": {
    },
  • "discr": "coupon"
}

Option

An Option represents an item that can be booked in addition to a ticket. It works on Booking level, in contrast to the more powerful TicketOptions which work on ticket level. A classic example for an Option would be a t-shirt or a parking spot.

Get all options

Responses

Response samples

Content type
application/json
{
  • "price_excluding_vat": 0,
  • "price_including_vat": 0,
  • "vat_amount": 0,
  • "vat_rate": 0,
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "description": "string",
  • "order": 0,
  • "limitation": 0,
  • "margin": 0,
  • "items_per_booking": 1,
  • "requires_code": false,
  • "option_variables": [
    ],
  • "access_by": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "custom_fee_percentage": "string",
  • "price": "string",
  • "_links": {
    }
}

Create one or multiple options

Request Body schema: application/json
name
required
string

Option name

price
required
any

Price

access_by
string
Value: "host"

Who may see this Option. Set to null for public.

description
string

Option description

event
string

Public identifier (pid) of event

image
string

Public identifier (pid) of image

items_per_booking
integer

Maximum number of items of this option per booking

limitation
integer

Maximum available number of this option

margin
integer

Flexibility on limitation if booked within the same booking

Array of objects (OptionVariableType)
order
integer

Order index in lists (lowest to highest)

BooleanType (object)

Flag whether an prepared code should be assigned to booked items of this option

show
string

Public identifier (pid) of show

vat
string

Public identifier (pid) of VAT

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "price": null,
  • "description": "string",
  • "event": "string",
  • "image": "string",
  • "items_per_booking": 0,
  • "limitation": 0,
  • "margin": 0,
  • "requires_code": {
    },
  • "option_variables": [
    ],
  • "order": 0,
  • "show": "string",
  • "vat": "string",
  • "access_by": "host"
}

Get only head data of GET request

Responses

Update one or multiple options

Request Body schema: application/json
name
required
string

Option name

price
required
any

Price

access_by
string
Value: "host"

Who may see this Option. Set to null for public.

description
string

Option description

event
string

Public identifier (pid) of event

image
string

Public identifier (pid) of image

items_per_booking
integer

Maximum number of items of this option per booking

limitation
integer

Maximum available number of this option

margin
integer

Flexibility on limitation if booked within the same booking

Array of objects (OptionVariableType)
order
integer

Order index in lists (lowest to highest)

BooleanType (object)

Flag whether an prepared code should be assigned to booked items of this option

show
string

Public identifier (pid) of show

vat
string

Public identifier (pid) of VAT

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "price": null,
  • "description": "string",
  • "event": "string",
  • "image": "string",
  • "items_per_booking": 0,
  • "limitation": 0,
  • "margin": 0,
  • "requires_code": {
    },
  • "option_variables": [
    ],
  • "order": 0,
  • "show": "string",
  • "vat": "string",
  • "access_by": "host"
}

Get a single option

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "price_excluding_vat": 0,
  • "price_including_vat": 0,
  • "vat_amount": 0,
  • "vat_rate": 0,
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "description": "string",
  • "order": 0,
  • "limitation": 0,
  • "margin": 0,
  • "items_per_booking": 1,
  • "requires_code": false,
  • "option_variables": [
    ],
  • "access_by": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "custom_fee_percentage": "string",
  • "price": "string",
  • "_links": {
    }
}

Delete an option

path Parameters
pid
required
string

Responses

Update a single option

path Parameters
pid
required
string
Request Body schema: application/json
name
required
string

Option name

price
required
any

Price

access_by
string
Value: "host"

Who may see this Option. Set to null for public.

description
string

Option description

event
string

Public identifier (pid) of event

image
string

Public identifier (pid) of image

items_per_booking
integer

Maximum number of items of this option per booking

limitation
integer

Maximum available number of this option

margin
integer

Flexibility on limitation if booked within the same booking

Array of objects (OptionVariableType)
order
integer

Order index in lists (lowest to highest)

BooleanType (object)

Flag whether an prepared code should be assigned to booked items of this option

show
string

Public identifier (pid) of show

vat
string

Public identifier (pid) of VAT

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "price": null,
  • "description": "string",
  • "event": "string",
  • "image": "string",
  • "items_per_booking": 0,
  • "limitation": 0,
  • "margin": 0,
  • "requires_code": {
    },
  • "option_variables": [
    ],
  • "order": 0,
  • "show": "string",
  • "vat": "string",
  • "access_by": "host"
}

Get the event of an option

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "timespan": { },
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "performer": "string",
  • "ticketdescription": "string",
  • "description": "string",
  • "delivery_info": "string",
  • "confirmation_extras_template": "string",
  • "will_call_label": "string",
  • "pay_before_dispatch": false,
  • "immediate_payment_only": false,
  • "send_reminders": true,
  • "delete_unpaid_bookings_mode": "never",
  • "allow_digital_dispatch": true,
  • "allow_deliveries": false,
  • "allow_will_call": false,
  • "issue_tickets": true,
  • "enable_passbook_tickets": true,
  • "require_customer_company": false,
  • "require_customer_address": true,
  • "require_customer_phone": false,
  • "prompt_customer_position": false,
  • "prompt_customer_department": false,
  • "prompt_customer_title": false,
  • "prompt_customer_birthday": false,
  • "allow_customer_notes": false,
  • "allow_invoice_address": false,
  • "allow_single_empty_seats": true,
  • "is_hidden": false,
  • "excluded_from_revenue_stats": false,
  • "tickets_per_booking": 1,
  • "tickets_in_listings": 1,
  • "refine_info": "string",
  • "reservation_info": "string",
  • "sales_point_info": "string",
  • "support_info": "string",
  • "payout_interval": "string",
  • "payout_interval_specification": "string",
  • "is_cancelled": true,
  • "will_be_postponed": true,
  • "cancellation_info": "string",
  • "invoice_address": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "notify_on_new_booking": false,
  • "notification_email": "string",
  • "fee_percentage": "string",
  • "fee_minimal_commission": "string",
  • "fee_free_ticket_commission": "string",
  • "fee_included_free_tickets_percentage": 100,
  • "fee_payment_base_commission": "string",
  • "fee_payment_percentage": "string",
  • "_links": {
    }
}

Get the show of an option

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "access_role": "string",
  • "beacon_data": { },
  • "translations": { },
  • "pid": "string",
  • "performer": "string",
  • "ticketdescription": "string",
  • "description": "string",
  • "subtitle": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "end_check_in": "2019-08-24T14:15:22Z",
  • "start_public_sales": "2019-08-24T14:15:22Z",
  • "end_sales": "2019-08-24T14:15:22Z",
  • "end_sales_alternative": "string",
  • "dooropening": "2019-08-24T14:15:22Z",
  • "specific_capacity": 1,
  • "allow_sales_while_current": false,
  • "allow_single_empty_seats": true,
  • "always_display_start_time": false,
  • "reservation_info": "string",
  • "request_ratings": false,
  • "order": 0,
  • "is_cancelled": true,
  • "will_be_postponed": true,
  • "is_online_show": true,
  • "online_show": {
    },
  • "tickets_per_booking": 1,
  • "enable_passbook_tickets": true,
  • "access_by": "string",
  • "ratings_requested": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the option items of an option

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "denormalized_option_pid": "string",
  • "denormalized_option_name": "string",
  • "denormalized_option_description": "string",
  • "denormalized_event_pid": "string",
  • "denormalized_event_name": "string",
  • "denormalized_vat_pid": "string",
  • "denormalized_vat_rate": "string",
  • "denormalized_vat_included": "string",
  • "denormalized_price": "string",
  • "denormalized_price_including_vat": "string",
  • "denormalized_price_excluding_vat": "string",
  • "denormalized_vat_amount": "string",
  • "denormalized_currency_pid": "string",
  • "pid": "string",
  • "option_variable_values": [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the option variables of an option

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "option_variable_values": [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

OptionItem

An OptionItem represents a single booked item of an Option.

Get all option items

Responses

Response samples

Content type
application/json
{
  • "denormalized_option_pid": "string",
  • "denormalized_option_name": "string",
  • "denormalized_option_description": "string",
  • "denormalized_event_pid": "string",
  • "denormalized_event_name": "string",
  • "denormalized_vat_pid": "string",
  • "denormalized_vat_rate": "string",
  • "denormalized_vat_included": "string",
  • "denormalized_price": "string",
  • "denormalized_price_including_vat": "string",
  • "denormalized_price_excluding_vat": "string",
  • "denormalized_vat_amount": "string",
  • "denormalized_currency_pid": "string",
  • "pid": "string",
  • "option_variable_values": [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Create one or multiple option items

Request Body schema: application/json
booking
required
string

Public identifier (pid) of booking

option
required
string

Public identifier (pid) of option

option_variable_values
Array of strings

Responses

Request samples

Content type
application/json
{
  • "booking": "string",
  • "option": "string",
  • "option_variable_values": [
    ]
}

Get only head data of GET request

Responses

Update one or multiple option items

Request Body schema: application/json
booking
required
string

Public identifier (pid) of booking

option
required
string

Public identifier (pid) of option

option_variable_values
Array of strings

Responses

Request samples

Content type
application/json
{
  • "booking": "string",
  • "option": "string",
  • "option_variable_values": [
    ]
}

Get a single option item

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "denormalized_option_pid": "string",
  • "denormalized_option_name": "string",
  • "denormalized_option_description": "string",
  • "denormalized_event_pid": "string",
  • "denormalized_event_name": "string",
  • "denormalized_vat_pid": "string",
  • "denormalized_vat_rate": "string",
  • "denormalized_vat_included": "string",
  • "denormalized_price": "string",
  • "denormalized_price_including_vat": "string",
  • "denormalized_price_excluding_vat": "string",
  • "denormalized_vat_amount": "string",
  • "denormalized_currency_pid": "string",
  • "pid": "string",
  • "option_variable_values": [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Delete an option item

path Parameters
pid
required
string

Responses

Update a single option item

path Parameters
pid
required
string
Request Body schema: application/json
booking
required
string

Public identifier (pid) of booking

option
required
string

Public identifier (pid) of option

option_variable_values
Array of strings

Responses

Request samples

Content type
application/json
{
  • "booking": "string",
  • "option": "string",
  • "option_variable_values": [
    ]
}

Get the booking of an option item

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid_readable": "string",
  • "confirmation": true,
  • "delivery_method": "string",
  • "tickets_breakdown": { },
  • "pay_before_dispatch": true,
  • "is_dispatchable": true,
  • "urls": { },
  • "invoice_urls": { },
  • "denormalized_customer_pid": "string",
  • "denormalized_customer_fullname": "string",
  • "denormalized_customer_name_and_city": "string",
  • "denormalized_customer_country": "string",
  • "pid": 0,
  • "destination_country": "string",
  • "affiliate_id": "string",
  • "origin": "string",
  • "user_agent": "string",
  • "remote_address": "string",
  • "from_embed": true,
  • "source": "string",
  • "embed_session_id": "string",
  • "tos": true,
  • "digital_dispatch": true,
  • "delivery": true,
  • "will_call": true,
  • "deleted_by_customer": true,
  • "pos": true,
  • "internal_notes": "string",
  • "external_notes": "string",
  • "invoice_address": "string",
  • "checkbox_values": [
    ],
  • "payment_status_code": 0,
  • "first_full_payment": "2019-08-24T14:15:22Z",
  • "due_date": "2019-08-24T14:15:22Z",
  • "send_reminders": true,
  • "delete_if_unpaid": true,
  • "reminded_that_unpaid_at": "2019-08-24T14:15:22Z",
  • "next_reminder": "2019-08-24T14:15:22Z",
  • "refund_bank_account": "string",
  • "refund_bank_account_owner": "string",
  • "refund_bank_account_city": "string",
  • "approved": "2019-08-24T14:15:22Z",
  • "rejected": "2019-08-24T14:15:22Z",
  • "approval_requested": true,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": null,
  • "_links": {
    }
}

Get the option of an option item

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "price_excluding_vat": 0,
  • "price_including_vat": 0,
  • "vat_amount": 0,
  • "vat_rate": 0,
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "description": "string",
  • "order": 0,
  • "limitation": 0,
  • "margin": 0,
  • "items_per_booking": 1,
  • "requires_code": false,
  • "option_variables": [
    ],
  • "access_by": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "custom_fee_percentage": "string",
  • "price": "string",
  • "_links": {
    }
}

Get the option variable values of an option item

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "denormalized_option_variable_pid": "string",
  • "denormalized_option_variable_name": "string",
  • "translations": { },
  • "pid": "string",
  • "value": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

OptionVariable

An OptionVariable represents a configuration element of an Option. An example would be the size of a t-shirt. An OptionVariable typically contains multiple OptionVariableItems.

Get all option variables

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "option_variable_values": [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get only head data of GET request

Responses

Get a single Optiooption variablesnVariable

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "option_variable_values": [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the option variable balues of an option variable

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "denormalized_option_variable_pid": "string",
  • "denormalized_option_variable_name": "string",
  • "translations": { },
  • "pid": "string",
  • "value": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

OptionVariableValue

An OptionVariableValue represents a single value that is selectable within an OptionVariable. An example would be the size XL of the size of a t-shirt.

Get all option variable values

Responses

Response samples

Content type
application/json
{
  • "denormalized_option_variable_pid": "string",
  • "denormalized_option_variable_name": "string",
  • "translations": { },
  • "pid": "string",
  • "value": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get only head data of GET request

Responses

Get a single option variable value

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "denormalized_option_variable_pid": "string",
  • "denormalized_option_variable_name": "string",
  • "translations": { },
  • "pid": "string",
  • "value": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Package

A Package is a kind of Ticket that itself contains multiple other Tickets. For example, a multi-day pass could be a Package, containing a Ticket for each single Show. Or a family pass could be a Package, containing a Ticket for each family member. Packages are powerful, but also quite complex to set up correctly.

Get all packages

Responses

Response samples

Content type
application/json
{
  • "confirmation": true,
  • "checked_in": "2019-08-24T14:15:22Z",
  • "checked_out": "2019-08-24T14:15:22Z",
  • "seat_string": "string",
  • "is_dispatchable": true,
  • "denormalized_host_pid": "string",
  • "denormalized_host_name": "string",
  • "denormalized_event_pid": "string",
  • "denormalized_event_name": "string",
  • "denormalized_show_pid": "string",
  • "denormalized_show_start": "2019-08-24T14:15:22Z",
  • "denormalized_venue_pid": "string",
  • "denormalized_venue_name": "string",
  • "denormalized_sector_pid": "string",
  • "denormalized_sector_name": "string",
  • "denormalized_price_pid": "string",
  • "denormalized_price_name": "string",
  • "denormalized_vat_pid": "string",
  • "denormalized_vat_rate": "string",
  • "denormalized_vat_included": "string",
  • "denormalized_price_including_vat": "string",
  • "denormalized_price_excluding_vat": "string",
  • "denormalized_vat_amount": "string",
  • "denormalized_currency_pid": "string",
  • "denormalized_price_category_pid": "string",
  • "pid": "string",
  • "issue_ticket": true,
  • "count_capacity": true,
  • "code": "string",
  • "confirmed": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "released_seat": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Create one or multiple packages

Request Body schema: application/json
booking
required
string

Public identifier (pid) of a booking

show
required
string

Public identifier (pid) of a show

code
string

Code to be used as ticket qr code

confirmation
boolean

Set true to confirm a ticket. A ticket must have an already confirmed booking to be confirmed.

package
string

Public identifier (pid) of a package

price
string

Public identifier (pid) of a price

sales_quota
string

Public identifier (pid) of a salesquota

sales_quota_set
string

Public identifier (pid) of a salesquota set

seat
string

Public identifier (pid) of a seat

sector
string

Public identifier (pid) of a sector

ticket_options
Array of strings

A list of public identifiers (pids) of ticket options

Responses

Request samples

Content type
application/json
{
  • "booking": "string",
  • "show": "string",
  • "code": "string",
  • "confirmation": true,
  • "package": "string",
  • "price": "string",
  • "sales_quota_set": "string",
  • "sales_quota": "string",
  • "seat": "string",
  • "sector": "string",
  • "ticket_options": [
    ]
}

Get only head data of GET request

Responses

Update one or multiple packages

Request Body schema: application/json
booking
required
string

Public identifier (pid) of a booking

show
required
string

Public identifier (pid) of a show

code
string

Code to be used as ticket qr code

confirmation
boolean

Set true to confirm a ticket. A ticket must have an already confirmed booking to be confirmed.

package
string

Public identifier (pid) of a package

price
string

Public identifier (pid) of a price

sales_quota
string

Public identifier (pid) of a salesquota

sales_quota_set
string

Public identifier (pid) of a salesquota set

seat
string

Public identifier (pid) of a seat

sector
string

Public identifier (pid) of a sector

ticket_options
Array of strings

A list of public identifiers (pids) of ticket options

Responses

Request samples

Content type
application/json
{
  • "booking": "string",
  • "show": "string",
  • "code": "string",
  • "confirmation": true,
  • "package": "string",
  • "price": "string",
  • "sales_quota_set": "string",
  • "sales_quota": "string",
  • "seat": "string",
  • "sector": "string",
  • "ticket_options": [
    ]
}

Get a single package

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "confirmation": true,
  • "checked_in": "2019-08-24T14:15:22Z",
  • "checked_out": "2019-08-24T14:15:22Z",
  • "seat_string": "string",
  • "is_dispatchable": true,
  • "denormalized_host_pid": "string",
  • "denormalized_host_name": "string",
  • "denormalized_event_pid": "string",
  • "denormalized_event_name": "string",
  • "denormalized_show_pid": "string",
  • "denormalized_show_start": "2019-08-24T14:15:22Z",
  • "denormalized_venue_pid": "string",
  • "denormalized_venue_name": "string",
  • "denormalized_sector_pid": "string",
  • "denormalized_sector_name": "string",
  • "denormalized_price_pid": "string",
  • "denormalized_price_name": "string",
  • "denormalized_vat_pid": "string",
  • "denormalized_vat_rate": "string",
  • "denormalized_vat_included": "string",
  • "denormalized_price_including_vat": "string",
  • "denormalized_price_excluding_vat": "string",
  • "denormalized_vat_amount": "string",
  • "denormalized_currency_pid": "string",
  • "denormalized_price_category_pid": "string",
  • "pid": "string",
  • "issue_ticket": true,
  • "count_capacity": true,
  • "code": "string",
  • "confirmed": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "released_seat": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Delete a package

path Parameters
pid
required
string

Responses

Update a single package

path Parameters
pid
required
string
Request Body schema: application/json
booking
required
string

Public identifier (pid) of a booking

show
required
string

Public identifier (pid) of a show

code
string

Code to be used as ticket qr code

confirmation
boolean

Set true to confirm a ticket. A ticket must have an already confirmed booking to be confirmed.

package
string

Public identifier (pid) of a package

price
string

Public identifier (pid) of a price

sales_quota
string

Public identifier (pid) of a salesquota

sales_quota_set
string

Public identifier (pid) of a salesquota set

seat
string

Public identifier (pid) of a seat

sector
string

Public identifier (pid) of a sector

ticket_options
Array of strings

A list of public identifiers (pids) of ticket options

Responses

Request samples

Content type
application/json
{
  • "booking": "string",
  • "show": "string",
  • "code": "string",
  • "confirmation": true,
  • "package": "string",
  • "price": "string",
  • "sales_quota_set": "string",
  • "sales_quota": "string",
  • "seat": "string",
  • "sector": "string",
  • "ticket_options": [
    ]
}

Get the tickets of a package

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "_links": {
    },
  • "discr": "ticket"
}

Get the booking of a package

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid_readable": "string",
  • "confirmation": true,
  • "delivery_method": "string",
  • "tickets_breakdown": { },
  • "pay_before_dispatch": true,
  • "is_dispatchable": true,
  • "urls": { },
  • "invoice_urls": { },
  • "denormalized_customer_pid": "string",
  • "denormalized_customer_fullname": "string",
  • "denormalized_customer_name_and_city": "string",
  • "denormalized_customer_country": "string",
  • "pid": 0,
  • "destination_country": "string",
  • "affiliate_id": "string",
  • "origin": "string",
  • "user_agent": "string",
  • "remote_address": "string",
  • "from_embed": true,
  • "source": "string",
  • "embed_session_id": "string",
  • "tos": true,
  • "digital_dispatch": true,
  • "delivery": true,
  • "will_call": true,
  • "deleted_by_customer": true,
  • "pos": true,
  • "internal_notes": "string",
  • "external_notes": "string",
  • "invoice_address": "string",
  • "checkbox_values": [
    ],
  • "payment_status_code": 0,
  • "first_full_payment": "2019-08-24T14:15:22Z",
  • "due_date": "2019-08-24T14:15:22Z",
  • "send_reminders": true,
  • "delete_if_unpaid": true,
  • "reminded_that_unpaid_at": "2019-08-24T14:15:22Z",
  • "next_reminder": "2019-08-24T14:15:22Z",
  • "refund_bank_account": "string",
  • "refund_bank_account_owner": "string",
  • "refund_bank_account_city": "string",
  • "approved": "2019-08-24T14:15:22Z",
  • "rejected": "2019-08-24T14:15:22Z",
  • "approval_requested": true,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": null,
  • "_links": {
    }
}

Get the show of a package

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "access_role": "string",
  • "beacon_data": { },
  • "translations": { },
  • "pid": "string",
  • "performer": "string",
  • "ticketdescription": "string",
  • "description": "string",
  • "subtitle": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "end_check_in": "2019-08-24T14:15:22Z",
  • "start_public_sales": "2019-08-24T14:15:22Z",
  • "end_sales": "2019-08-24T14:15:22Z",
  • "end_sales_alternative": "string",
  • "dooropening": "2019-08-24T14:15:22Z",
  • "specific_capacity": 1,
  • "allow_sales_while_current": false,
  • "allow_single_empty_seats": true,
  • "always_display_start_time": false,
  • "reservation_info": "string",
  • "request_ratings": false,
  • "order": 0,
  • "is_cancelled": true,
  • "will_be_postponed": true,
  • "is_online_show": true,
  • "online_show": {
    },
  • "tickets_per_booking": 1,
  • "enable_passbook_tickets": true,
  • "access_by": "string",
  • "ratings_requested": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the sector of a package

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "access_role": "string",
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "description": "string",
  • "capacity": 1,
  • "price_category": {
    },
  • "order": 0,
  • "seating_chart_area": 1,
  • "chart_sector_id": "string",
  • "seat_string_template": "string",
  • "access_by": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the seat of a package

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "access_role": "string",
  • "translations": { },
  • "pid": "string",
  • "label": "string",
  • "chart_seat_id": "string",
  • "price_category": {
    },
  • "seat_string_template": "string",
  • "capacity_count": 0,
  • "access_by": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the emails of a package

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "receiver_email": "string",
  • "from_email": "string",
  • "from_name": "string",
  • "reply_to_email": "string",
  • "reply_to_name": "string",
  • "subject": "string",
  • "text": "string",
  • "text_moved_to_storage": false,
  • "html": "string",
  • "html_moved_to_storage": false,
  • "attachments": [ ],
  • "sent": "2019-08-24T14:15:22Z",
  • "failed": "2019-08-24T14:15:22Z",
  • "failed_type": "string",
  • "opened": "2019-08-24T14:15:22Z",
  • "bounced": "2019-08-24T14:15:22Z",
  • "bounced_type": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the access checks of a package

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "direction": "string",
  • "origin": "string",
  • "device_identifier": "string",
  • "checked": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the annotation values of a package

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "value": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

PackagePrice

A PackagePrice is a kind of Price that only applies to a Package.

Get all package prices

Responses

Response samples

Content type
application/json
{
  • "access_role": "string",
  • "price_excluding_vat": 0,
  • "price_including_vat": 0,
  • "vat_amount": 0,
  • "vat_rate": 0,
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "description": "string",
  • "order": 0,
  • "limitation": 1,
  • "set": {
    },
  • "booking_limitation_set": {
    },
  • "interval": 1,
  • "min_per_booking": 0,
  • "max_per_booking": 0,
  • "min_per_package": 0,
  • "max_per_package": 0,
  • "refine_info": "string",
  • "count_capacity": true,
  • "issue_ticket": true,
  • "mutually_require_attributes": false,
  • "access_by": "string",
  • "available_from": "2019-08-24T14:15:22Z",
  • "available_to": "2019-08-24T14:15:22Z",
  • "approval_needed": true,
  • "expect_check_in": true,
  • "verification_info": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "notify_on_new_booking": false,
  • "notification_email": "string",
  • "price": "string",
  • "package_size": 0,
  • "count_filler_tickets": true,
  • "_links": {
    }
}

Create one or multiple package prices

Request Body schema: application/json
name
required
string

Name

price
required
any

Price

price_category
required
number
Enum: 1 2 3 4 5 6 7 8

Public identifier (pid) of a price category

access_by
string
Value: "host"

Who may see this price. Set to null for public.

annotations
Array of strings

Annotations available on this price

approval_needed
boolean

Flag whether bookings with this price require approval by the host. Defaults to false.

available_from
string <date-time>

From when this price should be publicly available. Only applies if accessBy=null. Set to null if not limited to a date.

available_to
string <date-time>

Until when this price should be publicly available. Only applies if accessBy=null. Set to null if not limited to a date.

count_capacity
boolean

Flag whether tickets with this price should count towards show capacity. Defaults to true.

BooleanType (object)

Flag whether filler tickets should count towards booked capacity. Defaults to true.

coupon_groups
Array of strings

Coupon groups from which coupons can be applied to this price

depends_on_prices
Array of strings

Prices of which one must be available in a booking in order to book a ticket of this price

description
string

Additional description

event
string

Public identifier (pid) of an event

expect_check_in
boolean

Flag whether a ticket of this price should count towards the expected number of checkins at access control. Defaults to true.

interval
integer

Interval for quantities in which tickets with this price may be booked

issue_ticket
boolean

Flag whether tickets booked of this price will actually receive a ticket. Defaults to true.

limitation
integer

Available number of tickets with this price

max_per_booking
integer

Maximal quantity of tickets with this price per booking

max_per_package
integer

Maximal quantity of tickets with this price per package

min_per_booking
integer

Minimal quantity of tickets with this price per booking

min_per_package
integer

Minimal quantity of tickets with this price per package

mutually_require_attributes
boolean

Flag to define whether validations for annotations and ticket options within packages should be triggered only if one of them has a value. Defaults to false.

notification_email
string

Email address to receive notifications about new bookings, if activated

notify_on_new_booking
boolean

Flag whether the host shall be notified on new bookings. Defaults to false.

order
integer

Order index in lists (lowest to highest)

package_price
string

Public identifier (pid) of a package price

package_size
integer

The maximum number of tickets within the package. Defaults to unlimited.

price_booking_limitation_set
string

Public identifier (pid) of a price booking limitation set

price_set
string

Public identifier (pid) of a price set

refine_info
string

Additional refine information text

required_in_package
boolean

Flag whether a ticket of this price must be included within a package. If false, it is optional.

sector_to_be_booked
string

Public identifier (pid) of a Sector

show
string

Public identifier (pid) of a show

ticket_options
Array of strings

Ticket options available for this price

vat
string

Public identifier (pid) of vat

verification_info
string

Verification information to pop up at access control (e.g. "Check ID" on children prices)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "price": null,
  • "price_category": 1,
  • "access_by": "host",
  • "available_from": "2019-08-24T14:15:22Z",
  • "available_to": "2019-08-24T14:15:22Z",
  • "annotations": [
    ],
  • "approval_needed": true,
  • "count_capacity": true,
  • "coupon_groups": [
    ],
  • "depends_on_prices": [
    ],
  • "description": "string",
  • "event": "string",
  • "expect_check_in": true,
  • "interval": 0,
  • "issue_ticket": true,
  • "limitation": 0,
  • "max_per_booking": 0,
  • "min_per_booking": 0,
  • "min_per_package": 0,
  • "max_per_package": 0,
  • "mutually_require_attributes": true,
  • "order": 0,
  • "package_price": "string",
  • "sector_to_be_booked": "string",
  • "price_booking_limitation_set": "string",
  • "price_set": "string",
  • "refine_info": "string",
  • "required_in_package": true,
  • "show": "string",
  • "ticket_options": [
    ],
  • "vat": "string",
  • "verification_info": "string",
  • "notification_email": "string",
  • "notify_on_new_booking": true,
  • "package_size": 0,
  • "count_filler_tickets": {
    }
}

Get only head data of GET request

Responses

Update one or multiple package prices

Request Body schema: application/json
name
required
string

Name

price
required
any

Price

price_category
required
number
Enum: 1 2 3 4 5 6 7 8

Public identifier (pid) of a price category

access_by
string
Value: "host"

Who may see this price. Set to null for public.

annotations
Array of strings

Annotations available on this price

approval_needed
boolean

Flag whether bookings with this price require approval by the host. Defaults to false.

available_from
string <date-time>

From when this price should be publicly available. Only applies if accessBy=null. Set to null if not limited to a date.

available_to
string <date-time>

Until when this price should be publicly available. Only applies if accessBy=null. Set to null if not limited to a date.

count_capacity
boolean

Flag whether tickets with this price should count towards show capacity. Defaults to true.

BooleanType (object)

Flag whether filler tickets should count towards booked capacity. Defaults to true.

coupon_groups
Array of strings

Coupon groups from which coupons can be applied to this price

depends_on_prices
Array of strings

Prices of which one must be available in a booking in order to book a ticket of this price

description
string

Additional description

event
string

Public identifier (pid) of an event

expect_check_in
boolean

Flag whether a ticket of this price should count towards the expected number of checkins at access control. Defaults to true.

interval
integer

Interval for quantities in which tickets with this price may be booked

issue_ticket
boolean

Flag whether tickets booked of this price will actually receive a ticket. Defaults to true.

limitation
integer

Available number of tickets with this price

max_per_booking
integer

Maximal quantity of tickets with this price per booking

max_per_package
integer

Maximal quantity of tickets with this price per package

min_per_booking
integer

Minimal quantity of tickets with this price per booking

min_per_package
integer

Minimal quantity of tickets with this price per package

mutually_require_attributes
boolean

Flag to define whether validations for annotations and ticket options within packages should be triggered only if one of them has a value. Defaults to false.

notification_email
string

Email address to receive notifications about new bookings, if activated

notify_on_new_booking
boolean

Flag whether the host shall be notified on new bookings. Defaults to false.

order
integer

Order index in lists (lowest to highest)

package_price
string

Public identifier (pid) of a package price

package_size
integer

The maximum number of tickets within the package. Defaults to unlimited.

price_booking_limitation_set
string

Public identifier (pid) of a price booking limitation set

price_set
string

Public identifier (pid) of a price set

refine_info
string

Additional refine information text

required_in_package
boolean

Flag whether a ticket of this price must be included within a package. If false, it is optional.

sector_to_be_booked
string

Public identifier (pid) of a Sector

show
string

Public identifier (pid) of a show

ticket_options
Array of strings

Ticket options available for this price

vat
string

Public identifier (pid) of vat

verification_info
string

Verification information to pop up at access control (e.g. "Check ID" on children prices)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "price": null,
  • "price_category": 1,
  • "access_by": "host",
  • "available_from": "2019-08-24T14:15:22Z",
  • "available_to": "2019-08-24T14:15:22Z",
  • "annotations": [
    ],
  • "approval_needed": true,
  • "count_capacity": true,
  • "coupon_groups": [
    ],
  • "depends_on_prices": [
    ],
  • "description": "string",
  • "event": "string",
  • "expect_check_in": true,
  • "interval": 0,
  • "issue_ticket": true,
  • "limitation": 0,
  • "max_per_booking": 0,
  • "min_per_booking": 0,
  • "min_per_package": 0,
  • "max_per_package": 0,
  • "mutually_require_attributes": true,
  • "order": 0,
  • "package_price": "string",
  • "sector_to_be_booked": "string",
  • "price_booking_limitation_set": "string",
  • "price_set": "string",
  • "refine_info": "string",
  • "required_in_package": true,
  • "show": "string",
  • "ticket_options": [
    ],
  • "vat": "string",
  • "verification_info": "string",
  • "notification_email": "string",
  • "notify_on_new_booking": true,
  • "package_size": 0,
  • "count_filler_tickets": {
    }
}

Get a single package price

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "access_role": "string",
  • "price_excluding_vat": 0,
  • "price_including_vat": 0,
  • "vat_amount": 0,
  • "vat_rate": 0,
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "description": "string",
  • "order": 0,
  • "limitation": 1,
  • "set": {
    },
  • "booking_limitation_set": {
    },
  • "interval": 1,
  • "min_per_booking": 0,
  • "max_per_booking": 0,
  • "min_per_package": 0,
  • "max_per_package": 0,
  • "refine_info": "string",
  • "count_capacity": true,
  • "issue_ticket": true,
  • "mutually_require_attributes": false,
  • "access_by": "string",
  • "available_from": "2019-08-24T14:15:22Z",
  • "available_to": "2019-08-24T14:15:22Z",
  • "approval_needed": true,
  • "expect_check_in": true,
  • "verification_info": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "notify_on_new_booking": false,
  • "notification_email": "string",
  • "price": "string",
  • "package_size": 0,
  • "count_filler_tickets": true,
  • "_links": {
    }
}

Delete a package price

path Parameters
pid
required
string

Responses

Update a package price

path Parameters
pid
required
string
Request Body schema: application/json
name
required
string

Name

price
required
any

Price

price_category
required
number
Enum: 1 2 3 4 5 6 7 8

Public identifier (pid) of a price category

access_by
string
Value: "host"

Who may see this price. Set to null for public.

annotations
Array of strings

Annotations available on this price

approval_needed
boolean

Flag whether bookings with this price require approval by the host. Defaults to false.

available_from
string <date-time>

From when this price should be publicly available. Only applies if accessBy=null. Set to null if not limited to a date.

available_to
string <date-time>

Until when this price should be publicly available. Only applies if accessBy=null. Set to null if not limited to a date.

count_capacity
boolean

Flag whether tickets with this price should count towards show capacity. Defaults to true.

BooleanType (object)

Flag whether filler tickets should count towards booked capacity. Defaults to true.

coupon_groups
Array of strings

Coupon groups from which coupons can be applied to this price

depends_on_prices
Array of strings

Prices of which one must be available in a booking in order to book a ticket of this price

description
string

Additional description

event
string

Public identifier (pid) of an event

expect_check_in
boolean

Flag whether a ticket of this price should count towards the expected number of checkins at access control. Defaults to true.

interval
integer

Interval for quantities in which tickets with this price may be booked

issue_ticket
boolean

Flag whether tickets booked of this price will actually receive a ticket. Defaults to true.

limitation
integer

Available number of tickets with this price

max_per_booking
integer

Maximal quantity of tickets with this price per booking

max_per_package
integer

Maximal quantity of tickets with this price per package

min_per_booking
integer

Minimal quantity of tickets with this price per booking

min_per_package
integer

Minimal quantity of tickets with this price per package

mutually_require_attributes
boolean

Flag to define whether validations for annotations and ticket options within packages should be triggered only if one of them has a value. Defaults to false.

notification_email
string

Email address to receive notifications about new bookings, if activated

notify_on_new_booking
boolean

Flag whether the host shall be notified on new bookings. Defaults to false.

order
integer

Order index in lists (lowest to highest)

package_price
string

Public identifier (pid) of a package price

package_size
integer

The maximum number of tickets within the package. Defaults to unlimited.

price_booking_limitation_set
string

Public identifier (pid) of a price booking limitation set

price_set
string

Public identifier (pid) of a price set

refine_info
string

Additional refine information text

required_in_package
boolean

Flag whether a ticket of this price must be included within a package. If false, it is optional.

sector_to_be_booked
string

Public identifier (pid) of a Sector

show
string

Public identifier (pid) of a show

ticket_options
Array of strings

Ticket options available for this price

vat
string

Public identifier (pid) of vat

verification_info
string

Verification information to pop up at access control (e.g. "Check ID" on children prices)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "price": null,
  • "price_category": 1,
  • "access_by": "host",
  • "available_from": "2019-08-24T14:15:22Z",
  • "available_to": "2019-08-24T14:15:22Z",
  • "annotations": [
    ],
  • "approval_needed": true,
  • "count_capacity": true,
  • "coupon_groups": [
    ],
  • "depends_on_prices": [
    ],
  • "description": "string",
  • "event": "string",
  • "expect_check_in": true,
  • "interval": 0,
  • "issue_ticket": true,
  • "limitation": 0,
  • "max_per_booking": 0,
  • "min_per_booking": 0,
  • "min_per_package": 0,
  • "max_per_package": 0,
  • "mutually_require_attributes": true,
  • "order": 0,
  • "package_price": "string",
  • "sector_to_be_booked": "string",
  • "price_booking_limitation_set": "string",
  • "price_set": "string",
  • "refine_info": "string",
  • "required_in_package": true,
  • "show": "string",
  • "ticket_options": [
    ],
  • "vat": "string",
  • "verification_info": "string",
  • "notification_email": "string",
  • "notify_on_new_booking": true,
  • "package_size": 0,
  • "count_filler_tickets": {
    }
}

Get the event of a package price

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "timespan": { },
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "performer": "string",
  • "ticketdescription": "string",
  • "description": "string",
  • "delivery_info": "string",
  • "confirmation_extras_template": "string",
  • "will_call_label": "string",
  • "pay_before_dispatch": false,
  • "immediate_payment_only": false,
  • "send_reminders": true,
  • "delete_unpaid_bookings_mode": "never",
  • "allow_digital_dispatch": true,
  • "allow_deliveries": false,
  • "allow_will_call": false,
  • "issue_tickets": true,
  • "enable_passbook_tickets": true,
  • "require_customer_company": false,
  • "require_customer_address": true,
  • "require_customer_phone": false,
  • "prompt_customer_position": false,
  • "prompt_customer_department": false,
  • "prompt_customer_title": false,
  • "prompt_customer_birthday": false,
  • "allow_customer_notes": false,
  • "allow_invoice_address": false,
  • "allow_single_empty_seats": true,
  • "is_hidden": false,
  • "excluded_from_revenue_stats": false,
  • "tickets_per_booking": 1,
  • "tickets_in_listings": 1,
  • "refine_info": "string",
  • "reservation_info": "string",
  • "sales_point_info": "string",
  • "support_info": "string",
  • "payout_interval": "string",
  • "payout_interval_specification": "string",
  • "is_cancelled": true,
  • "will_be_postponed": true,
  • "cancellation_info": "string",
  • "invoice_address": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "notify_on_new_booking": false,
  • "notification_email": "string",
  • "fee_percentage": "string",
  • "fee_minimal_commission": "string",
  • "fee_free_ticket_commission": "string",
  • "fee_included_free_tickets_percentage": 100,
  • "fee_payment_base_commission": "string",
  • "fee_payment_percentage": "string",
  • "_links": {
    }
}

Get the show of a package price

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "access_role": "string",
  • "beacon_data": { },
  • "translations": { },
  • "pid": "string",
  • "performer": "string",
  • "ticketdescription": "string",
  • "description": "string",
  • "subtitle": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "end_check_in": "2019-08-24T14:15:22Z",
  • "start_public_sales": "2019-08-24T14:15:22Z",
  • "end_sales": "2019-08-24T14:15:22Z",
  • "end_sales_alternative": "string",
  • "dooropening": "2019-08-24T14:15:22Z",
  • "specific_capacity": 1,
  • "allow_sales_while_current": false,
  • "allow_single_empty_seats": true,
  • "always_display_start_time": false,
  • "reservation_info": "string",
  • "request_ratings": false,
  • "order": 0,
  • "is_cancelled": true,
  • "will_be_postponed": true,
  • "is_online_show": true,
  • "online_show": {
    },
  • "tickets_per_booking": 1,
  • "enable_passbook_tickets": true,
  • "access_by": "string",
  • "ratings_requested": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the currency of a package price

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "round_to_cents": 0,
  • "_links": {
    }
}

Get the price category of a package price

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the vat of a package price

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "country": "string",
  • "rate": "string",
  • "included": false,
  • "default_for_country": false,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the ticket option exclusions of a package prices

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the ticket option sets of a package price

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "pid": "string",
  • "min": 1,
  • "max": 1,
  • "error_message_min": "string",
  • "error_message_max": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "batch_id": "string",
  • "batch_order": 0,
  • "_links": {
    }
}

Get the prices of a package prices

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "_links": {
    },
  • "discr": "price"
}

Payment

A Payment. Buyer send money, we give ticket.

Get all payments

Responses

Response samples

Content type
application/json
{
  • "confirmation": true,
  • "payment_date": "2019-08-24T14:15:22Z",
  • "pid": "string",
  • "amount": "string",
  • "fee": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Create one or multiple payments

Request Body schema: application/json
amount
required
string

The paid amount

booking
required
string

Public identifier (pid) of a booking

currency
required
string
Enum: "CHF" "EUR" "USD"

Public identifier (pid) of a currency

payment_date
required
string <date>

Date of payment

payment_method
required
string
Enum: "cash" "coupon" "transfer"

Public identifier (pid) of a payment method

box_office
string

Public identifier (pid) of a box office

confirmation
boolean

Set true to confirm a payment.

coupon
string

Public identifier (pid) of a coupon

description
string

Description of a payment which is not connected to a booking

event
string

Public identifier (pid) of an event, for a payment which is not connected to a booking

host
string

Public identifier (pid) of a host

sales_point
string

Public identifier (pid) of a sales point

Responses

Request samples

Content type
application/json
{
  • "amount": "string",
  • "booking": "string",
  • "currency": "CHF",
  • "payment_date": "2019-08-24",
  • "payment_method": "cash",
  • "box_office": "string",
  • "confirmation": true,
  • "coupon": "string",
  • "description": "string",
  • "event": "string",
  • "host": "string",
  • "sales_point": "string"
}

Get only head data of GET request

Responses

Update one or multiple payments

Request Body schema: application/json
amount
required
string

The paid amount

booking
required
string

Public identifier (pid) of a booking

currency
required
string
Enum: "CHF" "EUR" "USD"

Public identifier (pid) of a currency

payment_date
required
string <date>

Date of payment

payment_method
required
string
Enum: "cash" "coupon" "transfer"

Public identifier (pid) of a payment method

box_office
string

Public identifier (pid) of a box office

confirmation
boolean

Set true to confirm a payment.

coupon
string

Public identifier (pid) of a coupon

description
string

Description of a payment which is not connected to a booking

event
string

Public identifier (pid) of an event, for a payment which is not connected to a booking

host
string

Public identifier (pid) of a host

sales_point
string

Public identifier (pid) of a sales point

Responses

Request samples

Content type
application/json
{
  • "amount": "string",
  • "booking": "string",
  • "currency": "CHF",
  • "payment_date": "2019-08-24",
  • "payment_method": "cash",
  • "box_office": "string",
  • "confirmation": true,
  • "coupon": "string",
  • "description": "string",
  • "event": "string",
  • "host": "string",
  • "sales_point": "string"
}

Get a single payment

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "confirmation": true,
  • "payment_date": "2019-08-24T14:15:22Z",
  • "pid": "string",
  • "amount": "string",
  • "fee": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Delete a payment

path Parameters
pid
required
string

Responses

Update a payment

path Parameters
pid
required
string
Request Body schema: application/json
amount
required
string

The paid amount

booking
required
string

Public identifier (pid) of a booking

currency
required
string
Enum: "CHF" "EUR" "USD"

Public identifier (pid) of a currency

payment_date
required
string <date>

Date of payment

payment_method
required
string
Enum: "cash" "coupon" "transfer"

Public identifier (pid) of a payment method

box_office
string

Public identifier (pid) of a box office

confirmation
boolean

Set true to confirm a payment.

coupon
string

Public identifier (pid) of a coupon

description
string

Description of a payment which is not connected to a booking

event
string

Public identifier (pid) of an event, for a payment which is not connected to a booking

host
string

Public identifier (pid) of a host

sales_point
string

Public identifier (pid) of a sales point

Responses

Request samples

Content type
application/json
{
  • "amount": "string",
  • "booking": "string",
  • "currency": "CHF",
  • "payment_date": "2019-08-24",
  • "payment_method": "cash",
  • "box_office": "string",
  • "confirmation": true,
  • "coupon": "string",
  • "description": "string",
  • "event": "string",
  • "host": "string",
  • "sales_point": "string"
}

Get the booking of a payment

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid_readable": "string",
  • "confirmation": true,
  • "delivery_method": "string",
  • "tickets_breakdown": { },
  • "pay_before_dispatch": true,
  • "is_dispatchable": true,
  • "urls": { },
  • "invoice_urls": { },
  • "denormalized_customer_pid": "string",
  • "denormalized_customer_fullname": "string",
  • "denormalized_customer_name_and_city": "string",
  • "denormalized_customer_country": "string",
  • "pid": 0,
  • "destination_country": "string",
  • "affiliate_id": "string",
  • "origin": "string",
  • "user_agent": "string",
  • "remote_address": "string",
  • "from_embed": true,
  • "source": "string",
  • "embed_session_id": "string",
  • "tos": true,
  • "digital_dispatch": true,
  • "delivery": true,
  • "will_call": true,
  • "deleted_by_customer": true,
  • "pos": true,
  • "internal_notes": "string",
  • "external_notes": "string",
  • "invoice_address": "string",
  • "checkbox_values": [
    ],
  • "payment_status_code": 0,
  • "first_full_payment": "2019-08-24T14:15:22Z",
  • "due_date": "2019-08-24T14:15:22Z",
  • "send_reminders": true,
  • "delete_if_unpaid": true,
  • "reminded_that_unpaid_at": "2019-08-24T14:15:22Z",
  • "next_reminder": "2019-08-24T14:15:22Z",
  • "refund_bank_account": "string",
  • "refund_bank_account_owner": "string",
  • "refund_bank_account_city": "string",
  • "approved": "2019-08-24T14:15:22Z",
  • "rejected": "2019-08-24T14:15:22Z",
  • "approval_requested": true,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": null,
  • "_links": {
    }
}

Get the currency of a payment

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "round_to_cents": 0,
  • "_links": {
    }
}

Get the payment method of a payment

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "name": "string",
  • "handling_period": 0,
  • "psp": "string",
  • "type": "string",
  • "_links": {
    }
}

Get the bank account method of a payment

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "iban": "string",
  • "qr_iban": "string",
  • "account": "string",
  • "ezs_account": "string",
  • "ezs_customer_identification": "string",
  • "bc": "strin",
  • "bic": "string",
  • "bank": "string",
  • "address1": "string",
  • "address2": "string",
  • "zip": "string",
  • "city": "string",
  • "country": "string",
  • "debit_account": 0,
  • "credit_account": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the coupon of a payment

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "_links": {
    },
  • "discr": "coupon"
}

PaymentMethod

A PaymentMethod stands for the payment means that was used to make a Payment. Like a credit card, or cash.

Get all payment methods

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "name": "string",
  • "handling_period": 0,
  • "psp": "string",
  • "type": "string",
  • "_links": {
    }
}

Get only head data of GET request

Responses

Get a single payment method

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "name": "string",
  • "handling_period": 0,
  • "psp": "string",
  • "type": "string",
  • "_links": {
    }
}

Payout

A Payout represents a single settlement between Ticketpark and a Host. Usually this means we send money ot the Host. Sometimes it becomes an invoice that needs to be paid by the Host.

Get all payouts

Responses

Response samples

Content type
application/json
{
  • "ticketpark_amount": "0",
  • "extra_payments": "0",
  • "ticketpark_total_payments": "0",
  • "tickets_commissions": "0",
  • "ticket_options_commissions": "0",
  • "options_commissions": "0",
  • "delivery_commissions": "0",
  • "booked_items_commission": "0",
  • "payments_commission": "0",
  • "commissions_reimbursements": "0",
  • "extra_charges_amount": "0",
  • "free_tickets_reimbursable": 0,
  • "free_tickets_reimbursements": "0",
  • "costs_amount": "0",
  • "total_amount": "0",
  • "results": { },
  • "pid": "string",
  • "event": {
    },
  • "extra_charges": [
    ],
  • "offsetting_extra_charges": [
    ],
  • "number": 0,
  • "file_pdf": "string",
  • "invoice_number": "string",
  • "payout_payments": [
    ]
}

Get only head data of GET request

Responses

Get a single payouts

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "ticketpark_amount": "0",
  • "extra_payments": "0",
  • "ticketpark_total_payments": "0",
  • "tickets_commissions": "0",
  • "ticket_options_commissions": "0",
  • "options_commissions": "0",
  • "delivery_commissions": "0",
  • "booked_items_commission": "0",
  • "payments_commission": "0",
  • "commissions_reimbursements": "0",
  • "extra_charges_amount": "0",
  • "free_tickets_reimbursable": 0,
  • "free_tickets_reimbursements": "0",
  • "costs_amount": "0",
  • "total_amount": "0",
  • "results": { },
  • "pid": "string",
  • "event": {
    },
  • "extra_charges": [
    ],
  • "offsetting_extra_charges": [
    ],
  • "number": 0,
  • "file_pdf": "string",
  • "invoice_number": "string",
  • "payout_payments": [
    ]
}

Person

A Person represents either a ticket buyer, somebody with a User account, or anybody who was added in the crm module by the Host.

Get all persons

Responses

Response samples

Content type
application/json
{
  • "address1": "string",
  • "address2": "string",
  • "zip": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "translations": { },
  • "pid": "string",
  • "salutation": "string",
  • "title": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "company": "string",
  • "department": "string",
  • "position": "string",
  • "phone": "string",
  • "phone2": "string",
  • "phone3": "string",
  • "email": "string",
  • "birthday": "2019-08-24T14:15:22Z",
  • "newsletter": true,
  • "mailing": true,
  • "website": "string",
  • "locale": "string",
  • "address": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Create one or multiple persons

Request Body schema: application/json
AddressDataType (object)

Address data

birthday
string <date>

Birthday

company
string

Company

department
string

Department

email
string

Email address

firstname
string

First name

lastname
string

Last name

locale
string

Language code (2-letter, ISO 639-1). Defaults to "de".

mailing
boolean

Flag whether the person wants to receive physical mailings

newsletter
boolean

Flag whether the person wants to receive newsletters

notes
string

Internal notes

person_groups
Array of strings

List of public identifier (pid) of person groups this person belongs to

phone
string

Phone number

phone2
string

Phone number 2

phone3
string

Phone number 3

position
string

Position in company

salutation
string
Enum: "m" "f" "mrs"

Salutation

title
string
Enum: "prof" "prof-dr" "dr"

Title

website
string

Website

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "birthday": "2019-08-24",
  • "company": "string",
  • "department": "string",
  • "email": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "locale": "string",
  • "mailing": true,
  • "newsletter": true,
  • "notes": "string",
  • "phone": "string",
  • "phone2": "string",
  • "phone3": "string",
  • "person_groups": [
    ],
  • "position": "string",
  • "salutation": "m",
  • "title": "prof",
  • "website": "string"
}

Get only head data of GET request

Responses

Update one or multiple persons

Request Body schema: application/json
AddressDataType (object)

Address data

birthday
string <date>

Birthday

company
string

Company

department
string

Department

email
string

Email address

firstname
string

First name

lastname
string

Last name

locale
string

Language code (2-letter, ISO 639-1). Defaults to "de".

mailing
boolean

Flag whether the person wants to receive physical mailings

newsletter
boolean

Flag whether the person wants to receive newsletters

notes
string

Internal notes

person_groups
Array of strings

List of public identifier (pid) of person groups this person belongs to

phone
string

Phone number

phone2
string

Phone number 2

phone3
string

Phone number 3

position
string

Position in company

salutation
string
Enum: "m" "f" "mrs"

Salutation

title
string
Enum: "prof" "prof-dr" "dr"

Title

website
string

Website

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "birthday": "2019-08-24",
  • "company": "string",
  • "department": "string",
  • "email": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "locale": "string",
  • "mailing": true,
  • "newsletter": true,
  • "notes": "string",
  • "phone": "string",
  • "phone2": "string",
  • "phone3": "string",
  • "person_groups": [
    ],
  • "position": "string",
  • "salutation": "m",
  • "title": "prof",
  • "website": "string"
}

Get a single person

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "address1": "string",
  • "address2": "string",
  • "zip": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "translations": { },
  • "pid": "string",
  • "salutation": "string",
  • "title": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "company": "string",
  • "department": "string",
  • "position": "string",
  • "phone": "string",
  • "phone2": "string",
  • "phone3": "string",
  • "email": "string",
  • "birthday": "2019-08-24T14:15:22Z",
  • "newsletter": true,
  • "mailing": true,
  • "website": "string",
  • "locale": "string",
  • "address": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Delete a person

path Parameters
pid
required
string

Responses

Update a single person

path Parameters
pid
required
string
Request Body schema: application/json
AddressDataType (object)

Address data

birthday
string <date>

Birthday

company
string

Company

department
string

Department

email
string

Email address

firstname
string

First name

lastname
string

Last name

locale
string

Language code (2-letter, ISO 639-1). Defaults to "de".

mailing
boolean

Flag whether the person wants to receive physical mailings

newsletter
boolean

Flag whether the person wants to receive newsletters

notes
string

Internal notes

person_groups
Array of strings

List of public identifier (pid) of person groups this person belongs to

phone
string

Phone number

phone2
string

Phone number 2

phone3
string

Phone number 3

position
string

Position in company

salutation
string
Enum: "m" "f" "mrs"

Salutation

title
string
Enum: "prof" "prof-dr" "dr"

Title

website
string

Website

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "birthday": "2019-08-24",
  • "company": "string",
  • "department": "string",
  • "email": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "locale": "string",
  • "mailing": true,
  • "newsletter": true,
  • "notes": "string",
  • "phone": "string",
  • "phone2": "string",
  • "phone3": "string",
  • "person_groups": [
    ],
  • "position": "string",
  • "salutation": "m",
  • "title": "prof",
  • "website": "string"
}

Get the user of a person

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "person": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z"
}

Get the address of a person.

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "address1": "string",
  • "address2": "string",
  • "zip": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the bookings of a person

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid_readable": "string",
  • "confirmation": true,
  • "delivery_method": "string",
  • "tickets_breakdown": { },
  • "pay_before_dispatch": true,
  • "is_dispatchable": true,
  • "urls": { },
  • "invoice_urls": { },
  • "denormalized_customer_pid": "string",
  • "denormalized_customer_fullname": "string",
  • "denormalized_customer_name_and_city": "string",
  • "denormalized_customer_country": "string",
  • "pid": 0,
  • "destination_country": "string",
  • "affiliate_id": "string",
  • "origin": "string",
  • "user_agent": "string",
  • "remote_address": "string",
  • "from_embed": true,
  • "source": "string",
  • "embed_session_id": "string",
  • "tos": true,
  • "digital_dispatch": true,
  • "delivery": true,
  • "will_call": true,
  • "deleted_by_customer": true,
  • "pos": true,
  • "internal_notes": "string",
  • "external_notes": "string",
  • "invoice_address": "string",
  • "checkbox_values": [
    ],
  • "payment_status_code": 0,
  • "first_full_payment": "2019-08-24T14:15:22Z",
  • "due_date": "2019-08-24T14:15:22Z",
  • "send_reminders": true,
  • "delete_if_unpaid": true,
  • "reminded_that_unpaid_at": "2019-08-24T14:15:22Z",
  • "next_reminder": "2019-08-24T14:15:22Z",
  • "refund_bank_account": "string",
  • "refund_bank_account_owner": "string",
  • "refund_bank_account_city": "string",
  • "approved": "2019-08-24T14:15:22Z",
  • "rejected": "2019-08-24T14:15:22Z",
  • "approval_requested": true,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": null,
  • "_links": {
    }
}

Get the received invitations of a person

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "code": "string",
  • "expiration": "2019-08-24T14:15:22Z",
  • "personal": true,
  • "single_use": true,
  • "tickets_max_per_show": 0,
  • "tickets_max_per_event": 0,
  • "tickets_max_total": 0,
  • "tickets_max_per_booking": 0,
  • "max_different_shows": 0,
  • "rsvp": true,
  • "declined_at": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the sent invitations of a person

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "code": "string",
  • "expiration": "2019-08-24T14:15:22Z",
  • "personal": true,
  • "single_use": true,
  • "tickets_max_per_show": 0,
  • "tickets_max_per_event": 0,
  • "tickets_max_total": 0,
  • "tickets_max_per_booking": 0,
  • "max_different_shows": 0,
  • "rsvp": true,
  • "declined_at": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the person groups of a person

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "",
  • "has_badge": true,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "is_archived": true,
  • "_links": {
    }
}

Get the person group field values of a person

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "value": "string",
  • "_links": {
    }
}

Get the relations of a person

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "who": {
    },
  • "how": "string",
  • "to": {
    },
  • "option": {
    },
  • "_links": {
    }
}

PersonGroup

A PersonGroup is a group in the crm module where a Host can organize Persons. Each ticket buyer belongs to at least one PersonGroup.

Get all person groups

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "",
  • "has_badge": true,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "is_archived": true,
  • "_links": {
    }
}

Create one or multiple person groups

Request Body schema: application/json
host
required
string

Public identifier (pid) of a host

name
required
string

name

has_badge
boolean

Flag whether persons in this group may receive a badge

Responses

Request samples

Content type
application/json
{
  • "host": "string",
  • "name": "string",
  • "has_badge": true
}

Update one or multiple person groups

Request Body schema: application/json
host
required
string

Public identifier (pid) of a host

name
required
string

name

has_badge
boolean

Flag whether persons in this group may receive a badge

Responses

Request samples

Content type
application/json
{
  • "host": "string",
  • "name": "string",
  • "has_badge": true
}

Get one person group

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "",
  • "has_badge": true,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "is_archived": true,
  • "_links": {
    }
}

Delete one person group

path Parameters
pid
required
string

Responses

Update one person group

path Parameters
pid
required
string
Request Body schema: application/json
host
required
string

Public identifier (pid) of a host

name
required
string

name

has_badge
boolean

Flag whether persons in this group may receive a badge

Responses

Request samples

Content type
application/json
{
  • "host": "string",
  • "name": "string",
  • "has_badge": true
}

Get the persons of a person group.

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "address1": "string",
  • "address2": "string",
  • "zip": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "translations": { },
  • "pid": "string",
  • "salutation": "string",
  • "title": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "company": "string",
  • "department": "string",
  • "position": "string",
  • "phone": "string",
  • "phone2": "string",
  • "phone3": "string",
  • "email": "string",
  • "birthday": "2019-08-24T14:15:22Z",
  • "newsletter": true,
  • "mailing": true,
  • "website": "string",
  • "locale": "string",
  • "address": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the person relation options of a person group.

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "_links": {
    }
}

Get the person group field definitions of a person group.

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "type": "string",
  • "name": "string",
  • "order": 0,
  • "_links": {
    }
}

PersonGroupFieldDefinition

A PersonGroupFieldDefinition defines a value in the crm module that can be added by the Host to Persons who are member of a specific PersonGroup.

Get all person group field definitions

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "type": "string",
  • "name": "string",
  • "order": 0,
  • "_links": {
    }
}

Create one or multiple person group field definitions

Request Body schema: application/json
attributes
required
Array of strings

Configuration attributes (in JSON format)

name
required
string

Name of the field

person_group
required
string

Public identifier (pid) of a person group

type
required
string
Enum: "text" "text_translatable" "text_area" "text_area_translatable" "number" "file" "image" "single_choice" "single_sub_choice" "multi_choice" "multi_sub_choice" "yes_no"

Type of the field

order
integer

Order index in lists (lowest to highest)

Responses

Request samples

Content type
application/json
{
  • "type": "text",
  • "name": "string",
  • "attributes": [
    ],
  • "order": 0,
  • "person_group": "string"
}

Get only head data of GET request

Responses

Update one or multiple person group field definitions

Request Body schema: application/json
attributes
required
Array of strings

Configuration attributes (in JSON format)

name
required
string

Name of the field

person_group
required
string

Public identifier (pid) of a person group

type
required
string
Enum: "text" "text_translatable" "text_area" "text_area_translatable" "number" "file" "image" "single_choice" "single_sub_choice" "multi_choice" "multi_sub_choice" "yes_no"

Type of the field

order
integer

Order index in lists (lowest to highest)

Responses

Request samples

Content type
application/json
{
  • "type": "text",
  • "name": "string",
  • "attributes": [
    ],
  • "order": 0,
  • "person_group": "string"
}

Get a single person group field definition

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "type": "string",
  • "name": "string",
  • "order": 0,
  • "_links": {
    }
}

Delete a person group field definition

path Parameters
pid
required
string

Responses

Update a single person group field definition

path Parameters
pid
required
string
Request Body schema: application/json
attributes
required
Array of strings

Configuration attributes (in JSON format)

name
required
string

Name of the field

person_group
required
string

Public identifier (pid) of a person group

type
required
string
Enum: "text" "text_translatable" "text_area" "text_area_translatable" "number" "file" "image" "single_choice" "single_sub_choice" "multi_choice" "multi_sub_choice" "yes_no"

Type of the field

order
integer

Order index in lists (lowest to highest)

Responses

Request samples

Content type
application/json
{
  • "type": "text",
  • "name": "string",
  • "attributes": [
    ],
  • "order": 0,
  • "person_group": "string"
}

Get the person group of a person group field definition

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "",
  • "has_badge": true,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "is_archived": true,
  • "_links": {
    }
}

Get the person group field definition options of a person group field definition

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "order": 0,
  • "_links": {
    }
}

Get the person group field values of a person group field definition

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "value": "string",
  • "_links": {
    }
}

PersonGroupFieldDefinitionOption

A PersonGroupFieldDefinitionOption is a single value that can be selected in PersonGroupFieldDefinitions of the type choice.

Get all person group field definition options

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "order": 0,
  • "_links": {
    }
}

Create one or multiple FieldDefinitiperson group field definition optionsonOption

Request Body schema: application/json
name
required
string

Name

person_group_field_definition
required
string

Public identifier (pid) of a person group field definition

order
integer

Order index in lists (lowest to highest)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "order": 0,
  • "person_group_field_definition": "string"
}

Get only head data of GET request

Responses

Update one or multiple person group field definition options

Request Body schema: application/json
name
required
string

Name

person_group_field_definition
required
string

Public identifier (pid) of a person group field definition

order
integer

Order index in lists (lowest to highest)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "order": 0,
  • "person_group_field_definition": "string"
}

Get a single person group field definition option

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "order": 0,
  • "_links": {
    }
}

Delete a person group field definition option

path Parameters
pid
required
string

Responses

Update a single person group field definition option

path Parameters
pid
required
string
Request Body schema: application/json
name
required
string

Name

person_group_field_definition
required
string

Public identifier (pid) of a person group field definition

order
integer

Order index in lists (lowest to highest)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "order": 0,
  • "person_group_field_definition": "string"
}

Get the person group field definition of a person group field definition option

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "type": "string",
  • "name": "string",
  • "order": 0,
  • "_links": {
    }
}

Get the person group field values of a person group field definition option.

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "value": "string",
  • "_links": {
    }
}

PersonGroupFieldValue

A PersonGroupFieldValue holds the actual value that was added for a Person on a specific PersonGroupField.

Get all person group field values

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "value": "string",
  • "_links": {
    }
}

Create one or multiple person group field values

Request Body schema: application/json
person
required
string

Public identifier (pid) of a person

person_group_field_definition
required
string

Public identifier (pid) of a definition

value
required
string

Value

person_group_field_definition_options
Array of strings

Responses

Request samples

Content type
application/json
{
  • "value": "string",
  • "person_group_field_definition_options": [
    ],
  • "person": "string",
  • "person_group_field_definition": "string"
}

Get only head data of GET request

Responses

Update one or multiple person group field values

Request Body schema: application/json
person
required
string

Public identifier (pid) of a person

person_group_field_definition
required
string

Public identifier (pid) of a definition

value
required
string

Value

person_group_field_definition_options
Array of strings

Responses

Request samples

Content type
application/json
{
  • "value": "string",
  • "person_group_field_definition_options": [
    ],
  • "person": "string",
  • "person_group_field_definition": "string"
}

Get a single person group field value

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "value": "string",
  • "_links": {
    }
}

Delete a person group field values

path Parameters
pid
required
string

Responses

Update a single person group field value

path Parameters
pid
required
string
Request Body schema: application/json
person
required
string

Public identifier (pid) of a person

person_group_field_definition
required
string

Public identifier (pid) of a definition

value
required
string

Value

person_group_field_definition_options
Array of strings

Responses

Request samples

Content type
application/json
{
  • "value": "string",
  • "person_group_field_definition_options": [
    ],
  • "person": "string",
  • "person_group_field_definition": "string"
}

Get the person group field definition options of a person group field value

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "order": 0,
  • "_links": {
    }
}

Get the person group field definition of a person group field value

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "type": "string",
  • "name": "string",
  • "order": 0,
  • "_links": {
    }
}

Get the person of a person group field value

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "value": "string",
  • "_links": {
    }
}

PersonRelation

A PersonRelation defines the relation between two Persons within the crm module.

Get all person relations

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "who": {
    },
  • "how": "string",
  • "to": {
    },
  • "option": {
    },
  • "_links": {
    }
}

Create one or multiple person relations

Request Body schema: application/json
how
required
string

Text description of how the persons are related

to
required
string

Public identifier (pid) of a person

who
required
string

Public identifier (pid) of a person

option
string

Public identifier (pid) of a person relation option

Responses

Request samples

Content type
application/json
{
  • "who": "string",
  • "to": "string",
  • "how": "string",
  • "option": "string"
}

Get only head data of GET request

Responses

Update one or multiple person relations

Request Body schema: application/json
how
required
string

Text description of how the persons are related

to
required
string

Public identifier (pid) of a person

who
required
string

Public identifier (pid) of a person

option
string

Public identifier (pid) of a person relation option

Responses

Request samples

Content type
application/json
{
  • "who": "string",
  • "to": "string",
  • "how": "string",
  • "option": "string"
}

Get a single person relation

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "who": {
    },
  • "how": "string",
  • "to": {
    },
  • "option": {
    },
  • "_links": {
    }
}

Delete a person relation

path Parameters
pid
required
string

Responses

Update a single person relation

path Parameters
pid
required
string
Request Body schema: application/json
how
required
string

Text description of how the persons are related

to
required
string

Public identifier (pid) of a person

who
required
string

Public identifier (pid) of a person

option
string

Public identifier (pid) of a person relation option

Responses

Request samples

Content type
application/json
{
  • "who": "string",
  • "to": "string",
  • "how": "string",
  • "option": "string"
}

Get the person relation option of person relation

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "_links": {
    }
}

Get the who relation (person) of person relation

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "address1": "string",
  • "address2": "string",
  • "zip": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "translations": { },
  • "pid": "string",
  • "salutation": "string",
  • "title": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "company": "string",
  • "department": "string",
  • "position": "string",
  • "phone": "string",
  • "phone2": "string",
  • "phone3": "string",
  • "email": "string",
  • "birthday": "2019-08-24T14:15:22Z",
  • "newsletter": true,
  • "mailing": true,
  • "website": "string",
  • "locale": "string",
  • "address": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the to relation (person) of person relation

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "address1": "string",
  • "address2": "string",
  • "zip": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "translations": { },
  • "pid": "string",
  • "salutation": "string",
  • "title": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "company": "string",
  • "department": "string",
  • "position": "string",
  • "phone": "string",
  • "phone2": "string",
  • "phone3": "string",
  • "email": "string",
  • "birthday": "2019-08-24T14:15:22Z",
  • "newsletter": true,
  • "mailing": true,
  • "website": "string",
  • "locale": "string",
  • "address": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

PersonRelationOption

A PersonRelationOption is a selectable value that can be predefined for PersonRelations within a specific PersonGroup.

Get all person relation options

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "_links": {
    }
}

Create one or multiple PersonRelationOption

Request Body schema: application/json
name
required
string

Name of the person relation option

person_group
required
string

Public identifier (pid) of a person group

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "person_group": "string"
}

Update one or multiple person relation options

Responses

Response samples

Content type
application/json
null

Get one person relation option

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "_links": {
    }
}

Delete one person relation option

path Parameters
pid
required
string

Responses

Update one person relation option

path Parameters
pid
required
string
Request Body schema: application/json
name
required
string

Name of the person relation option

person_group
required
string

Public identifier (pid) of a person group

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "person_group": "string"
}

Get the person relations of a person relation option

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "who": {
    },
  • "how": "string",
  • "to": {
    },
  • "option": {
    },
  • "_links": {
    }
}

Get the person group of a person relation option

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "",
  • "has_badge": true,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "is_archived": true,
  • "_links": {
    }
}

Price

A Price is what needs to be paid for a ticket.

Get all prices

Responses

Response samples

Content type
application/json
Example
{
  • "_links": {
    },
  • "discr": "price"
}

Create one or multiple prices

Request Body schema: application/json
name
required
string

Name

price
required
any

Price

price_category
required
number
Enum: 1 2 3 4 5 6 7 8

Public identifier (pid) of a price category

access_by
string
Value: "host"

Who may see this price. Set to null for public.

annotations
Array of strings

Annotations available on this price

approval_needed
boolean

Flag whether bookings with this price require approval by the host. Defaults to false.

available_from
string <date-time>

From when this price should be publicly available. Only applies if accessBy=null. Set to null if not limited to a date.

available_to
string <date-time>

Until when this price should be publicly available. Only applies if accessBy=null. Set to null if not limited to a date.

count_capacity
boolean

Flag whether tickets with this price should count towards show capacity. Defaults to true.

coupon_groups
Array of strings

Coupon groups from which coupons can be applied to this price

depends_on_prices
Array of strings

Prices of which one must be available in a booking in order to book a ticket of this price

description
string

Additional description

event
string

Public identifier (pid) of an event

expect_check_in
boolean

Flag whether a ticket of this price should count towards the expected number of checkins at access control. Defaults to true.

interval
integer

Interval for quantities in which tickets with this price may be booked

issue_ticket
boolean

Flag whether tickets booked of this price will actually receive a ticket. Defaults to true.

limitation
integer

Available number of tickets with this price

max_per_booking
integer

Maximal quantity of tickets with this price per booking

max_per_package
integer

Maximal quantity of tickets with this price per package

min_per_booking
integer

Minimal quantity of tickets with this price per booking

min_per_package
integer

Minimal quantity of tickets with this price per package

mutually_require_attributes
boolean

Flag to define whether validations for annotations and ticket options within packages should be triggered only if one of them has a value. Defaults to false.

notification_email
string

Email address to receive notifications about new bookings, if activated

notify_on_new_booking
boolean

Flag whether the host shall be notified on new bookings. Defaults to false.

order
integer

Order index in lists (lowest to highest)

package_price
string

Public identifier (pid) of a package price

price_booking_limitation_set
string

Public identifier (pid) of a price booking limitation set

price_set
string

Public identifier (pid) of a price set

refine_info
string

Additional refine information text

required_in_package
boolean

Flag whether a ticket of this price must be included within a package. If false, it is optional.

sector_to_be_booked
string

Public identifier (pid) of a Sector

show
string

Public identifier (pid) of a show

ticket_options
Array of strings

Ticket options available for this price

vat
string

Public identifier (pid) of vat

verification_info
string

Verification information to pop up at access control (e.g. "Check ID" on children prices)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "price": null,
  • "price_category": 1,
  • "access_by": "host",
  • "available_from": "2019-08-24T14:15:22Z",
  • "available_to": "2019-08-24T14:15:22Z",
  • "annotations": [
    ],
  • "approval_needed": true,
  • "count_capacity": true,
  • "coupon_groups": [
    ],
  • "depends_on_prices": [
    ],
  • "description": "string",
  • "event": "string",
  • "expect_check_in": true,
  • "interval": 0,
  • "issue_ticket": true,
  • "limitation": 0,
  • "max_per_booking": 0,
  • "min_per_booking": 0,
  • "min_per_package": 0,
  • "max_per_package": 0,
  • "mutually_require_attributes": true,
  • "order": 0,
  • "package_price": "string",
  • "sector_to_be_booked": "string",
  • "price_booking_limitation_set": "string",
  • "price_set": "string",
  • "refine_info": "string",
  • "required_in_package": true,
  • "show": "string",
  • "ticket_options": [
    ],
  • "vat": "string",
  • "verification_info": "string",
  • "notification_email": "string",
  • "notify_on_new_booking": true
}

Get only head data of GET request

Responses

Update one or multiple prices

Request Body schema: application/json
name
required
string

Name

price
required
any

Price

price_category
required
number
Enum: 1 2 3 4 5 6 7 8

Public identifier (pid) of a price category

access_by
string
Value: "host"

Who may see this price. Set to null for public.

annotations
Array of strings

Annotations available on this price

approval_needed
boolean

Flag whether bookings with this price require approval by the host. Defaults to false.

available_from
string <date-time>

From when this price should be publicly available. Only applies if accessBy=null. Set to null if not limited to a date.

available_to
string <date-time>

Until when this price should be publicly available. Only applies if accessBy=null. Set to null if not limited to a date.

count_capacity
boolean

Flag whether tickets with this price should count towards show capacity. Defaults to true.

coupon_groups
Array of strings

Coupon groups from which coupons can be applied to this price

depends_on_prices
Array of strings

Prices of which one must be available in a booking in order to book a ticket of this price

description
string

Additional description

event
string

Public identifier (pid) of an event

expect_check_in
boolean

Flag whether a ticket of this price should count towards the expected number of checkins at access control. Defaults to true.

interval
integer

Interval for quantities in which tickets with this price may be booked

issue_ticket
boolean

Flag whether tickets booked of this price will actually receive a ticket. Defaults to true.

limitation
integer

Available number of tickets with this price

max_per_booking
integer

Maximal quantity of tickets with this price per booking

max_per_package
integer

Maximal quantity of tickets with this price per package

min_per_booking
integer

Minimal quantity of tickets with this price per booking

min_per_package
integer

Minimal quantity of tickets with this price per package

mutually_require_attributes
boolean

Flag to define whether validations for annotations and ticket options within packages should be triggered only if one of them has a value. Defaults to false.

notification_email
string

Email address to receive notifications about new bookings, if activated

notify_on_new_booking
boolean

Flag whether the host shall be notified on new bookings. Defaults to false.

order
integer

Order index in lists (lowest to highest)

package_price
string

Public identifier (pid) of a package price

price_booking_limitation_set
string

Public identifier (pid) of a price booking limitation set

price_set
string

Public identifier (pid) of a price set

refine_info
string

Additional refine information text

required_in_package
boolean

Flag whether a ticket of this price must be included within a package. If false, it is optional.

sector_to_be_booked
string

Public identifier (pid) of a Sector

show
string

Public identifier (pid) of a show

ticket_options
Array of strings

Ticket options available for this price

vat
string

Public identifier (pid) of vat

verification_info
string

Verification information to pop up at access control (e.g. "Check ID" on children prices)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "price": null,
  • "price_category": 1,
  • "access_by": "host",
  • "available_from": "2019-08-24T14:15:22Z",
  • "available_to": "2019-08-24T14:15:22Z",
  • "annotations": [
    ],
  • "approval_needed": true,
  • "count_capacity": true,
  • "coupon_groups": [
    ],
  • "depends_on_prices": [
    ],
  • "description": "string",
  • "event": "string",
  • "expect_check_in": true,
  • "interval": 0,
  • "issue_ticket": true,
  • "limitation": 0,
  • "max_per_booking": 0,
  • "min_per_booking": 0,
  • "min_per_package": 0,
  • "max_per_package": 0,
  • "mutually_require_attributes": true,
  • "order": 0,
  • "package_price": "string",
  • "sector_to_be_booked": "string",
  • "price_booking_limitation_set": "string",
  • "price_set": "string",
  • "refine_info": "string",
  • "required_in_package": true,
  • "show": "string",
  • "ticket_options": [
    ],
  • "vat": "string",
  • "verification_info": "string",
  • "notification_email": "string",
  • "notify_on_new_booking": true
}

Get a single price

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "_links": {
    },
  • "discr": "price"
}

Delete a price

path Parameters
pid
required
string

Responses

Update a single price

path Parameters
pid
required
string
Request Body schema: application/json
name
required
string

Name

price
required
any

Price

price_category
required
number
Enum: 1 2 3 4 5 6 7 8

Public identifier (pid) of a price category

access_by
string
Value: "host"

Who may see this price. Set to null for public.

annotations
Array of strings

Annotations available on this price

approval_needed
boolean

Flag whether bookings with this price require approval by the host. Defaults to false.

available_from
string <date-time>

From when this price should be publicly available. Only applies if accessBy=null. Set to null if not limited to a date.

available_to
string <date-time>

Until when this price should be publicly available. Only applies if accessBy=null. Set to null if not limited to a date.

count_capacity
boolean

Flag whether tickets with this price should count towards show capacity. Defaults to true.

coupon_groups
Array of strings

Coupon groups from which coupons can be applied to this price

depends_on_prices
Array of strings

Prices of which one must be available in a booking in order to book a ticket of this price

description
string

Additional description

event
string

Public identifier (pid) of an event

expect_check_in
boolean

Flag whether a ticket of this price should count towards the expected number of checkins at access control. Defaults to true.

interval
integer

Interval for quantities in which tickets with this price may be booked

issue_ticket
boolean

Flag whether tickets booked of this price will actually receive a ticket. Defaults to true.

limitation
integer

Available number of tickets with this price

max_per_booking
integer

Maximal quantity of tickets with this price per booking

max_per_package
integer

Maximal quantity of tickets with this price per package

min_per_booking
integer

Minimal quantity of tickets with this price per booking

min_per_package
integer

Minimal quantity of tickets with this price per package

mutually_require_attributes
boolean

Flag to define whether validations for annotations and ticket options within packages should be triggered only if one of them has a value. Defaults to false.

notification_email
string

Email address to receive notifications about new bookings, if activated

notify_on_new_booking
boolean

Flag whether the host shall be notified on new bookings. Defaults to false.

order
integer

Order index in lists (lowest to highest)

package_price
string

Public identifier (pid) of a package price

price_booking_limitation_set
string

Public identifier (pid) of a price booking limitation set

price_set
string

Public identifier (pid) of a price set

refine_info
string

Additional refine information text

required_in_package
boolean

Flag whether a ticket of this price must be included within a package. If false, it is optional.

sector_to_be_booked
string

Public identifier (pid) of a Sector

show
string

Public identifier (pid) of a show

ticket_options
Array of strings

Ticket options available for this price

vat
string

Public identifier (pid) of vat

verification_info
string

Verification information to pop up at access control (e.g. "Check ID" on children prices)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "price": null,
  • "price_category": 1,
  • "access_by": "host",
  • "available_from": "2019-08-24T14:15:22Z",
  • "available_to": "2019-08-24T14:15:22Z",
  • "annotations": [
    ],
  • "approval_needed": true,
  • "count_capacity": true,
  • "coupon_groups": [
    ],
  • "depends_on_prices": [
    ],
  • "description": "string",
  • "event": "string",
  • "expect_check_in": true,
  • "interval": 0,
  • "issue_ticket": true,
  • "limitation": 0,
  • "max_per_booking": 0,
  • "min_per_booking": 0,
  • "min_per_package": 0,
  • "max_per_package": 0,
  • "mutually_require_attributes": true,
  • "order": 0,
  • "package_price": "string",
  • "sector_to_be_booked": "string",
  • "price_booking_limitation_set": "string",
  • "price_set": "string",
  • "refine_info": "string",
  • "required_in_package": true,
  • "show": "string",
  • "ticket_options": [
    ],
  • "vat": "string",
  • "verification_info": "string",
  • "notification_email": "string",
  • "notify_on_new_booking": true
}

Get the event of a price

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "timespan": { },
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "performer": "string",
  • "ticketdescription": "string",
  • "description": "string",
  • "delivery_info": "string",
  • "confirmation_extras_template": "string",
  • "will_call_label": "string",
  • "pay_before_dispatch": false,
  • "immediate_payment_only": false,
  • "send_reminders": true,
  • "delete_unpaid_bookings_mode": "never",
  • "allow_digital_dispatch": true,
  • "allow_deliveries": false,
  • "allow_will_call": false,
  • "issue_tickets": true,
  • "enable_passbook_tickets": true,
  • "require_customer_company": false,
  • "require_customer_address": true,
  • "require_customer_phone": false,
  • "prompt_customer_position": false,
  • "prompt_customer_department": false,
  • "prompt_customer_title": false,
  • "prompt_customer_birthday": false,
  • "allow_customer_notes": false,
  • "allow_invoice_address": false,
  • "allow_single_empty_seats": true,
  • "is_hidden": false,
  • "excluded_from_revenue_stats": false,
  • "tickets_per_booking": 1,
  • "tickets_in_listings": 1,
  • "refine_info": "string",
  • "reservation_info": "string",
  • "sales_point_info": "string",
  • "support_info": "string",
  • "payout_interval": "string",
  • "payout_interval_specification": "string",
  • "is_cancelled": true,
  • "will_be_postponed": true,
  • "cancellation_info": "string",
  • "invoice_address": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "notify_on_new_booking": false,
  • "notification_email": "string",
  • "fee_percentage": "string",
  • "fee_minimal_commission": "string",
  • "fee_free_ticket_commission": "string",
  • "fee_included_free_tickets_percentage": 100,
  • "fee_payment_base_commission": "string",
  • "fee_payment_percentage": "string",
  • "_links": {
    }
}

Get the show of a price

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "access_role": "string",
  • "beacon_data": { },
  • "translations": { },
  • "pid": "string",
  • "performer": "string",
  • "ticketdescription": "string",
  • "description": "string",
  • "subtitle": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "end_check_in": "2019-08-24T14:15:22Z",
  • "start_public_sales": "2019-08-24T14:15:22Z",
  • "end_sales": "2019-08-24T14:15:22Z",
  • "end_sales_alternative": "string",
  • "dooropening": "2019-08-24T14:15:22Z",
  • "specific_capacity": 1,
  • "allow_sales_while_current": false,
  • "allow_single_empty_seats": true,
  • "always_display_start_time": false,
  • "reservation_info": "string",
  • "request_ratings": false,
  • "order": 0,
  • "is_cancelled": true,
  • "will_be_postponed": true,
  • "is_online_show": true,
  • "online_show": {
    },
  • "tickets_per_booking": 1,
  • "enable_passbook_tickets": true,
  • "access_by": "string",
  • "ratings_requested": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the currency of a price

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "round_to_cents": 0,
  • "_links": {
    }
}

Get the price category of a price

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the vat of a price

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "country": "string",
  • "rate": "string",
  • "included": false,
  • "default_for_country": false,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the package price of a price

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "access_role": "string",
  • "price_excluding_vat": 0,
  • "price_including_vat": 0,
  • "vat_amount": 0,
  • "vat_rate": 0,
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "description": "string",
  • "order": 0,
  • "limitation": 1,
  • "set": {
    },
  • "booking_limitation_set": {
    },
  • "interval": 1,
  • "min_per_booking": 0,
  • "max_per_booking": 0,
  • "min_per_package": 0,
  • "max_per_package": 0,
  • "refine_info": "string",
  • "count_capacity": true,
  • "issue_ticket": true,
  • "mutually_require_attributes": false,
  • "access_by": "string",
  • "available_from": "2019-08-24T14:15:22Z",
  • "available_to": "2019-08-24T14:15:22Z",
  • "approval_needed": true,
  • "expect_check_in": true,
  • "verification_info": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "notify_on_new_booking": false,
  • "notification_email": "string",
  • "price": "string",
  • "package_size": 0,
  • "count_filler_tickets": true,
  • "_links": {
    }
}

Get the tickets of a price.

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "_links": {
    },
  • "discr": "ticket"
}

Get the ticket option exclusions of a price.

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the ticket option sets of a price.

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "pid": "string",
  • "min": 1,
  • "max": 1,
  • "error_message_min": "string",
  • "error_message_max": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "batch_id": "string",
  • "batch_order": 0,
  • "_links": {
    }
}

Get the ticket options of a price.

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "ticket_option_group_pid": "string",
  • "ticket_option_group_name": "string",
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "ticket_info": "string",
  • "description": "string",
  • "all_or_nothing": false,
  • "order": 0,
  • "notify_on_new_booking": true,
  • "notification_email_address": "string",
  • "access_by": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "available_until_minutes_before_show_start": 0,
  • "custom_fee_percentage": "string",
  • "price": "string",
  • "_links": {
    }
}

Get the annotations of a price.

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "access_role": "string",
  • "translations": { },
  • "pid": "string",
  • "target": "booking",
  • "identifier": "string",
  • "name": "string",
  • "description": "string",
  • "placeholder": "string",
  • "order": 0,
  • "required": false,
  • "max_chars": 0,
  • "regex": "string",
  • "show_type": "all",
  • "access_by": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "editable_by_buyer": false,
  • "_links": {
    }
}

Get the coupon groups of a price.

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": null,
  • "name": "string",
  • "code_format": "string",
  • "value_absolute": "string",
  • "value_percent": 1,
  • "value_max": "string",
  • "value_one_ticket": true,
  • "apply_to_tickets_only": false,
  • "allow_redemptions": 1,
  • "maximal_ticket_value": "string",
  • "minimal_booking_value": "string",
  • "max_coupons_per_booking": 0,
  • "expiration": "2019-08-24T14:15:22Z",
  • "available_in_shop": false,
  • "paid": false,
  • "for_individual_values": false,
  • "order": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the invitations of a price

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "code": "string",
  • "expiration": "2019-08-24T14:15:22Z",
  • "personal": true,
  • "single_use": true,
  • "tickets_max_per_show": 0,
  • "tickets_max_per_event": 0,
  • "tickets_max_total": 0,
  • "tickets_max_per_booking": 0,
  • "max_different_shows": 0,
  • "rsvp": true,
  • "declined_at": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the invitation quotas of a price

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "limitation": 0,
  • "code": "string",
  • "_links": {
    }
}

PriceBookingLimitationSet

A PriceBookingLimitationSet is used to define a minimum and/or maximum number of Tickets that can be booked in one Booking within a collection of multiple Prices. Example: Ticket buyers get a discount if they are customers of a specific company, but they may only book 4 of those discounted tickets per booking. There are two discounted prices (adults + children). Both prices will need to be connected to the same PriceBookingLimitationSet, which defines the limitation of 4 tickets per booking.

Get a single price booking limitation set

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "min_error_message": "string",
  • "max_error_message": "string",
  • "min_per_booking": 2,
  • "max_per_booking": 1
}

Update one price booking limitation set

path Parameters
pid
required
string
Request Body schema: application/json
host
required
string

Public identifier (pid) of host

max_error_message
string

Error message if the max limit is exceeded. Placeholders %min%, %max% and %current% are available.

max_per_booking
integer

Maximal quantity of tickets with prices of this set per booking

min_error_message
string

Error message if the min limit is not reached. Placeholders %min%, %max% and %current% are available.

min_per_booking
integer

Minimal quantity of tickets with prices of this set per booking

Responses

Request samples

Content type
application/json
{
  • "host": "string",
  • "max_error_message": "string",
  • "min_error_message": "string",
  • "max_per_booking": 0,
  • "min_per_booking": 0
}

Create one or multiple price booking limitation sets

Request Body schema: application/json
host
required
string

Public identifier (pid) of host

max_error_message
string

Error message if the max limit is exceeded. Placeholders %min%, %max% and %current% are available.

max_per_booking
integer

Maximal quantity of tickets with prices of this set per booking

min_error_message
string

Error message if the min limit is not reached. Placeholders %min%, %max% and %current% are available.

min_per_booking
integer

Minimal quantity of tickets with prices of this set per booking

Responses

Request samples

Content type
application/json
{
  • "host": "string",
  • "max_error_message": "string",
  • "min_error_message": "string",
  • "max_per_booking": 0,
  • "min_per_booking": 0
}

Update one or multiple price booking limitation sets

Request Body schema: application/json
host
required
string

Public identifier (pid) of host

max_error_message
string

Error message if the max limit is exceeded. Placeholders %min%, %max% and %current% are available.

max_per_booking
integer

Maximal quantity of tickets with prices of this set per booking

min_error_message
string

Error message if the min limit is not reached. Placeholders %min%, %max% and %current% are available.

min_per_booking
integer

Minimal quantity of tickets with prices of this set per booking

Responses

Request samples

Content type
application/json
{
  • "host": "string",
  • "max_error_message": "string",
  • "min_error_message": "string",
  • "max_per_booking": 0,
  • "min_per_booking": 0
}

Get the host of a price booking limitation set

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "care_of": "string",
  • "address1": "string",
  • "address2": "string",
  • "zip": "string",
  • "city": "string",
  • "country": "string",
  • "will_call_label": "string",
  • "will_call_instructions": "string",
  • "send_reminders": true,
  • "delete_unpaid_bookings": true,
  • "public_email": "string",
  • "public_email_sender_name": "string",
  • "public_phone": "string",
  • "website": "string",
  • "bank_account": "string",
  • "bank_account_owner": "string",
  • "bank_account_city": "string",
  • "invoice_address": "string",
  • "vat_number": "string",
  • "thank_you_close": "string",
  • "complimentary_close": "string",
  • "contact_text": "string",
  • "confirmation_extras_template": "string",
  • "tos_title": "string",
  • "tos": "string",
  • "saferpay_terminal_id": "string",
  • "shared_secret": "string",
  • "prompt_newsletter": false,
  • "prompt_acquisition_channel": false,
  • "execute_deliveries": true,
  • "check_newsletter_by_default": false,
  • "address_right": false,
  • "enable_crm": false,
  • "enable_staff": false,
  • "enable_invitations": false,
  • "enable_seat_category_changes": false,
  • "enable_remaining_voucher_value_handling": false,
  • "enable_donations": false,
  • "execute_payouts": true,
  • "cancellation_policy": "strict",
  • "enable_salutation": true,
  • "use_security_code": true,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "allow_user_to_delete_booking": true,
  • "allow_embed_session_id": true,
  • "allow_single_empty_seats": true,
  • "setup_information": "string",
  • "support_info": "string",
  • "notify_on_new_booking": false,
  • "notification_email": "string",
  • "fee_percentage": "string",
  • "fee_minimal_commission": "string",
  • "fee_free_ticket_commission": "string",
  • "fee_included_free_tickets_percentage": 100,
  • "fee_payment_base_commission": "string",
  • "fee_payment_percentage": "string",
  • "_links": {
    }
}

PriceCategory

A PriceCategory defines the category of a Price. It connects Prices to Sectors of a Venue, as it defines what is bookable where. Example: Sector «Balcony» is assigned to price category 1, which again is assigned to a price for adults and children. Sector «Ground floor» is assigned to price category 2, for which again multiple prices are available. PriceCategories are defined globally and cannot be changed by Hosts.

Get all price categories

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get only head data of GET request

Responses

Get a single price category

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

PriceSet

A PriceSet defines a limitation of how often a collection of multiple Prices can be booked. Example: A theatre has a cooperation with a newspaper. The newspaper sells discounted tickets for multiple plays at different price levels. This cooperation is limited to 500 tickets per season, which can be defined as a PriceSet.

Get all price sets

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "limitation": 1
}

Create one or multiple price sets

Request Body schema: application/json
host
required
string

Public identifier (pid) of a host

limitation
integer

Limitation (null for unlimited)

Responses

Request samples

Content type
application/json
{
  • "host": "string",
  • "limitation": 0
}

Get only head data of GET request

Responses

Update one or multiple price sets

Request Body schema: application/json
host
required
string

Public identifier (pid) of a host

limitation
integer

Limitation (null for unlimited)

Responses

Request samples

Content type
application/json
{
  • "host": "string",
  • "limitation": 0
}

Get a single price set

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "limitation": 1
}

Update a price set

path Parameters
pid
required
string
Request Body schema: application/json
host
required
string

Public identifier (pid) of a host

limitation
integer

Limitation (null for unlimited)

Responses

Request samples

Content type
application/json
{
  • "host": "string",
  • "limitation": 0
}

Project

A Project is the general container of where work can be assigned in the staff module. It often corresponds to a single Event.

Get all projects

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "pid": "string",
  • "name": "string",
  • "event": {
    },
  • "person_group": {
    },
  • "departments": [
    ],
  • "staff_members": [
    ],
  • "batch_id": "string",
  • "batch_order": 0,
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get a single project

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "pid": "string",
  • "name": "string",
  • "event": {
    },
  • "person_group": {
    },
  • "departments": [
    ],
  • "staff_members": [
    ],
  • "batch_id": "string",
  • "batch_order": 0,
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete a project

path Parameters
pid
required
string

Responses

ProtectionConcept

A ProtectionConcept is what you need when the plague (or Covid-19) comes back. It's where is defined what security measures a required for ticket buyers to attend an event.

Get one protection concept

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "pid": "string",
  • "facemask_required": false,
  • "health_certificate_mode": "3G",
  • "batch_id": "string",
  • "batch_order": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Update one protection concept

path Parameters
pid
required
string
Request Body schema: application/json
event
required
string

Public identifier (pid) of an event

facemask_required
boolean

Flag whether wearing a facemask is mandatory.

health_certificate_mode
string
Enum: "3G" "2G" "2GPLUS" "GENERIC"

Required health certificate mode. Set to null for none.

Responses

Request samples

Content type
application/json
{
  • "event": "string",
  • "facemask_required": true,
  • "health_certificate_mode": "3G"
}

Update one or multiple protection concepts

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "pid": "string",
  • "facemask_required": false,
  • "health_certificate_mode": "3G",
  • "batch_id": "string",
  • "batch_order": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the event of a protection concept

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "timespan": { },
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "performer": "string",
  • "ticketdescription": "string",
  • "description": "string",
  • "delivery_info": "string",
  • "confirmation_extras_template": "string",
  • "will_call_label": "string",
  • "pay_before_dispatch": false,
  • "immediate_payment_only": false,
  • "send_reminders": true,
  • "delete_unpaid_bookings_mode": "never",
  • "allow_digital_dispatch": true,
  • "allow_deliveries": false,
  • "allow_will_call": false,
  • "issue_tickets": true,
  • "enable_passbook_tickets": true,
  • "require_customer_company": false,
  • "require_customer_address": true,
  • "require_customer_phone": false,
  • "prompt_customer_position": false,
  • "prompt_customer_department": false,
  • "prompt_customer_title": false,
  • "prompt_customer_birthday": false,
  • "allow_customer_notes": false,
  • "allow_invoice_address": false,
  • "allow_single_empty_seats": true,
  • "is_hidden": false,
  • "excluded_from_revenue_stats": false,
  • "tickets_per_booking": 1,
  • "tickets_in_listings": 1,
  • "refine_info": "string",
  • "reservation_info": "string",
  • "sales_point_info": "string",
  • "support_info": "string",
  • "payout_interval": "string",
  • "payout_interval_specification": "string",
  • "is_cancelled": true,
  • "will_be_postponed": true,
  • "cancellation_info": "string",
  • "invoice_address": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "notify_on_new_booking": false,
  • "notification_email": "string",
  • "fee_percentage": "string",
  • "fee_minimal_commission": "string",
  • "fee_free_ticket_commission": "string",
  • "fee_included_free_tickets_percentage": 100,
  • "fee_payment_base_commission": "string",
  • "fee_payment_percentage": "string",
  • "_links": {
    }
}

Row

A Row represents a single row of Seats within a Venue. They are usually managed automatically.

Get all rows

Responses

Response samples

Content type
application/json
{
  • "access_role": "string",
  • "translations": { },
  • "pid": "string",
  • "label": "string",
  • "chart_row_id": "string",
  • "chart_row_hash": "string",
  • "chart_row_uuid": "string",
  • "seat_string_template": "string",
  • "access_by": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get all rows

Responses

Response samples

Content type
application/json
{
  • "access_role": "string",
  • "translations": { },
  • "pid": "string",
  • "label": "string",
  • "chart_row_id": "string",
  • "chart_row_hash": "string",
  • "chart_row_uuid": "string",
  • "seat_string_template": "string",
  • "access_by": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get only head data of GET request

Responses

Update one or multiple rows

Request Body schema: application/json
access_by
string
Value: "host"

Who may see this row. Set to null for public.

seat_string_template
string

Optional seat string template.

Responses

Request samples

Content type
application/json
{
  • "access_by": "host",
  • "seat_string_template": "string"
}

Update one or multiple rows

Request Body schema: application/json
access_by
string
Value: "host"

Who may see this row. Set to null for public.

seat_string_template
string

Optional seat string template.

Responses

Request samples

Content type
application/json
{
  • "access_by": "host",
  • "seat_string_template": "string"
}

Get a single row

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "access_role": "string",
  • "translations": { },
  • "pid": "string",
  • "label": "string",
  • "chart_row_id": "string",
  • "chart_row_hash": "string",
  • "chart_row_uuid": "string",
  • "seat_string_template": "string",
  • "access_by": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get a single row

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "access_role": "string",
  • "translations": { },
  • "pid": "string",
  • "label": "string",
  • "chart_row_id": "string",
  • "chart_row_hash": "string",
  • "chart_row_uuid": "string",
  • "seat_string_template": "string",
  • "access_by": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Update a single row

path Parameters
pid
required
string
Request Body schema: application/json
access_by
string
Value: "host"

Who may see this row. Set to null for public.

seat_string_template
string

Optional seat string template.

Responses

Request samples

Content type
application/json
{
  • "access_by": "host",
  • "seat_string_template": "string"
}

Update a single row

path Parameters
pid
required
string
Request Body schema: application/json
access_by
string
Value: "host"

Who may see this row. Set to null for public.

seat_string_template
string

Optional seat string template.

Responses

Request samples

Content type
application/json
{
  • "access_by": "host",
  • "seat_string_template": "string"
}

Get the sector of a row

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "access_role": "string",
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "description": "string",
  • "capacity": 1,
  • "price_category": {
    },
  • "order": 0,
  • "seating_chart_area": 1,
  • "chart_sector_id": "string",
  • "seat_string_template": "string",
  • "access_by": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the sector of a row

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "access_role": "string",
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "description": "string",
  • "capacity": 1,
  • "price_category": {
    },
  • "order": 0,
  • "seating_chart_area": 1,
  • "chart_sector_id": "string",
  • "seat_string_template": "string",
  • "access_by": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the seats of a row

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "access_role": "string",
  • "translations": { },
  • "pid": "string",
  • "label": "string",
  • "chart_seat_id": "string",
  • "price_category": {
    },
  • "seat_string_template": "string",
  • "capacity_count": 0,
  • "access_by": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

SalesPoint

A SalesPoint is an external place which sells Tickets for a Host. Like a department store or the train station. Before the internet, sales points were very important. Nowadays, it's used less and less.

Get all sales points

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "name": "string",
  • "care_of": "string",
  • "address1": "string",
  • "address2": "string",
  • "zip": "string",
  • "city": "string",
  • "country": "string",
  • "pos_only": true,
  • "require_customer": false,
  • "customer_search_enabled": false,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Create a new sales point

Request Body schema: application/json
group
required
string

Public identifier (pid) of a user group

host
required
string

Public identifier (pid) of a host

name
required
string

Name

address1
string

Address 1

address2
string

Address 2

care_of
string

c/o

city
string

City

country
string

Country (2 letters, ISO 3166-1 alpha-2)

customer_search_enabled
boolean

Flag whether this salespoint has customer search enabled, if the crm module is active. Defaults to false.

pos_only
boolean

Flag whether this sales point may only sell tickets locally. Defaults to true.

require_customer
boolean

Flag whether this sales point must collect customer data (name and address). If false, anonymous bookings are allowed. Defaults to false.

zip
string

ZIP

Responses

Request samples

Content type
application/json
{
  • "group": "string",
  • "host": "string",
  • "name": "string",
  • "care_of": "string",
  • "address1": "string",
  • "address2": "string",
  • "zip": "string",
  • "city": "string",
  • "country": "string",
  • "customer_search_enabled": true,
  • "pos_only": true,
  • "require_customer": true
}

Get only head data of GET request

Responses

Update one or multiple sales points

Request Body schema: application/json
group
required
string

Public identifier (pid) of a user group

host
required
string

Public identifier (pid) of a host

name
required
string

Name

address1
string

Address 1

address2
string

Address 2

care_of
string

c/o

city
string

City

country
string

Country (2 letters, ISO 3166-1 alpha-2)

customer_search_enabled
boolean

Flag whether this salespoint has customer search enabled, if the crm module is active. Defaults to false.

pos_only
boolean

Flag whether this sales point may only sell tickets locally. Defaults to true.

require_customer
boolean

Flag whether this sales point must collect customer data (name and address). If false, anonymous bookings are allowed. Defaults to false.

zip
string

ZIP

Responses

Request samples

Content type
application/json
{
  • "group": "string",
  • "host": "string",
  • "name": "string",
  • "care_of": "string",
  • "address1": "string",
  • "address2": "string",
  • "zip": "string",
  • "city": "string",
  • "country": "string",
  • "customer_search_enabled": true,
  • "pos_only": true,
  • "require_customer": true
}

Get a single sales point

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "name": "string",
  • "care_of": "string",
  • "address1": "string",
  • "address2": "string",
  • "zip": "string",
  • "city": "string",
  • "country": "string",
  • "pos_only": true,
  • "require_customer": false,
  • "customer_search_enabled": false,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Delete a sales point

path Parameters
pid
required
string

Responses

Update a single sales point

path Parameters
pid
required
string
Request Body schema: application/json
group
required
string

Public identifier (pid) of a user group

host
required
string

Public identifier (pid) of a host

name
required
string

Name

address1
string

Address 1

address2
string

Address 2

care_of
string

c/o

city
string

City

country
string

Country (2 letters, ISO 3166-1 alpha-2)

customer_search_enabled
boolean

Flag whether this salespoint has customer search enabled, if the crm module is active. Defaults to false.

pos_only
boolean

Flag whether this sales point may only sell tickets locally. Defaults to true.

require_customer
boolean

Flag whether this sales point must collect customer data (name and address). If false, anonymous bookings are allowed. Defaults to false.

zip
string

ZIP

Responses

Request samples

Content type
application/json
{
  • "group": "string",
  • "host": "string",
  • "name": "string",
  • "care_of": "string",
  • "address1": "string",
  • "address2": "string",
  • "zip": "string",
  • "city": "string",
  • "country": "string",
  • "customer_search_enabled": true,
  • "pos_only": true,
  • "require_customer": true
}

Get the host of a sales point

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "care_of": "string",
  • "address1": "string",
  • "address2": "string",
  • "zip": "string",
  • "city": "string",
  • "country": "string",
  • "will_call_label": "string",
  • "will_call_instructions": "string",
  • "send_reminders": true,
  • "delete_unpaid_bookings": true,
  • "public_email": "string",
  • "public_email_sender_name": "string",
  • "public_phone": "string",
  • "website": "string",
  • "bank_account": "string",
  • "bank_account_owner": "string",
  • "bank_account_city": "string",
  • "invoice_address": "string",
  • "vat_number": "string",
  • "thank_you_close": "string",
  • "complimentary_close": "string",
  • "contact_text": "string",
  • "confirmation_extras_template": "string",
  • "tos_title": "string",
  • "tos": "string",
  • "saferpay_terminal_id": "string",
  • "shared_secret": "string",
  • "prompt_newsletter": false,
  • "prompt_acquisition_channel": false,
  • "execute_deliveries": true,
  • "check_newsletter_by_default": false,
  • "address_right": false,
  • "enable_crm": false,
  • "enable_staff": false,
  • "enable_invitations": false,
  • "enable_seat_category_changes": false,
  • "enable_remaining_voucher_value_handling": false,
  • "enable_donations": false,
  • "execute_payouts": true,
  • "cancellation_policy": "strict",
  • "enable_salutation": true,
  • "use_security_code": true,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "allow_user_to_delete_booking": true,
  • "allow_embed_session_id": true,
  • "allow_single_empty_seats": true,
  • "setup_information": "string",
  • "support_info": "string",
  • "notify_on_new_booking": false,
  • "notification_email": "string",
  • "fee_percentage": "string",
  • "fee_minimal_commission": "string",
  • "fee_free_ticket_commission": "string",
  • "fee_included_free_tickets_percentage": 100,
  • "fee_payment_base_commission": "string",
  • "fee_payment_percentage": "string",
  • "_links": {
    }
}

Get the client of a sales point

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "legal_name": "string",
  • "address": "string",
  • "zip": "string",
  • "city": "string",
  • "country": "string",
  • "internal_email": "string",
  • "public_email": "string",
  • "public_email_sender_name": "string",
  • "fee_minimal_commission": "string",
  • "fee_free_ticket_commission": "string",
  • "fee_included_free_tickets_percentage": 100,
  • "fee_ticket_options_percentage": "0.00",
  • "fee_options_percentage": "0.00",
  • "important_host_info": "string",
  • "enable_waiting_room": false,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the group of a sales point

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z"
}

SalesQuota

A SalesQuota defines how many Tickets are reserved within a SalesQuotaSet for a specific Sector – if there is no SeatingChart.

Get all sales quotas

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "quota": 0,
  • "_links": {
    }
}

Create one or multiple sales quotas

Request Body schema: application/json
quota
required
integer

Number of tickets available in this quota

sales_quota_set
required
string

Public identifier (pid) of a sales quota set

sector
required
string

Public identifier (pid) of a sector

Responses

Request samples

Content type
application/json
{
  • "quota": 0,
  • "sales_quota_set": "string",
  • "sector": "string"
}

Get only head data of GET request

Responses

Update one or multiple sales quotas

Request Body schema: application/json
quota
required
integer

Number of tickets available in this quota

sales_quota_set
required
string

Public identifier (pid) of a sales quota set

sector
required
string

Public identifier (pid) of a sector

Responses

Request samples

Content type
application/json
{
  • "quota": 0,
  • "sales_quota_set": "string",
  • "sector": "string"
}

Get a single sales quota

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "quota": 0,
  • "_links": {
    }
}

Delete a sales quota

path Parameters
pid
required
string

Responses

Update a sales quota

path Parameters
pid
required
string
Request Body schema: application/json
quota
required
integer

Number of tickets available in this quota

sales_quota_set
required
string

Public identifier (pid) of a sales quota set

sector
required
string

Public identifier (pid) of a sector

Responses

Request samples

Content type
application/json
{
  • "quota": 0,
  • "sales_quota_set": "string",
  • "sector": "string"
}

Get the sector of a sales quota

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "access_role": "string",
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "description": "string",
  • "capacity": 1,
  • "price_category": {
    },
  • "order": 0,
  • "seating_chart_area": 1,
  • "chart_sector_id": "string",
  • "seat_string_template": "string",
  • "access_by": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the sales quota set of a sales quota

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "name": "string",
  • "chart_channel_id": "string",
  • "_links": {
    }
}

SalesQuotaEmbedSet

A SalesQuotaEmbedSet combines multiple SalesQuotaSets for simpler usage within embed shop configurations.

Get all sales quota embed sets

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "name": "string",
  • "_links": {
    }
}

Get all sales quota embed sets

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "name": "string",
  • "_links": {
    }
}

Create one or multiple sales quota embed sets

Request Body schema: application/json
host
required
string

Public identifier (pid) of host

name
required
string

Name of the sales quota embed set.

sales_quota_sets
required
string

List of public identifiers (pid) of sales quota sets

Responses

Request samples

Content type
application/json
{
  • "host": "string",
  • "name": "string",
  • "sales_quota_sets": "string"
}

Get only head data of GET request

Responses

Get only head data of GET request

Responses

Update one or multiple sales quota embed sets

Request Body schema: application/json
host
required
string

Public identifier (pid) of host

name
required
string

Name of the sales quota embed set.

sales_quota_sets
required
string

List of public identifiers (pid) of sales quota sets

Responses

Request samples

Content type
application/json
{
  • "host": "string",
  • "name": "string",
  • "sales_quota_sets": "string"
}

Get a single sales quota embed set

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "name": "string",
  • "_links": {
    }
}

Delete a sales quota embed set

path Parameters
pid
required
string

Responses

Update a sales quota embed set

path Parameters
pid
required
string
Request Body schema: application/json
host
required
string

Public identifier (pid) of host

name
required
string

Name of the sales quota embed set.

sales_quota_sets
required
string

List of public identifiers (pid) of sales quota sets

Responses

Request samples

Content type
application/json
{
  • "host": "string",
  • "name": "string",
  • "sales_quota_sets": "string"
}

Get the sales quotas of a sales quota embed set

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "quota": 0,
  • "_links": {
    }
}

SalesQuotaSet

A SalesQuotaSet defines a contingent of tickets which should not be sold publicly. For seating charts, it's recommended to create them via the GUI.

Get all sales quota sets

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "name": "string",
  • "chart_channel_id": "string",
  • "_links": {
    }
}

Create one or multiple sales quota sets

Request Body schema: application/json
chart_channel_id
required
string

ID of a channel on the seating chart

name
required
string

Name of the sales quota set.

show
required
string

Public identifier (pid) of show

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "show": "string",
  • "chart_channel_id": "string"
}

Update one or multiple SalesQuotaSets

Request Body schema: application/json
chart_channel_id
required
string

ID of a channel on the seating chart

name
required
string

Name of the sales quota set.

show
required
string

Public identifier (pid) of show

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "show": "string",
  • "chart_channel_id": "string"
}

Get a single sales quota set

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "name": "string",
  • "chart_channel_id": "string",
  • "_links": {
    }
}

Delete a sales quota set

path Parameters
pid
required
string

Responses

Update a sales quota set

path Parameters
pid
required
string
Request Body schema: application/json
chart_channel_id
required
string

ID of a channel on the seating chart

name
required
string

Name of the sales quota set.

show
required
string

Public identifier (pid) of show

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "show": "string",
  • "chart_channel_id": "string"
}

Get the show of a sales quota set

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "access_role": "string",
  • "beacon_data": { },
  • "translations": { },
  • "pid": "string",
  • "performer": "string",
  • "ticketdescription": "string",
  • "description": "string",
  • "subtitle": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "end_check_in": "2019-08-24T14:15:22Z",
  • "start_public_sales": "2019-08-24T14:15:22Z",
  • "end_sales": "2019-08-24T14:15:22Z",
  • "end_sales_alternative": "string",
  • "dooropening": "2019-08-24T14:15:22Z",
  • "specific_capacity": 1,
  • "allow_sales_while_current": false,
  • "allow_single_empty_seats": true,
  • "always_display_start_time": false,
  • "reservation_info": "string",
  • "request_ratings": false,
  • "order": 0,
  • "is_cancelled": true,
  • "will_be_postponed": true,
  • "is_online_show": true,
  • "online_show": {
    },
  • "tickets_per_booking": 1,
  • "enable_passbook_tickets": true,
  • "access_by": "string",
  • "ratings_requested": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the sales quotas of a SalesQuotaSet.

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
null

Seat

A Seat is where a ticket buyer places their rear end to watch a Show. Seats are usually managed automatically.

Get all seats

Responses

Response samples

Content type
application/json
{
  • "access_role": "string",
  • "translations": { },
  • "pid": "string",
  • "label": "string",
  • "chart_seat_id": "string",
  • "price_category": {
    },
  • "seat_string_template": "string",
  • "capacity_count": 0,
  • "access_by": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get only head data of GET request

Responses

Update one or multiple seats

Request Body schema: application/json
access_by
string
Value: "host"

Who may see this seat. Set to null for public.

seat_string_template
string

Optional seat string template.

Responses

Request samples

Content type
application/json
{
  • "access_by": "host",
  • "seat_string_template": "string"
}

Get a single seat

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "access_role": "string",
  • "translations": { },
  • "pid": "string",
  • "label": "string",
  • "chart_seat_id": "string",
  • "price_category": {
    },
  • "seat_string_template": "string",
  • "capacity_count": 0,
  • "access_by": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Update a single seat

path Parameters
pid
required
string
Request Body schema: application/json
access_by
string
Value: "host"

Who may see this seat. Set to null for public.

seat_string_template
string

Optional seat string template.

Responses

Request samples

Content type
application/json
{
  • "access_by": "host",
  • "seat_string_template": "string"
}

Get the row of a seat

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "access_role": "string",
  • "translations": { },
  • "pid": "string",
  • "label": "string",
  • "chart_row_id": "string",
  • "chart_row_hash": "string",
  • "chart_row_uuid": "string",
  • "seat_string_template": "string",
  • "access_by": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get price category of a seat

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

SeatingChart

A SeatingChart contains Rows and Seats, which belong to specific Sectors of a Venue. It is usually managed automatically.

Create one or multiple seating charts

Request Body schema: application/json
seat_string_template
required
string

Optional seat string template.

whole_tables
boolean

Flag whether only whole tables can be booked in this seating chart

Responses

Request samples

Content type
application/json
{
  • "seat_string_template": "string",
  • "whole_tables": true
}

Get only head data of GET request

Responses

Get a single seating chart

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "chart_id": "string",
  • "default_event_id": "string",
  • "seat_string_template": "string",
  • "whole_tables": false,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Delete a seating chart

path Parameters
pid
required
string

Responses

Update a seating chart

path Parameters
pid
required
string
Request Body schema: application/json
seat_string_template
required
string

Optional seat string template.

whole_tables
boolean

Flag whether only whole tables can be booked in this seating chart

Responses

Request samples

Content type
application/json
{
  • "seat_string_template": "string",
  • "whole_tables": true
}

Get the sectors of a seating chart

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "access_role": "string",
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "description": "string",
  • "capacity": 1,
  • "price_category": {
    },
  • "order": 0,
  • "seating_chart_area": 1,
  • "chart_sector_id": "string",
  • "seat_string_template": "string",
  • "access_by": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Sector

A Sector defines a specific area within a Venue. Like the «Balcony» or the «Ground Floor».

Get all sectors

Responses

Response samples

Content type
application/json
{
  • "access_role": "string",
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "description": "string",
  • "capacity": 1,
  • "price_category": {
    },
  • "order": 0,
  • "seating_chart_area": 1,
  • "chart_sector_id": "string",
  • "seat_string_template": "string",
  • "access_by": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Create one or multiple sectors

Request Body schema: application/json
capacity
required
integer

Capacity

name
required
string

Name

price_category
required
string

Public identifier (pid) of a price category

venue
required
string

Public identifier (pid) of a venue

access_by
string
Value: "host"

Who may see this sector. Set to null for public.

description
string

Additional description

order
integer

Order index in lists (lowest to highest)

Responses

Request samples

Content type
application/json
{
  • "capacity": 0,
  • "name": "string",
  • "description": "string",
  • "price_category": "string",
  • "order": 0,
  • "venue": "string",
  • "access_by": "host"
}

Get only head data of GET request

Responses

Update one or multiple sectors

Request Body schema: application/json
capacity
required
integer

Capacity

name
required
string

Name

price_category
required
string

Public identifier (pid) of a price category

venue
required
string

Public identifier (pid) of a venue

access_by
string
Value: "host"

Who may see this sector. Set to null for public.

description
string

Additional description

order
integer

Order index in lists (lowest to highest)

Responses

Request samples

Content type
application/json
{
  • "capacity": 0,
  • "name": "string",
  • "description": "string",
  • "price_category": "string",
  • "order": 0,
  • "venue": "string",
  • "access_by": "host"
}

Get a single sector

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "access_role": "string",
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "description": "string",
  • "capacity": 1,
  • "price_category": {
    },
  • "order": 0,
  • "seating_chart_area": 1,
  • "chart_sector_id": "string",
  • "seat_string_template": "string",
  • "access_by": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Delete a sector

path Parameters
pid
required
string

Responses

Update a single sector

path Parameters
pid
required
string
Request Body schema: application/json
capacity
required
integer

Capacity

name
required
string

Name

price_category
required
string

Public identifier (pid) of a price category

venue
required
string

Public identifier (pid) of a venue

access_by
string
Value: "host"

Who may see this sector. Set to null for public.

description
string

Additional description

order
integer

Order index in lists (lowest to highest)

Responses

Request samples

Content type
application/json
{
  • "capacity": 0,
  • "name": "string",
  • "description": "string",
  • "price_category": "string",
  • "order": 0,
  • "venue": "string",
  • "access_by": "host"
}

Get the venue of a sector

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "capacity": 0,
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "internalname": "string",
  • "address": "string",
  • "zip": "string",
  • "city": "string",
  • "country": "string",
  • "is_adhoc_venue": true,
  • "is_archived": true,
  • "is_virtual": true,
  • "skidata_uri": "string",
  • "skidata_receiver": 0,
  • "skidata_issuer": 0,
  • "skidata_white_list_record_class": "string",
  • "skidata_last_fetch": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the seating chart of a sector

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "chart_id": "string",
  • "default_event_id": "string",
  • "seat_string_template": "string",
  • "whole_tables": false,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the rows of a sector

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "access_role": "string",
  • "translations": { },
  • "pid": "string",
  • "label": "string",
  • "chart_row_id": "string",
  • "chart_row_hash": "string",
  • "chart_row_uuid": "string",
  • "seat_string_template": "string",
  • "access_by": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the price categories of a sector

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Show

A Show represents a single performance within an Event. A Show is what defines what happens when and where.

Get all shows

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "access_role": "string",
  • "beacon_data": { },
  • "translations": { },
  • "pid": "string",
  • "performer": "string",
  • "ticketdescription": "string",
  • "description": "string",
  • "subtitle": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "end_check_in": "2019-08-24T14:15:22Z",
  • "start_public_sales": "2019-08-24T14:15:22Z",
  • "end_sales": "2019-08-24T14:15:22Z",
  • "end_sales_alternative": "string",
  • "dooropening": "2019-08-24T14:15:22Z",
  • "specific_capacity": 1,
  • "allow_sales_while_current": false,
  • "allow_single_empty_seats": true,
  • "always_display_start_time": false,
  • "reservation_info": "string",
  • "request_ratings": false,
  • "order": 0,
  • "is_cancelled": true,
  • "will_be_postponed": true,
  • "is_online_show": true,
  • "online_show": {
    },
  • "tickets_per_booking": 1,
  • "enable_passbook_tickets": true,
  • "access_by": "string",
  • "ratings_requested": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Create one or multiple shows

Request Body schema: application/json
event
required
string

Public identifier (pid) of an event

start
required
string <date-time>

Start date and time

venue
required
string

Public identifier (pid) of a venue

access_by
string
Value: "host"

Who may see this show. Set to null for public.

allow_sales_while_current
boolean

Flag whether sales should remain open during the show. Defaults to false.

allow_single_empty_seats
boolean

Flag whether the customer is allowed to leave single empty seats in Embed Shop. Defaults to true

always_display_start_time
boolean

Flag whether start time should be displayed of allow_sales_while_current is true

block_seats_of_show
string

Public identifier (pid) of a show

description
string

An public show description. May contain basic HTML.

dooropening
string <date-time>

Date and time of dooropening

enable_passbook_tickets
boolean

Flag whether wallet tickets are enabled on this show (if enabled on the event).

end
string <date-time>

End date and time

end_checkin
string <date-time>

End date and time of checkin

end_sales
string <date-time>

End daten and time of public sales

end_sales_alternative
string

Additional information to be displayed when sales have ended for this show (e.q. «Tickets available at entrance»)

image
string

Public identifier (pid) of an image

is_cancelled
boolean

Flag whether the show has been cancelled.

is_online_show
boolean

Flag whether the show is an online show.

name
string

Event name on this show if different from the event

operator_group
string

Public identifier (pid) of a user group

order
integer

Order index in lists (lowest to highest)

passbook_image
string

Public identifier (pid) of an image

performer
string

Name of performer (artist, band, etc.) on this show if different form the event

request_ratings
boolean

Flag whether the request rating mails should be sent (if allowed by host and event). Defaults to false.

reservation_info
string

Information to be displayed on public reservation screens. Overrides value from Event

specific_capacity
integer

Specific capacity if different from venue

start_public_sales
string <date-time>

Start date and time of public sales

subtitle
string

Subtitle

tags
Array of strings

List of tags to be connected to entity

ticket_description
string

Additional description on the ticket on this show if different from the event

ticket_image
string

Public identifier (pid) of an image

tickets_per_booking
integer

Maximum allowed number of tickets per booking.

Responses

Request samples

Content type
application/json
{
  • "event": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "venue": "string",
  • "access_by": "host",
  • "allow_sales_while_current": true,
  • "allow_single_empty_seats": true,
  • "always_display_start_time": true,
  • "reservation_info": "string",
  • "block_seats_of_show": "string",
  • "dooropening": "2019-08-24T14:15:22Z",
  • "enable_passbook_tickets": true,
  • "end": "2019-08-24T14:15:22Z",
  • "end_checkin": "2019-08-24T14:15:22Z",
  • "end_sales": "2019-08-24T14:15:22Z",
  • "end_sales_alternative": "string",
  • "image": "string",
  • "is_cancelled": true,
  • "is_online_show": true,
  • "name": "string",
  • "operator_group": "string",
  • "order": 0,
  • "passbook_image": "string",
  • "performer": "string",
  • "request_ratings": true,
  • "specific_capacity": 0,
  • "start_public_sales": "2019-08-24T14:15:22Z",
  • "ticket_description": "string",
  • "ticket_image": "string",
  • "tickets_per_booking": 0,
  • "subtitle": "string",
  • "description": "string",
  • "tags": [
    ]
}

Get only head data of GET request

Responses

Update one or multiple shows

Request Body schema: application/json
event
required
string

Public identifier (pid) of an event

start
required
string <date-time>

Start date and time

venue
required
string

Public identifier (pid) of a venue

access_by
string
Value: "host"

Who may see this show. Set to null for public.

allow_sales_while_current
boolean

Flag whether sales should remain open during the show. Defaults to false.

allow_single_empty_seats
boolean

Flag whether the customer is allowed to leave single empty seats in Embed Shop. Defaults to true

always_display_start_time
boolean

Flag whether start time should be displayed of allow_sales_while_current is true

block_seats_of_show
string

Public identifier (pid) of a show

description
string

An public show description. May contain basic HTML.

dooropening
string <date-time>

Date and time of dooropening

enable_passbook_tickets
boolean

Flag whether wallet tickets are enabled on this show (if enabled on the event).

end
string <date-time>

End date and time

end_checkin
string <date-time>

End date and time of checkin

end_sales
string <date-time>

End daten and time of public sales

end_sales_alternative
string

Additional information to be displayed when sales have ended for this show (e.q. «Tickets available at entrance»)

image
string

Public identifier (pid) of an image

is_cancelled
boolean

Flag whether the show has been cancelled.

is_online_show
boolean

Flag whether the show is an online show.

name
string

Event name on this show if different from the event

operator_group
string

Public identifier (pid) of a user group

order
integer

Order index in lists (lowest to highest)

passbook_image
string

Public identifier (pid) of an image

performer
string

Name of performer (artist, band, etc.) on this show if different form the event

request_ratings
boolean

Flag whether the request rating mails should be sent (if allowed by host and event). Defaults to false.

reservation_info
string

Information to be displayed on public reservation screens. Overrides value from Event

specific_capacity
integer

Specific capacity if different from venue

start_public_sales
string <date-time>

Start date and time of public sales

subtitle
string

Subtitle

tags
Array of strings

List of tags to be connected to entity

ticket_description
string

Additional description on the ticket on this show if different from the event

ticket_image
string

Public identifier (pid) of an image

tickets_per_booking
integer

Maximum allowed number of tickets per booking.

Responses

Request samples

Content type
application/json
{
  • "event": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "venue": "string",
  • "access_by": "host",
  • "allow_sales_while_current": true,
  • "allow_single_empty_seats": true,
  • "always_display_start_time": true,
  • "reservation_info": "string",
  • "block_seats_of_show": "string",
  • "dooropening": "2019-08-24T14:15:22Z",
  • "enable_passbook_tickets": true,
  • "end": "2019-08-24T14:15:22Z",
  • "end_checkin": "2019-08-24T14:15:22Z",
  • "end_sales": "2019-08-24T14:15:22Z",
  • "end_sales_alternative": "string",
  • "image": "string",
  • "is_cancelled": true,
  • "is_online_show": true,
  • "name": "string",
  • "operator_group": "string",
  • "order": 0,
  • "passbook_image": "string",
  • "performer": "string",
  • "request_ratings": true,
  • "specific_capacity": 0,
  • "start_public_sales": "2019-08-24T14:15:22Z",
  • "ticket_description": "string",
  • "ticket_image": "string",
  • "tickets_per_booking": 0,
  • "subtitle": "string",
  • "description": "string",
  • "tags": [
    ]
}

Get a single show

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "access_role": "string",
  • "beacon_data": { },
  • "translations": { },
  • "pid": "string",
  • "performer": "string",
  • "ticketdescription": "string",
  • "description": "string",
  • "subtitle": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "end_check_in": "2019-08-24T14:15:22Z",
  • "start_public_sales": "2019-08-24T14:15:22Z",
  • "end_sales": "2019-08-24T14:15:22Z",
  • "end_sales_alternative": "string",
  • "dooropening": "2019-08-24T14:15:22Z",
  • "specific_capacity": 1,
  • "allow_sales_while_current": false,
  • "allow_single_empty_seats": true,
  • "always_display_start_time": false,
  • "reservation_info": "string",
  • "request_ratings": false,
  • "order": 0,
  • "is_cancelled": true,
  • "will_be_postponed": true,
  • "is_online_show": true,
  • "online_show": {
    },
  • "tickets_per_booking": 1,
  • "enable_passbook_tickets": true,
  • "access_by": "string",
  • "ratings_requested": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Delete a show

path Parameters
pid
required
string

Responses

Update a single show

path Parameters
pid
required
string
Request Body schema: application/json
event
required
string

Public identifier (pid) of an event

start
required
string <date-time>

Start date and time

venue
required
string

Public identifier (pid) of a venue

access_by
string
Value: "host"

Who may see this show. Set to null for public.

allow_sales_while_current
boolean

Flag whether sales should remain open during the show. Defaults to false.

allow_single_empty_seats
boolean

Flag whether the customer is allowed to leave single empty seats in Embed Shop. Defaults to true

always_display_start_time
boolean

Flag whether start time should be displayed of allow_sales_while_current is true

block_seats_of_show
string

Public identifier (pid) of a show

description
string

An public show description. May contain basic HTML.

dooropening
string <date-time>

Date and time of dooropening

enable_passbook_tickets
boolean

Flag whether wallet tickets are enabled on this show (if enabled on the event).

end
string <date-time>

End date and time

end_checkin
string <date-time>

End date and time of checkin

end_sales
string <date-time>

End daten and time of public sales

end_sales_alternative
string

Additional information to be displayed when sales have ended for this show (e.q. «Tickets available at entrance»)

image
string

Public identifier (pid) of an image

is_cancelled
boolean

Flag whether the show has been cancelled.

is_online_show
boolean

Flag whether the show is an online show.

name
string

Event name on this show if different from the event

operator_group
string

Public identifier (pid) of a user group

order
integer

Order index in lists (lowest to highest)

passbook_image
string

Public identifier (pid) of an image

performer
string

Name of performer (artist, band, etc.) on this show if different form the event

request_ratings
boolean

Flag whether the request rating mails should be sent (if allowed by host and event). Defaults to false.

reservation_info
string

Information to be displayed on public reservation screens. Overrides value from Event

specific_capacity
integer

Specific capacity if different from venue

start_public_sales
string <date-time>

Start date and time of public sales

subtitle
string

Subtitle

tags
Array of strings

List of tags to be connected to entity

ticket_description
string

Additional description on the ticket on this show if different from the event

ticket_image
string

Public identifier (pid) of an image

tickets_per_booking
integer

Maximum allowed number of tickets per booking.

Responses

Request samples

Content type
application/json
{
  • "event": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "venue": "string",
  • "access_by": "host",
  • "allow_sales_while_current": true,
  • "allow_single_empty_seats": true,
  • "always_display_start_time": true,
  • "reservation_info": "string",
  • "block_seats_of_show": "string",
  • "dooropening": "2019-08-24T14:15:22Z",
  • "enable_passbook_tickets": true,
  • "end": "2019-08-24T14:15:22Z",
  • "end_checkin": "2019-08-24T14:15:22Z",
  • "end_sales": "2019-08-24T14:15:22Z",
  • "end_sales_alternative": "string",
  • "image": "string",
  • "is_cancelled": true,
  • "is_online_show": true,
  • "name": "string",
  • "operator_group": "string",
  • "order": 0,
  • "passbook_image": "string",
  • "performer": "string",
  • "request_ratings": true,
  • "specific_capacity": 0,
  • "start_public_sales": "2019-08-24T14:15:22Z",
  • "ticket_description": "string",
  • "ticket_image": "string",
  • "tickets_per_booking": 0,
  • "subtitle": "string",
  • "description": "string",
  • "tags": [
    ]
}

Get the event of a show

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "timespan": { },
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "performer": "string",
  • "ticketdescription": "string",
  • "description": "string",
  • "delivery_info": "string",
  • "confirmation_extras_template": "string",
  • "will_call_label": "string",
  • "pay_before_dispatch": false,
  • "immediate_payment_only": false,
  • "send_reminders": true,
  • "delete_unpaid_bookings_mode": "never",
  • "allow_digital_dispatch": true,
  • "allow_deliveries": false,
  • "allow_will_call": false,
  • "issue_tickets": true,
  • "enable_passbook_tickets": true,
  • "require_customer_company": false,
  • "require_customer_address": true,
  • "require_customer_phone": false,
  • "prompt_customer_position": false,
  • "prompt_customer_department": false,
  • "prompt_customer_title": false,
  • "prompt_customer_birthday": false,
  • "allow_customer_notes": false,
  • "allow_invoice_address": false,
  • "allow_single_empty_seats": true,
  • "is_hidden": false,
  • "excluded_from_revenue_stats": false,
  • "tickets_per_booking": 1,
  • "tickets_in_listings": 1,
  • "refine_info": "string",
  • "reservation_info": "string",
  • "sales_point_info": "string",
  • "support_info": "string",
  • "payout_interval": "string",
  • "payout_interval_specification": "string",
  • "is_cancelled": true,
  • "will_be_postponed": true,
  • "cancellation_info": "string",
  • "invoice_address": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "notify_on_new_booking": false,
  • "notification_email": "string",
  • "fee_percentage": "string",
  • "fee_minimal_commission": "string",
  • "fee_free_ticket_commission": "string",
  • "fee_included_free_tickets_percentage": 100,
  • "fee_payment_base_commission": "string",
  • "fee_payment_percentage": "string",
  • "_links": {
    }
}

Get the tickets of a show

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "_links": {
    },
  • "discr": "ticket"
}

Get the sales quota sets of a show

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "name": "string",
  • "chart_channel_id": "string",
  • "_links": {
    }
}

Get the venue of a show

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "capacity": 0,
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "internalname": "string",
  • "address": "string",
  • "zip": "string",
  • "city": "string",
  • "country": "string",
  • "is_adhoc_venue": true,
  • "is_archived": true,
  • "is_virtual": true,
  • "skidata_uri": "string",
  • "skidata_receiver": 0,
  • "skidata_issuer": 0,
  • "skidata_white_list_record_class": "string",
  • "skidata_last_fetch": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the image of a show

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "description": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the ticket image of a show

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "description": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the user of a show

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "person": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z"
}

Get the bookings of a show

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid_readable": "string",
  • "confirmation": true,
  • "delivery_method": "string",
  • "tickets_breakdown": { },
  • "pay_before_dispatch": true,
  • "is_dispatchable": true,
  • "urls": { },
  • "invoice_urls": { },
  • "denormalized_customer_pid": "string",
  • "denormalized_customer_fullname": "string",
  • "denormalized_customer_name_and_city": "string",
  • "denormalized_customer_country": "string",
  • "pid": 0,
  • "destination_country": "string",
  • "affiliate_id": "string",
  • "origin": "string",
  • "user_agent": "string",
  • "remote_address": "string",
  • "from_embed": true,
  • "source": "string",
  • "embed_session_id": "string",
  • "tos": true,
  • "digital_dispatch": true,
  • "delivery": true,
  • "will_call": true,
  • "deleted_by_customer": true,
  • "pos": true,
  • "internal_notes": "string",
  • "external_notes": "string",
  • "invoice_address": "string",
  • "checkbox_values": [
    ],
  • "payment_status_code": 0,
  • "first_full_payment": "2019-08-24T14:15:22Z",
  • "due_date": "2019-08-24T14:15:22Z",
  • "send_reminders": true,
  • "delete_if_unpaid": true,
  • "reminded_that_unpaid_at": "2019-08-24T14:15:22Z",
  • "next_reminder": "2019-08-24T14:15:22Z",
  • "refund_bank_account": "string",
  • "refund_bank_account_owner": "string",
  • "refund_bank_account_city": "string",
  • "approved": "2019-08-24T14:15:22Z",
  • "rejected": "2019-08-24T14:15:22Z",
  • "approval_requested": true,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": null,
  • "_links": {
    }
}

Get the prices of a show

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "_links": {
    },
  • "discr": "price"
}

Get the options of an show

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "price_excluding_vat": 0,
  • "price_including_vat": 0,
  • "vat_amount": 0,
  • "vat_rate": 0,
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "description": "string",
  • "order": 0,
  • "limitation": 0,
  • "margin": 0,
  • "items_per_booking": 1,
  • "requires_code": false,
  • "option_variables": [
    ],
  • "access_by": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "custom_fee_percentage": "string",
  • "price": "string",
  • "_links": {
    }
}

Get the coupon groups of a show

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": null,
  • "name": "string",
  • "code_format": "string",
  • "value_absolute": "string",
  • "value_percent": 1,
  • "value_max": "string",
  • "value_one_ticket": true,
  • "apply_to_tickets_only": false,
  • "allow_redemptions": 1,
  • "maximal_ticket_value": "string",
  • "minimal_booking_value": "string",
  • "max_coupons_per_booking": 0,
  • "expiration": "2019-08-24T14:15:22Z",
  • "available_in_shop": false,
  • "paid": false,
  • "for_individual_values": false,
  • "order": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the ticket option groups of a show

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "description": "string",
  • "placeholder": "string",
  • "order": 0,
  • "searchable": false,
  • "required": false,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "editable_by_buyer": true,
  • "_links": {
    }
}

Get the annotation values of a show.

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "value": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the excel lists of a show.

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "name": "string",
  • "iterator": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the invitations of a show

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "code": "string",
  • "expiration": "2019-08-24T14:15:22Z",
  • "personal": true,
  • "single_use": true,
  • "tickets_max_per_show": 0,
  • "tickets_max_per_event": 0,
  • "tickets_max_total": 0,
  • "tickets_max_per_booking": 0,
  • "max_different_shows": 0,
  • "rsvp": true,
  • "declined_at": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Slot

A Slot represents a specific time period for which a specific Job needs to done by a certain number of people. In the staff module, that is.

Get all slots

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "pid": "string",
  • "number_of_people": 0,
  • "job": {
    },
  • "date": "2019-08-24T14:15:22Z",
  • "time_start": "2019-08-24T14:15:22Z",
  • "time_end": "2019-08-24T14:15:22Z",
  • "time_meeting": "2019-08-24T14:15:22Z",
  • "head": null,
  • "deputy_head": null,
  • "staff_members": [
    ],
  • "batch_id": "string",
  • "batch_order": 0,
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get a single slot

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "pid": "string",
  • "number_of_people": 0,
  • "job": {
    },
  • "date": "2019-08-24T14:15:22Z",
  • "time_start": "2019-08-24T14:15:22Z",
  • "time_end": "2019-08-24T14:15:22Z",
  • "time_meeting": "2019-08-24T14:15:22Z",
  • "head": null,
  • "deputy_head": null,
  • "staff_members": [
    ],
  • "batch_id": "string",
  • "batch_order": 0,
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete a slot

path Parameters
pid
required
string

Responses

StaffMembers

A StaffMember is a Person who happens to have been assigned to a Slot in the staff module.

Get all staff members

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "pid": "string",
  • "project": {
    },
  • "notes": "string",
  • "person": {
    },
  • "departments": [
    ],
  • "slots": [
    ],
  • "batch_id": "string",
  • "batch_order": 0,
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get a single staff member

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "pid": "string",
  • "project": {
    },
  • "notes": "string",
  • "person": {
    },
  • "departments": [
    ],
  • "slots": [
    ],
  • "batch_id": "string",
  • "batch_order": 0,
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete a Staff Member

path Parameters
pid
required
string

Responses

Ticket

That's what it's all about. A Ticket is defined by Price, Show, and Sector or Seat. This reserves one spot in a Show. A Ticket is often represented as a QR code in a PDF or some other ticket format.

Get all tickets

Responses

Response samples

Content type
application/json
Example
{
  • "_links": {
    },
  • "discr": "ticket"
}

Create one or multiple tickets

Request Body schema: application/json
booking
required
string

Public identifier (pid) of a booking

show
required
string

Public identifier (pid) of a show

code
string

Code to be used as ticket qr code

confirmation
boolean

Set true to confirm a ticket. A ticket must have an already confirmed booking to be confirmed.

package
string

Public identifier (pid) of a package

price
string

Public identifier (pid) of a price

sales_quota
string

Public identifier (pid) of a salesquota

sales_quota_set
string

Public identifier (pid) of a salesquota set

seat
string

Public identifier (pid) of a seat

sector
string

Public identifier (pid) of a sector

ticket_options
Array of strings

A list of public identifiers (pids) of ticket options

Responses

Request samples

Content type
application/json
{
  • "booking": "string",
  • "show": "string",
  • "code": "string",
  • "confirmation": true,
  • "package": "string",
  • "price": "string",
  • "sales_quota_set": "string",
  • "sales_quota": "string",
  • "seat": "string",
  • "sector": "string",
  • "ticket_options": [
    ]
}

Get only head data of GET request

Responses

Update one or multiple tickets

Request Body schema: application/json
booking
required
string

Public identifier (pid) of a booking

show
required
string

Public identifier (pid) of a show

code
string

Code to be used as ticket qr code

confirmation
boolean

Set true to confirm a ticket. A ticket must have an already confirmed booking to be confirmed.

package
string

Public identifier (pid) of a package

price
string

Public identifier (pid) of a price

sales_quota
string

Public identifier (pid) of a salesquota

sales_quota_set
string

Public identifier (pid) of a salesquota set

seat
string

Public identifier (pid) of a seat

sector
string

Public identifier (pid) of a sector

ticket_options
Array of strings

A list of public identifiers (pids) of ticket options

Responses

Request samples

Content type
application/json
{
  • "booking": "string",
  • "show": "string",
  • "code": "string",
  • "confirmation": true,
  • "package": "string",
  • "price": "string",
  • "sales_quota_set": "string",
  • "sales_quota": "string",
  • "seat": "string",
  • "sector": "string",
  • "ticket_options": [
    ]
}

Get a single ticket

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "_links": {
    },
  • "discr": "ticket"
}

Delete a ticket

path Parameters
pid
required
string

Responses

Update a single ticket

path Parameters
pid
required
string
Request Body schema: application/json
booking
required
string

Public identifier (pid) of a booking

show
required
string

Public identifier (pid) of a show

code
string

Code to be used as ticket qr code

confirmation
boolean

Set true to confirm a ticket. A ticket must have an already confirmed booking to be confirmed.

package
string

Public identifier (pid) of a package

price
string

Public identifier (pid) of a price

sales_quota
string

Public identifier (pid) of a salesquota

sales_quota_set
string

Public identifier (pid) of a salesquota set

seat
string

Public identifier (pid) of a seat

sector
string

Public identifier (pid) of a sector

ticket_options
Array of strings

A list of public identifiers (pids) of ticket options

Responses

Request samples

Content type
application/json
{
  • "booking": "string",
  • "show": "string",
  • "code": "string",
  • "confirmation": true,
  • "package": "string",
  • "price": "string",
  • "sales_quota_set": "string",
  • "sales_quota": "string",
  • "seat": "string",
  • "sector": "string",
  • "ticket_options": [
    ]
}

Get the booking of a ticket

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid_readable": "string",
  • "confirmation": true,
  • "delivery_method": "string",
  • "tickets_breakdown": { },
  • "pay_before_dispatch": true,
  • "is_dispatchable": true,
  • "urls": { },
  • "invoice_urls": { },
  • "denormalized_customer_pid": "string",
  • "denormalized_customer_fullname": "string",
  • "denormalized_customer_name_and_city": "string",
  • "denormalized_customer_country": "string",
  • "pid": 0,
  • "destination_country": "string",
  • "affiliate_id": "string",
  • "origin": "string",
  • "user_agent": "string",
  • "remote_address": "string",
  • "from_embed": true,
  • "source": "string",
  • "embed_session_id": "string",
  • "tos": true,
  • "digital_dispatch": true,
  • "delivery": true,
  • "will_call": true,
  • "deleted_by_customer": true,
  • "pos": true,
  • "internal_notes": "string",
  • "external_notes": "string",
  • "invoice_address": "string",
  • "checkbox_values": [
    ],
  • "payment_status_code": 0,
  • "first_full_payment": "2019-08-24T14:15:22Z",
  • "due_date": "2019-08-24T14:15:22Z",
  • "send_reminders": true,
  • "delete_if_unpaid": true,
  • "reminded_that_unpaid_at": "2019-08-24T14:15:22Z",
  • "next_reminder": "2019-08-24T14:15:22Z",
  • "refund_bank_account": "string",
  • "refund_bank_account_owner": "string",
  • "refund_bank_account_city": "string",
  • "approved": "2019-08-24T14:15:22Z",
  • "rejected": "2019-08-24T14:15:22Z",
  • "approval_requested": true,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": null,
  • "_links": {
    }
}

Get the show of a ticket

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "access_role": "string",
  • "beacon_data": { },
  • "translations": { },
  • "pid": "string",
  • "performer": "string",
  • "ticketdescription": "string",
  • "description": "string",
  • "subtitle": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "end_check_in": "2019-08-24T14:15:22Z",
  • "start_public_sales": "2019-08-24T14:15:22Z",
  • "end_sales": "2019-08-24T14:15:22Z",
  • "end_sales_alternative": "string",
  • "dooropening": "2019-08-24T14:15:22Z",
  • "specific_capacity": 1,
  • "allow_sales_while_current": false,
  • "allow_single_empty_seats": true,
  • "always_display_start_time": false,
  • "reservation_info": "string",
  • "request_ratings": false,
  • "order": 0,
  • "is_cancelled": true,
  • "will_be_postponed": true,
  • "is_online_show": true,
  • "online_show": {
    },
  • "tickets_per_booking": 1,
  • "enable_passbook_tickets": true,
  • "access_by": "string",
  • "ratings_requested": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the price of a ticket

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "_links": {
    },
  • "discr": "price"
}

Get the sector of a ticket

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "access_role": "string",
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "description": "string",
  • "capacity": 1,
  • "price_category": {
    },
  • "order": 0,
  • "seating_chart_area": 1,
  • "chart_sector_id": "string",
  • "seat_string_template": "string",
  • "access_by": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the seat of a ticket

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "access_role": "string",
  • "translations": { },
  • "pid": "string",
  • "label": "string",
  • "chart_seat_id": "string",
  • "price_category": {
    },
  • "seat_string_template": "string",
  • "capacity_count": 0,
  • "access_by": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the emails of a ticket

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "receiver_email": "string",
  • "from_email": "string",
  • "from_name": "string",
  • "reply_to_email": "string",
  • "reply_to_name": "string",
  • "subject": "string",
  • "text": "string",
  • "text_moved_to_storage": false,
  • "html": "string",
  • "html_moved_to_storage": false,
  • "attachments": [ ],
  • "sent": "2019-08-24T14:15:22Z",
  • "failed": "2019-08-24T14:15:22Z",
  • "failed_type": "string",
  • "opened": "2019-08-24T14:15:22Z",
  • "bounced": "2019-08-24T14:15:22Z",
  • "bounced_type": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the access checks of a ticket

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "direction": "string",
  • "origin": "string",
  • "device_identifier": "string",
  • "checked": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the annotation values of a ticket

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "value": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

TicketOption

A TicketOption is a single selectable element within a TicketOptionGroup. For example the «vegetarian meal» to be assigned to a single Ticket.

Get all ticket options

Responses

Response samples

Content type
application/json
{
  • "ticket_option_group_pid": "string",
  • "ticket_option_group_name": "string",
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "ticket_info": "string",
  • "description": "string",
  • "all_or_nothing": false,
  • "order": 0,
  • "notify_on_new_booking": true,
  • "notification_email_address": "string",
  • "access_by": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "available_until_minutes_before_show_start": 0,
  • "custom_fee_percentage": "string",
  • "price": "string",
  • "_links": {
    }
}

Create one or multiple ticket options

Request Body schema: application/json
description
required
string

Option description

ticket_option_group
required
string

Public identifier (pid) of a ticket option group

access_by
string
Value: "host"

Who may see this ticket option. Set to null for public.

available_until_minutes_before_show_start
integer

Until how many minutes before show start the ticket option is available to select

image
string

Public identifier (pid) of an image

name
string

Option name

notification_email
string

Email address to receive notifications about new bookings, if activated

notify_on_new_booking
boolean

Flag whether the host shall be notified on new bookings. Defaults to false.

order
integer

Order index in lists (lowest to highest)

price
any

Price

prices
Array of strings

A list of public identifiers (pid) of prices

ticket_info
string

Additional information to be shown on tickets

vat
string

Public identifier (pid) of a vat

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "ticket_option_group": "string",
  • "access_by": "host",
  • "available_until_minutes_before_show_start": 0,
  • "description": "string",
  • "price": null,
  • "image": "string",
  • "notification_email": "string",
  • "notify_on_new_booking": true,
  • "order": 0,
  • "prices": [
    ],
  • "ticket_info": "string",
  • "vat": "string"
}

Get only head data of GET request

Responses

Update one or multiple ticket options

Request Body schema: application/json
description
required
string

Option description

ticket_option_group
required
string

Public identifier (pid) of a ticket option group

access_by
string
Value: "host"

Who may see this ticket option. Set to null for public.

available_until_minutes_before_show_start
integer

Until how many minutes before show start the ticket option is available to select

image
string

Public identifier (pid) of an image

name
string

Option name

notification_email
string

Email address to receive notifications about new bookings, if activated

notify_on_new_booking
boolean

Flag whether the host shall be notified on new bookings. Defaults to false.

order
integer

Order index in lists (lowest to highest)

price
any

Price

prices
Array of strings

A list of public identifiers (pid) of prices

ticket_info
string

Additional information to be shown on tickets

vat
string

Public identifier (pid) of a vat

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "ticket_option_group": "string",
  • "access_by": "host",
  • "available_until_minutes_before_show_start": 0,
  • "description": "string",
  • "price": null,
  • "image": "string",
  • "notification_email": "string",
  • "notify_on_new_booking": true,
  • "order": 0,
  • "prices": [
    ],
  • "ticket_info": "string",
  • "vat": "string"
}

Get a single ticket option

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "ticket_option_group_pid": "string",
  • "ticket_option_group_name": "string",
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "ticket_info": "string",
  • "description": "string",
  • "all_or_nothing": false,
  • "order": 0,
  • "notify_on_new_booking": true,
  • "notification_email_address": "string",
  • "access_by": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "available_until_minutes_before_show_start": 0,
  • "custom_fee_percentage": "string",
  • "price": "string",
  • "_links": {
    }
}

Delete a ticket option

path Parameters
pid
required
string

Responses

Update a single ticket option

path Parameters
pid
required
string
Request Body schema: application/json
description
required
string

Option description

ticket_option_group
required
string

Public identifier (pid) of a ticket option group

access_by
string
Value: "host"

Who may see this ticket option. Set to null for public.

available_until_minutes_before_show_start
integer

Until how many minutes before show start the ticket option is available to select

image
string

Public identifier (pid) of an image

name
string

Option name

notification_email
string

Email address to receive notifications about new bookings, if activated

notify_on_new_booking
boolean

Flag whether the host shall be notified on new bookings. Defaults to false.

order
integer

Order index in lists (lowest to highest)

price
any

Price

prices
Array of strings

A list of public identifiers (pid) of prices

ticket_info
string

Additional information to be shown on tickets

vat
string

Public identifier (pid) of a vat

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "ticket_option_group": "string",
  • "access_by": "host",
  • "available_until_minutes_before_show_start": 0,
  • "description": "string",
  • "price": null,
  • "image": "string",
  • "notification_email": "string",
  • "notify_on_new_booking": true,
  • "order": 0,
  • "prices": [
    ],
  • "ticket_info": "string",
  • "vat": "string"
}

Get the ticket option group of a ticket option

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "description": "string",
  • "placeholder": "string",
  • "order": 0,
  • "searchable": false,
  • "required": false,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "editable_by_buyer": true,
  • "_links": {
    }
}

Get the ticket option sets of a ticket option.

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "pid": "string",
  • "min": 1,
  • "max": 1,
  • "error_message_min": "string",
  • "error_message_max": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "batch_id": "string",
  • "batch_order": 0,
  • "_links": {
    }
}

Get the ticket option limitations of a ticket option

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "description": "string",
  • "limitation": 0,
  • "max_different_bookings": 0,
  • "margin": 0,
  • "scope": "show",
  • "error_message": "string",
  • "editable_by_host": false,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z"
}

Get the prices of a ticket option

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "_links": {
    },
  • "discr": "price"
}

Get the annotationValues of a ticket option

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "value": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

TicketOptionExclusion

A TicketOptionExclusion defines two TicketOptions which must not be combined within a single Ticket. This can be used if for example you can select workshops within multiple TicketOptionGroups, but some of them overlap in time.

Get all ticket option exclusions

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Create one or multiple ticket option exclusion

Request Body schema: application/json
object
required
string

Public identifier (pid) of TicketOption

subject
required
string

Public identifier (pid) of TicketOption

price
string

Public identifier (pid) of Price

Responses

Request samples

Content type
application/json
{
  • "object": "string",
  • "subject": "string",
  • "price": "string"
}

Get only head data of GET request

Responses

Update one or multiple ticket option exclusions

Request Body schema: application/json
object
required
string

Public identifier (pid) of TicketOption

subject
required
string

Public identifier (pid) of TicketOption

price
string

Public identifier (pid) of Price

Responses

Request samples

Content type
application/json
{
  • "object": "string",
  • "subject": "string",
  • "price": "string"
}

Get a single ticket option exclusion

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Delete a ticket option exclusion

path Parameters
pid
required
string

Responses

Update a single ticket option exclusions

path Parameters
pid
required
string
Request Body schema: application/json
object
required
string

Public identifier (pid) of TicketOption

subject
required
string

Public identifier (pid) of TicketOption

price
string

Public identifier (pid) of Price

Responses

Request samples

Content type
application/json
{
  • "object": "string",
  • "subject": "string",
  • "price": "string"
}

Get the price of a ticket option exclusion

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "_links": {
    },
  • "discr": "price"
}

Get the object of a ticket option exclusion

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "ticket_option_group_pid": "string",
  • "ticket_option_group_name": "string",
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "ticket_info": "string",
  • "description": "string",
  • "all_or_nothing": false,
  • "order": 0,
  • "notify_on_new_booking": true,
  • "notification_email_address": "string",
  • "access_by": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "available_until_minutes_before_show_start": 0,
  • "custom_fee_percentage": "string",
  • "price": "string",
  • "_links": {
    }
}

Get the subject of a ticket option exclusion

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "ticket_option_group_pid": "string",
  • "ticket_option_group_name": "string",
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "ticket_info": "string",
  • "description": "string",
  • "all_or_nothing": false,
  • "order": 0,
  • "notify_on_new_booking": true,
  • "notification_email_address": "string",
  • "access_by": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "available_until_minutes_before_show_start": 0,
  • "custom_fee_percentage": "string",
  • "price": "string",
  • "_links": {
    }
}

TicketOptionGroup

A TicketOptionGroup defines a set of options for the ticket buyer to choose from. For example, the TicketOptionGroup might be named «Choose your meal» and would contain the TicketOptions «meat» and «vegetarian».

Get all ticket option groups

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "description": "string",
  • "placeholder": "string",
  • "order": 0,
  • "searchable": false,
  • "required": false,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "editable_by_buyer": true,
  • "_links": {
    }
}

Create one or multiple ticket option groups

Request Body schema: application/json
event
required
string

Public identifier (pid) of an event

name
required
string

Name

depends_on
string

Public identifier (pid) of a ticket option

description
string

Additional description

editable_by_buyer
boolean

Flag whether buyers are allow to edit the selected ticket option on existing bookings. Defaults to false.

order
integer

Order index in lists (lowest to highest)

placeholder
string

Dropdown placeholder text

required
boolean

Flag whether an option must be selected within ticket option group

searchable
boolean

Flag whether the options within this ticket option group should be displayed in a searchable way

show
string

Public identifier (pid) of a show

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "depends_on": "string",
  • "description": "string",
  • "editable_by_buyer": true,
  • "event": "string",
  • "order": 0,
  • "placeholder": "string",
  • "required": true,
  • "searchable": true,
  • "show": "string"
}

Get only head data of GET request

Responses

Update one or multiple ticket option groups

Request Body schema: application/json
event
required
string

Public identifier (pid) of an event

name
required
string

Name

depends_on
string

Public identifier (pid) of a ticket option

description
string

Additional description

editable_by_buyer
boolean

Flag whether buyers are allow to edit the selected ticket option on existing bookings. Defaults to false.

order
integer

Order index in lists (lowest to highest)

placeholder
string

Dropdown placeholder text

required
boolean

Flag whether an option must be selected within ticket option group

searchable
boolean

Flag whether the options within this ticket option group should be displayed in a searchable way

show
string

Public identifier (pid) of a show

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "depends_on": "string",
  • "description": "string",
  • "editable_by_buyer": true,
  • "event": "string",
  • "order": 0,
  • "placeholder": "string",
  • "required": true,
  • "searchable": true,
  • "show": "string"
}

Get a single ticket option groups

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "description": "string",
  • "placeholder": "string",
  • "order": 0,
  • "searchable": false,
  • "required": false,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "editable_by_buyer": true,
  • "_links": {
    }
}

Delete a ticket option group

path Parameters
pid
required
string

Responses

Update a ticket option group

path Parameters
pid
required
string
Request Body schema: application/json
event
required
string

Public identifier (pid) of an event

name
required
string

Name

depends_on
string

Public identifier (pid) of a ticket option

description
string

Additional description

editable_by_buyer
boolean

Flag whether buyers are allow to edit the selected ticket option on existing bookings. Defaults to false.

order
integer

Order index in lists (lowest to highest)

placeholder
string

Dropdown placeholder text

required
boolean

Flag whether an option must be selected within ticket option group

searchable
boolean

Flag whether the options within this ticket option group should be displayed in a searchable way

show
string

Public identifier (pid) of a show

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "depends_on": "string",
  • "description": "string",
  • "editable_by_buyer": true,
  • "event": "string",
  • "order": 0,
  • "placeholder": "string",
  • "required": true,
  • "searchable": true,
  • "show": "string"
}

Get the event of a ticket option group

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "timespan": { },
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "performer": "string",
  • "ticketdescription": "string",
  • "description": "string",
  • "delivery_info": "string",
  • "confirmation_extras_template": "string",
  • "will_call_label": "string",
  • "pay_before_dispatch": false,
  • "immediate_payment_only": false,
  • "send_reminders": true,
  • "delete_unpaid_bookings_mode": "never",
  • "allow_digital_dispatch": true,
  • "allow_deliveries": false,
  • "allow_will_call": false,
  • "issue_tickets": true,
  • "enable_passbook_tickets": true,
  • "require_customer_company": false,
  • "require_customer_address": true,
  • "require_customer_phone": false,
  • "prompt_customer_position": false,
  • "prompt_customer_department": false,
  • "prompt_customer_title": false,
  • "prompt_customer_birthday": false,
  • "allow_customer_notes": false,
  • "allow_invoice_address": false,
  • "allow_single_empty_seats": true,
  • "is_hidden": false,
  • "excluded_from_revenue_stats": false,
  • "tickets_per_booking": 1,
  • "tickets_in_listings": 1,
  • "refine_info": "string",
  • "reservation_info": "string",
  • "sales_point_info": "string",
  • "support_info": "string",
  • "payout_interval": "string",
  • "payout_interval_specification": "string",
  • "is_cancelled": true,
  • "will_be_postponed": true,
  • "cancellation_info": "string",
  • "invoice_address": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "notify_on_new_booking": false,
  • "notification_email": "string",
  • "fee_percentage": "string",
  • "fee_minimal_commission": "string",
  • "fee_free_ticket_commission": "string",
  • "fee_included_free_tickets_percentage": 100,
  • "fee_payment_base_commission": "string",
  • "fee_payment_percentage": "string",
  • "_links": {
    }
}

Get the show of a ticket option group

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "access_role": "string",
  • "beacon_data": { },
  • "translations": { },
  • "pid": "string",
  • "performer": "string",
  • "ticketdescription": "string",
  • "description": "string",
  • "subtitle": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "end_check_in": "2019-08-24T14:15:22Z",
  • "start_public_sales": "2019-08-24T14:15:22Z",
  • "end_sales": "2019-08-24T14:15:22Z",
  • "end_sales_alternative": "string",
  • "dooropening": "2019-08-24T14:15:22Z",
  • "specific_capacity": 1,
  • "allow_sales_while_current": false,
  • "allow_single_empty_seats": true,
  • "always_display_start_time": false,
  • "reservation_info": "string",
  • "request_ratings": false,
  • "order": 0,
  • "is_cancelled": true,
  • "will_be_postponed": true,
  • "is_online_show": true,
  • "online_show": {
    },
  • "tickets_per_booking": 1,
  • "enable_passbook_tickets": true,
  • "access_by": "string",
  • "ratings_requested": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the ticket options of a ticket option group

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "ticket_option_group_pid": "string",
  • "ticket_option_group_name": "string",
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "ticket_info": "string",
  • "description": "string",
  • "all_or_nothing": false,
  • "order": 0,
  • "notify_on_new_booking": true,
  • "notification_email_address": "string",
  • "access_by": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "available_until_minutes_before_show_start": 0,
  • "custom_fee_percentage": "string",
  • "price": "string",
  • "_links": {
    }
}

TicketOptionLimitation

A TicketOptionLimitation defines how often a TicketOption (or the sum of multiple TicketOptions) may be booked. This is used to limit the number of TicketOptions if less of them are available than there are tickets.

Get all ticket option limitations

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "description": "string",
  • "limitation": 0,
  • "max_different_bookings": 0,
  • "margin": 0,
  • "scope": "show",
  • "error_message": "string",
  • "editable_by_host": false,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z"
}

Create one or multiple ticket option limitations

Request Body schema: application/json
limitation
required
integer

Max number of tickets which may be booked with this ticket option

scope
required
string
Enum: "show" "event"

Scope this limitation applies to

ticket_options
required
Array of strings

A list of public identifiers (pid) of a ticket options

description
string

Description of this limitation

editable_by_host
boolean

Flag whether this limitation should be editable in GUI.

error_message
string

Error message to be display if the limitation is reached

margin
integer

Flexibility on limitation if booked within the same booking

max_different_bookings
integer

Max number of different bookings which may contain this ticket option

show
string

Public identifier (pid) of a show

Responses

Request samples

Content type
application/json
{
  • "limitation": 0,
  • "ticket_options": [
    ],
  • "description": "string",
  • "max_different_bookings": 0,
  • "margin": 0,
  • "scope": "show",
  • "show": "string",
  • "error_message": "string",
  • "editable_by_host": true
}

Get only head data of GET request

Responses

Update one or multiple ticket option limitations

Request Body schema: application/json
limitation
required
integer

Max number of tickets which may be booked with this ticket option

scope
required
string
Enum: "show" "event"

Scope this limitation applies to

ticket_options
required
Array of strings

A list of public identifiers (pid) of a ticket options

description
string

Description of this limitation

editable_by_host
boolean

Flag whether this limitation should be editable in GUI.

error_message
string

Error message to be display if the limitation is reached

margin
integer

Flexibility on limitation if booked within the same booking

max_different_bookings
integer

Max number of different bookings which may contain this ticket option

show
string

Public identifier (pid) of a show

Responses

Request samples

Content type
application/json
{
  • "limitation": 0,
  • "ticket_options": [
    ],
  • "description": "string",
  • "max_different_bookings": 0,
  • "margin": 0,
  • "scope": "show",
  • "show": "string",
  • "error_message": "string",
  • "editable_by_host": true
}

Get a single ticket option limitation

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "description": "string",
  • "limitation": 0,
  • "max_different_bookings": 0,
  • "margin": 0,
  • "scope": "show",
  • "error_message": "string",
  • "editable_by_host": false,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z"
}

Delete a ticket option limitation

path Parameters
pid
required
string

Responses

Update a ticket option limitation

path Parameters
pid
required
string
Request Body schema: application/json
limitation
required
integer

Max number of tickets which may be booked with this ticket option

scope
required
string
Enum: "show" "event"

Scope this limitation applies to

ticket_options
required
Array of strings

A list of public identifiers (pid) of a ticket options

description
string

Description of this limitation

editable_by_host
boolean

Flag whether this limitation should be editable in GUI.

error_message
string

Error message to be display if the limitation is reached

margin
integer

Flexibility on limitation if booked within the same booking

max_different_bookings
integer

Max number of different bookings which may contain this ticket option

show
string

Public identifier (pid) of a show

Responses

Request samples

Content type
application/json
{
  • "limitation": 0,
  • "ticket_options": [
    ],
  • "description": "string",
  • "max_different_bookings": 0,
  • "margin": 0,
  • "scope": "show",
  • "show": "string",
  • "error_message": "string",
  • "editable_by_host": true
}

TicketOptionSet

A TicketOptionSet allows to specify the minimum/maximum number of specific TicketOptions that must be booked along with a Ticket of a specific Price.

Get all ticket option sets

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "pid": "string",
  • "min": 1,
  • "max": 1,
  • "error_message_min": "string",
  • "error_message_max": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "batch_id": "string",
  • "batch_order": 0,
  • "_links": {
    }
}

Create one or multiple ticket option sets

Request Body schema: application/json
ticket_options
required
string

List of public identifiers (pid) of ticket options

error_message_max
string

Error message for breach of max restriction

error_message_min
string

Error message for breach of min restriction

max
integer

Maximum quantity of ticket options

min
integer

Minimal quantity of ticket options

price
string

Public identifier (pid) of a price

Responses

Request samples

Content type
application/json
{
  • "error_message_max": "string",
  • "error_message_min": "string",
  • "max": 0,
  • "min": 0,
  • "price": "string",
  • "ticket_options": "string"
}

Get only head data of GET request

Responses

Update one or multiple ticket option sets

Request Body schema: application/json
ticket_options
required
string

List of public identifiers (pid) of ticket options

error_message_max
string

Error message for breach of max restriction

error_message_min
string

Error message for breach of min restriction

max
integer

Maximum quantity of ticket options

min
integer

Minimal quantity of ticket options

price
string

Public identifier (pid) of a price

Responses

Request samples

Content type
application/json
{
  • "error_message_max": "string",
  • "error_message_min": "string",
  • "max": 0,
  • "min": 0,
  • "price": "string",
  • "ticket_options": "string"
}

Get a single ticket option set

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "pid": "string",
  • "min": 1,
  • "max": 1,
  • "error_message_min": "string",
  • "error_message_max": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "batch_id": "string",
  • "batch_order": 0,
  • "_links": {
    }
}

Delete a ticket option set

path Parameters
pid
required
string

Responses

Update a single ticket option sets

path Parameters
pid
required
string
Request Body schema: application/json
ticket_options
required
string

List of public identifiers (pid) of ticket options

error_message_max
string

Error message for breach of max restriction

error_message_min
string

Error message for breach of min restriction

max
integer

Maximum quantity of ticket options

min
integer

Minimal quantity of ticket options

price
string

Public identifier (pid) of a price

Responses

Request samples

Content type
application/json
{
  • "error_message_max": "string",
  • "error_message_min": "string",
  • "max": 0,
  • "min": 0,
  • "price": "string",
  • "ticket_options": "string"
}

Get the price of a ticket option set

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "_links": {
    },
  • "discr": "price"
}

Get the ticket options of a ticket option set

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "ticket_option_group_pid": "string",
  • "ticket_option_group_name": "string",
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "ticket_info": "string",
  • "description": "string",
  • "all_or_nothing": false,
  • "order": 0,
  • "notify_on_new_booking": true,
  • "notification_email_address": "string",
  • "access_by": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "available_until_minutes_before_show_start": 0,
  • "custom_fee_percentage": "string",
  • "price": "string",
  • "_links": {
    }
}

TicketOptionTimeLimitation

A TicketOptionTimeLimitation allows to specify until when a TicketOption is bookable on a specific Show. Example: A theatre is selling meals as a TicketOption. On weekends, the meal must be booked until 9am. On other days, it may be booked until 16pm. With TicketOptionTimeLimitations this can be specified with using the same TicketOption for all Shows.

Get all ticket option time limitations

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "ticket_option": {
    },
  • "show": {
    },
  • "end_of_availability": "2019-08-24T14:15:22Z"
}

Create one or multiple ticket option time limitations

Request Body schema: application/json
end_of_availability
required
string <date-time>

Date and time from when ticket option will not be available anymore

show
required
string

Public identifier (pid) of a show

ticket_option
required
string

Public identifier (pid) of a ticket option

Responses

Request samples

Content type
application/json
{
  • "end_of_availability": "2019-08-24T14:15:22Z",
  • "show": "string",
  • "ticket_option": "string"
}

Get only head data of GET request

Responses

Update one or multiple ticket option time limitations

Request Body schema: application/json
end_of_availability
required
string <date-time>

Date and time from when ticket option will not be available anymore

show
required
string

Public identifier (pid) of a show

ticket_option
required
string

Public identifier (pid) of a ticket option

Responses

Request samples

Content type
application/json
{
  • "end_of_availability": "2019-08-24T14:15:22Z",
  • "show": "string",
  • "ticket_option": "string"
}

Get a single ticket option time limitation

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "ticket_option": {
    },
  • "show": {
    },
  • "end_of_availability": "2019-08-24T14:15:22Z"
}

Delete a ticket option time limitation

path Parameters
pid
required
string

Responses

Update a ticket option time limitation

path Parameters
pid
required
string
Request Body schema: application/json
end_of_availability
required
string <date-time>

Date and time from when ticket option will not be available anymore

show
required
string

Public identifier (pid) of a show

ticket_option
required
string

Public identifier (pid) of a ticket option

Responses

Request samples

Content type
application/json
{
  • "end_of_availability": "2019-08-24T14:15:22Z",
  • "show": "string",
  • "ticket_option": "string"
}

User

A User represents somebody who has access to data on Ticketpark, either trough a login or by a personalized, pre-authenticated link.

Get all users

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "person": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z"
}

Create one or multiple users

Request Body schema: application/json
email
required
string

Email address

plain_password
required
string

Password in plain text

username
required
string

Username

enabled
boolean

Flag whether the user is enabled to login or not. Defaults to false.

groups
string

A collection of public identifiers (pids) of groups

person
string

Public identifier (pid) of a person

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "email": "string",
  • "plain_password": "string",
  • "enabled": true,
  • "groups": "string",
  • "person": "string"
}

Get only head data of GET request

Responses

Update one or multiple Users

Request Body schema: application/json
email
required
string

Email address

plain_password
required
string

Password in plain text

username
required
string

Username

enabled
boolean

Flag whether the user is enabled to login or not. Defaults to false.

groups
string

A collection of public identifiers (pids) of groups

person
string

Public identifier (pid) of a person

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "email": "string",
  • "plain_password": "string",
  • "enabled": true,
  • "groups": "string",
  • "person": "string"
}

Get a single user

path Parameters
usernameOrEmailOrToken
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "person": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z"
}

Delete a user

path Parameters
usernameOrEmail
required
string

Responses

Update a single user

path Parameters
usernameOrEmail
required
string
Request Body schema: application/json
email
required
string

Email address

plain_password
required
string

Password in plain text

username
required
string

Username

enabled
boolean

Flag whether the user is enabled to login or not. Defaults to false.

groups
string

A collection of public identifiers (pids) of groups

person
string

Public identifier (pid) of a person

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "email": "string",
  • "plain_password": "string",
  • "enabled": true,
  • "groups": "string",
  • "person": "string"
}

Get the groups of a user

path Parameters
usernameOrEmail
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z"
}

Get the person of a user

path Parameters
usernameOrEmail
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "person": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z"
}

VAT

VAT, as in value-added tax, is what can be applied to Prices and other payable elements.

Get all vats

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "country": "string",
  • "rate": "string",
  • "included": false,
  • "default_for_country": false,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get only head data of GET request

Responses

Get a single vat

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "country": "string",
  • "rate": "string",
  • "included": false,
  • "default_for_country": false,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Venue

A Venue is, where a Show takes place. It is a physical location, with an address and a defined capacity of people who may attend a Show.

Get all venues

Responses

Response samples

Content type
application/json
{
  • "capacity": 0,
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "internalname": "string",
  • "address": "string",
  • "zip": "string",
  • "city": "string",
  • "country": "string",
  • "is_adhoc_venue": true,
  • "is_archived": true,
  • "is_virtual": true,
  • "skidata_uri": "string",
  • "skidata_receiver": 0,
  • "skidata_issuer": 0,
  • "skidata_white_list_record_class": "string",
  • "skidata_last_fetch": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Create one or multiple venues

Request Body schema: application/json
host
required
string

Public identifier (pid) of a host

name
required
string

Venue name

address
string

Address

city
string

City

country
string

Country (2 letters, ISO 3166-1 alpha-2)

internal_name
string

Internal name (for the host)

is_adhoc_venue
boolean

Flag whether this is an adhoc venue. Defaults to false.

is_archived
boolean

Flag whether this venue is archived. Defaults to false,

is_virtual
boolean

Flag whether this venue is virtual, used for Packages in many Venues. Defaults to false.

skidata_issuer
integer

Skidata Issuer ID

skidata_receiver
integer

Skidata Receiver ID

skidata_uri
string

Uri to Skidata HSH server

skidata_white_list_record_class
string

Name of a class used as instances of skidata's WhiteListRecordInterface

zip
string

ZIP code

Responses

Request samples

Content type
application/json
{
  • "host": "string",
  • "name": "string",
  • "internal_name": "string",
  • "address": "string",
  • "zip": "string",
  • "city": "string",
  • "country": "string",
  • "is_adhoc_venue": true,
  • "is_archived": true,
  • "is_virtual": true,
  • "skidata_uri": "string",
  • "skidata_receiver": 0,
  • "skidata_issuer": 0,
  • "skidata_white_list_record_class": "string"
}

Get only head data of GET request

Responses

Update one or multiple venues

Request Body schema: application/json
host
required
string

Public identifier (pid) of a host

name
required
string

Venue name

address
string

Address

city
string

City

country
string

Country (2 letters, ISO 3166-1 alpha-2)

internal_name
string

Internal name (for the host)

is_adhoc_venue
boolean

Flag whether this is an adhoc venue. Defaults to false.

is_archived
boolean

Flag whether this venue is archived. Defaults to false,

is_virtual
boolean

Flag whether this venue is virtual, used for Packages in many Venues. Defaults to false.

skidata_issuer
integer

Skidata Issuer ID

skidata_receiver
integer

Skidata Receiver ID

skidata_uri
string

Uri to Skidata HSH server

skidata_white_list_record_class
string

Name of a class used as instances of skidata's WhiteListRecordInterface

zip
string

ZIP code

Responses

Request samples

Content type
application/json
{
  • "host": "string",
  • "name": "string",
  • "internal_name": "string",
  • "address": "string",
  • "zip": "string",
  • "city": "string",
  • "country": "string",
  • "is_adhoc_venue": true,
  • "is_archived": true,
  • "is_virtual": true,
  • "skidata_uri": "string",
  • "skidata_receiver": 0,
  • "skidata_issuer": 0,
  • "skidata_white_list_record_class": "string"
}

Get a single venue

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "capacity": 0,
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "internalname": "string",
  • "address": "string",
  • "zip": "string",
  • "city": "string",
  • "country": "string",
  • "is_adhoc_venue": true,
  • "is_archived": true,
  • "is_virtual": true,
  • "skidata_uri": "string",
  • "skidata_receiver": 0,
  • "skidata_issuer": 0,
  • "skidata_white_list_record_class": "string",
  • "skidata_last_fetch": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Delete a venue

path Parameters
pid
required
string

Responses

Update a single venue

path Parameters
pid
required
string
Request Body schema: application/json
host
required
string

Public identifier (pid) of a host

name
required
string

Venue name

address
string

Address

city
string

City

country
string

Country (2 letters, ISO 3166-1 alpha-2)

internal_name
string

Internal name (for the host)

is_adhoc_venue
boolean

Flag whether this is an adhoc venue. Defaults to false.

is_archived
boolean

Flag whether this venue is archived. Defaults to false,

is_virtual
boolean

Flag whether this venue is virtual, used for Packages in many Venues. Defaults to false.

skidata_issuer
integer

Skidata Issuer ID

skidata_receiver
integer

Skidata Receiver ID

skidata_uri
string

Uri to Skidata HSH server

skidata_white_list_record_class
string

Name of a class used as instances of skidata's WhiteListRecordInterface

zip
string

ZIP code

Responses

Request samples

Content type
application/json
{
  • "host": "string",
  • "name": "string",
  • "internal_name": "string",
  • "address": "string",
  • "zip": "string",
  • "city": "string",
  • "country": "string",
  • "is_adhoc_venue": true,
  • "is_archived": true,
  • "is_virtual": true,
  • "skidata_uri": "string",
  • "skidata_receiver": 0,
  • "skidata_issuer": 0,
  • "skidata_white_list_record_class": "string"
}

Get the host of a venue

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "care_of": "string",
  • "address1": "string",
  • "address2": "string",
  • "zip": "string",
  • "city": "string",
  • "country": "string",
  • "will_call_label": "string",
  • "will_call_instructions": "string",
  • "send_reminders": true,
  • "delete_unpaid_bookings": true,
  • "public_email": "string",
  • "public_email_sender_name": "string",
  • "public_phone": "string",
  • "website": "string",
  • "bank_account": "string",
  • "bank_account_owner": "string",
  • "bank_account_city": "string",
  • "invoice_address": "string",
  • "vat_number": "string",
  • "thank_you_close": "string",
  • "complimentary_close": "string",
  • "contact_text": "string",
  • "confirmation_extras_template": "string",
  • "tos_title": "string",
  • "tos": "string",
  • "saferpay_terminal_id": "string",
  • "shared_secret": "string",
  • "prompt_newsletter": false,
  • "prompt_acquisition_channel": false,
  • "execute_deliveries": true,
  • "check_newsletter_by_default": false,
  • "address_right": false,
  • "enable_crm": false,
  • "enable_staff": false,
  • "enable_invitations": false,
  • "enable_seat_category_changes": false,
  • "enable_remaining_voucher_value_handling": false,
  • "enable_donations": false,
  • "execute_payouts": true,
  • "cancellation_policy": "strict",
  • "enable_salutation": true,
  • "use_security_code": true,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "allow_user_to_delete_booking": true,
  • "allow_embed_session_id": true,
  • "allow_single_empty_seats": true,
  • "setup_information": "string",
  • "support_info": "string",
  • "notify_on_new_booking": false,
  • "notification_email": "string",
  • "fee_percentage": "string",
  • "fee_minimal_commission": "string",
  • "fee_free_ticket_commission": "string",
  • "fee_included_free_tickets_percentage": 100,
  • "fee_payment_base_commission": "string",
  • "fee_payment_percentage": "string",
  • "_links": {
    }
}

Get the shows of a venue

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "access_role": "string",
  • "beacon_data": { },
  • "translations": { },
  • "pid": "string",
  • "performer": "string",
  • "ticketdescription": "string",
  • "description": "string",
  • "subtitle": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "end_check_in": "2019-08-24T14:15:22Z",
  • "start_public_sales": "2019-08-24T14:15:22Z",
  • "end_sales": "2019-08-24T14:15:22Z",
  • "end_sales_alternative": "string",
  • "dooropening": "2019-08-24T14:15:22Z",
  • "specific_capacity": 1,
  • "allow_sales_while_current": false,
  • "allow_single_empty_seats": true,
  • "always_display_start_time": false,
  • "reservation_info": "string",
  • "request_ratings": false,
  • "order": 0,
  • "is_cancelled": true,
  • "will_be_postponed": true,
  • "is_online_show": true,
  • "online_show": {
    },
  • "tickets_per_booking": 1,
  • "enable_passbook_tickets": true,
  • "access_by": "string",
  • "ratings_requested": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get the sectors of a venue

path Parameters
pid
required
string

Responses

Response samples

Content type
application/json
{
  • "access_role": "string",
  • "translations": { },
  • "pid": "string",
  • "name": "string",
  • "description": "string",
  • "capacity": 1,
  • "price_category": {
    },
  • "order": 0,
  • "seating_chart_area": 1,
  • "chart_sector_id": "string",
  • "seat_string_template": "string",
  • "access_by": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}