Sign in
latestOpenAPI 3.1.12026-08-108026304.2 KB

7b222e8ec91c

Event series

Create an event occurrence

For the given event series ID, create an event

post/v1/event_series/{event_series_id}/events

Path parameters

event_series_idstring required

The unique identifier for the event series

Response

Successfully created a new event

objectstring
idstring

A unique identifier for the event occurrence

available_statusstring nullable

Optional custom status message when event is set to be available

chkstring

Used for Ticket Tailor checkout chk value

currency'gbp' | 'usd' | 'eur' | 'sgd' | 'aud' | 'brl' | 'cad' | 'czk' | 'dkk' | 'hkd' | 'huf' | 'ils' | 'jpy' | 'myr' | 'mxn' | 'nok' | 'nzd' | 'php' | 'pln' | 'rub' | 'sek' | 'chf' | 'twd' | 'thb' | 'try'

Information about the currency the event is configured to use

event_series_idstring

A unique identifier for the associated event series

hiddenstring

True, if event is set to hidden

online_linkstring nullable

URL of the online event

override_idstring nullable

A unique identifier for the associated override

revenuenumber

Total revenue of the event

sales_tax_labelstring nullable

The label for the sales tax

sales_tax_percentageinteger nullable

The percentage of the sales tax

sales_tax_treatment'inclusive' | 'exclusive' nullable

The treatment of the sales tax

max_tickets_sold_per_occurrenceinteger nullable

Maximum quantity of tickets that can be sold across all ticket types

tickets_availablestring nullable

Are there any ticket types available?

total_issued_ticketsinteger

Total number of issued tickets

transaction_fee_fixed_amountinteger nullable

Fixed amount of the transaction fee

transaction_fee_percentageinteger nullable

Percentage of the transaction fee

unavailablestring

True, if event is set to unavailable

unavailable_statusstring nullable

Optional custom status message when event is set to be unavailable

urlstring

Event occurrence URL

Example response

{
  "object": "event",
  "id": "ev_1",
  "available_status": "This event occurrence is available",
  "bundles": [],
  "chk": "da09",
  "currency": "gbp",
  "end": {
    "date": "2020-05-01",
    "formatted": "Fri 1 May 2020 10:30 PM",
    "iso": "2020-05-01T22:30:00+01:00",
    "time": "22:30",
    "timezone": "+01:00",
    "unix": 1588368600
  },
  "event_series_id": "es_1",
  "hidden": "true",
  "online_link": null,
  "override_id": "ov_123",
  "revenue": 155,
  "sales_tax_label": "VAT",
  "sales_tax_percentage": 20,
  "sales_tax_treatment": "exclusive",
  "start": {
    "date": "2020-05-01",
    "formatted": "Fri 1 May 2020 6:00 PM",
    "iso": "2020-05-01T18:00:00+01:00",
    "time": "18:00",
    "timezone": "+01:00",
    "unix": 1588352400
  },
  "max_tickets_sold_per_occurrence": null,
  "tickets_available": "true",
  "ticket_groups": [
    {
      "object": "ticket_group",
      "id": "tg_21099",
      "bundle_ids": [
        "bu_1234"
      ],
      "max_per_order": 100,
      "max_quantity": 100,
      "min_per_order": 1,
      "name": "April 20th",
      "sort_order": 50050,
      "ticket_ids": [
        "tt_230625",
        "tt_230626"
      ]
    },
    {
      "object": "ticket_group",
      "id": "tg_21100",
      "bundle_ids": [
        "bu_4"
      ],
      "max_per_order": 100,
      "max_quantity": 100,
      "min_per_order": 1,
      "name": "April 21st",
      "sort_order": 50100,
      "ticket_ids": [
        "tt_230631",
        "tt_230632"
      ]
    }
  ],
  "ticket_types": [
    {
      "object": "ticket_type",
      "id": "tt_230625",
      "access_code": null,
      "booking_fee": 0,
      "description": null,
      "group_id": "tg_21099",
      "max_per_order": 100,
      "min_per_order": 1,
      "name": "4.20 Adult (13-61) - Presale",
      "price": 800,
      "status": "hidden",
      "sort_order": 50050,
      "type": "paid",
      "quantity": 10000,
      "quantity_held": 0,
      "quantity_issued": 5000,
      "quantity_total": 15000
    },
    {
      "object": "ticket_type",
      "id": "tt_230626",
      "access_code": null,
      "booking_fee": 0,
      "description": null,
      "group_id": "tg_21099",
      "max_per_order": 100,
      "min_per_order": 1,
      "name": "4.20 Senior (62+) - Presale",
      "price": 600,
      "status": "on_sale",
      "sort_order": 50051,
      "type": "paid",
      "quantity": 10000,
      "quantity_held": 0,
      "quantity_issued": 2000,
      "quantity_total": 12000
    }
  ],
  "total_issued_tickets": 5,
  "transaction_fee_fixed_amount": null,
  "transaction_fee_percentage": 10,
  "unavailable": "true",
  "unavailable_status": "This event occurrence is not available",
  "url": "https://www.tickettailor.com/checkout/view-event/id/123/chk/abcd/"
}