Data Fields

Data Fields are special extra fields that hold questions the customer can be asked on checkout. DataFields can be applied to tickettypes or globally to events.

Endpoints

The Data Field object

Attributes

_id

Required

string

The ID of the data field

sellerId

Required

string

The ID of the seller of the data field

name

Required

string

The name of the data field

type

Required

string

The type of data field

textnumberselectcheckboxtelcountryemaildatedocumentUploadsignature

slug

Required

string

The slug generated out of name

Optional Attributes

Collapse all

title

Optional

string

The default title of the data field

isPersonalData

Optional

boolean

Whether the data field is personal data

description

Optional

string

The default description of the data field

options

Optional

array<string>

An array of options when type is select

maxLength

Optional

number float

Maximum length for a text input

settings

Optional

One of

Only one of the following types

Optional Attributes

Collapse all

settings.allowedMimeTypes

Optional

array<string>

An array of allowed mime types

Was this section helpful?

Yes No

{
  "_id": "string",
  "sellerId": "string",
  "name": "string",
  "title": "string",
  "isPersonalData": true,
  "description": "string",
  "type": "text",
  "slug": "string",
  "options": [
    "string"
  ],
  "maxLength": 10.5,
  "settings": {
    "allowedMimeTypes": [
      "application/pdf"
    ]
  }
}

Create a Data Field

Payload

type

Required

string

The type of data field

textnumberselectcheckboxtelcountryemaildatedocumentUploadsignature

name

Required

string

Optional Attributes

Collapse all

title

Optional

string

The default title of the data field

description

Optional

string

The default description of the data field

isPersonalData

Optional

boolean

Whether the data field is personal data

options

Optional

array<string>

An array of options when type is select

maxLength

Optional

number float

Maximum length for a text input

settings

Optional

One of

Only one of the following types

Optional Attributes

Collapse all

settings.allowedMimeTypes

Optional

array<string>

An array of allowed mime types

201

Created

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "title": "string",
  "description": "string",
  "isPersonalData": true,
  "type": "text",
  "options": [
    "string"
  ],
  "maxLength": 10.5,
  "settings": {
    "allowedMimeTypes": [
      "application/pdf"
    ]
  },
  "name": "string"
}

{
  "_id": "string",
  "sellerId": "string",
  "name": "string",
  "title": "string",
  "isPersonalData": true,
  "description": "string",
  "type": "text",
  "slug": "string",
  "options": [
    "string"
  ],
  "maxLength": 10.5,
  "settings": {
    "allowedMimeTypes": [
      "application/pdf"
    ]
  }
}

Update a Data Field

Payload

Optional Attributes

Collapse all

title

Optional

string

The default title of the data field

description

Optional

string

The default description of the data field

isPersonalData

Optional

boolean

Whether the data field is personal data

options

Optional

array<string>

An array of options when type is select

maxLength

Optional

number float

Maximum length for a text input

settings

Optional

One of

Only one of the following types

Optional Attributes

Collapse all

settings.allowedMimeTypes

Optional

array<string>

An array of allowed mime types

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "title": "string",
  "description": "string",
  "isPersonalData": true,
  "options": [
    "string"
  ],
  "maxLength": 10.5,
  "settings": {
    "allowedMimeTypes": [
      "application/pdf"
    ]
  }
}

{
  "_id": "string",
  "sellerId": "string",
  "name": "string",
  "title": "string",
  "isPersonalData": true,
  "description": "string",
  "type": "text",
  "slug": "string",
  "options": [
    "string"
  ],
  "maxLength": 10.5,
  "settings": {
    "allowedMimeTypes": [
      "application/pdf"
    ]
  }
}

Get a Data Field

Query

No supported query parameters

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "_id": "string",
  "sellerId": "string",
  "name": "string",
  "title": "string",
  "isPersonalData": true,
  "description": "string",
  "type": "text",
  "slug": "string",
  "options": [
    "string"
  ],
  "maxLength": 10.5,
  "settings": {
    "allowedMimeTypes": [
      "application/pdf"
    ]
  }
}

Get all Data Fields

Query

No supported query parameters

200

401

Unauthorized

Was this section helpful?

Yes No

[
  {
    "_id": "string",
    "sellerId": "string",
    "name": "string",
    "title": "string",
    "isPersonalData": true,
    "description": "string",
    "type": "text",
    "slug": "string",
    "options": [
      "string"
    ],
    "maxLength": 10.5,
    "settings": {
      "allowedMimeTypes": [
        "application/pdf"
      ]
    }
  }
]

PUBLIC

Get all Data Fields by reference

Query

eventId

Optional

string

shopId

Optional

string

ticketTypeId

Optional

string

sellerId

Required

string

checkoutId

Optional

string

scope

Required

string

The scope of the data-fields.

CUSTOMERTICKETTRANSACTIONCHECKOUT

locale

Optional

string

Resolve the data-fields for a specific language

200

400

Bad Request

Was this section helpful?

Yes No

[
  {
    "_id": "string",
    "name": "string",
    "type": "text",
    "options": [
      "string"
    ],
    "slug": "string",
    "description": "string"
  }
]