Ticketsalesflow
A single ticketsalesflow.
More info: see the get operation and the ticketsalesflows endpoint.
Fields
| Field | Description |
|---|---|
|
id
int
(required) |
Unique ID Example value:123 |
|
name
string
(required) |
Name Example value:"Season start 2018" |
|
availabilityfielddefinition
string
(required) |
Fielddefinition used to define the availability of events for this flow Example value:"theatre" |
|
code
string
(required) |
Unique code used for the flow. Should only contain lower case letters and digits Example value:"season2018" |
|
config
|
Config for the flow Example value:[ { "from": "2016-01-01 00:00:00", "until": "2016-06-15 00:00:00", "widget": "addtickets", "widgetparams": { "flow": "basketwithcheckout" } }, { "from": "2016-06-15 00:00:00", "until": "2017-06-15 00:00:00", "widget": "addtickets", "widgetparams": { "flow": "return" } } ] |
|
description
string
(required) |
Description Example value:"Sales flow for the start of the season 2018" |
|
productavailability
int[]
(required) |
For flows with supported parameter ‘product’: the set of ProductTypes for which this flow is available Example value:[ 26001, 26002 ] |
|
supportedparameters
string[]
(required) |
Supported parameters for the flow Example value:[ "event", "product" ] |
|
testmode
bool
(required) |
Whether or not the flow is in test mode |
|
ticketsalessetupid
int
(required) |
Ticket sales setup this flow belongs to Example value:1 |
Example
1{
2 "id": 123,
3 "name": "Season start 2018",
4 "availabilityfielddefinition": "theatre",
5 "code": "season2018",
6 "config": [
7 {
8 "from": "2016-01-01 00:00:00",
9 "until": "2016-06-15 00:00:00",
10 "widget": "addtickets",
11 "widgetparams": {
12 "flow": "basketwithcheckout"
13 }
14 },
15 {
16 "from": "2016-06-15 00:00:00",
17 "until": "2017-06-15 00:00:00",
18 "widget": "addtickets",
19 "widgetparams": {
20 "flow": "return"
21 }
22 }
23 ],
24 "description": "Sales flow for the start of the season 2018",
25 "productavailability": [ 26001, 26002 ],
26 "supportedparameters": [
27 "event",
28 "product"
29 ],
30 "testmode": false,
31 "ticketsalessetupid": 1
32}