v12.11.0

V2 Staging API Documentation

REST API v2. Authenticate with a Bearer JWT in the Authorization header unless an endpoint is marked public.

Servers

https://v2-staging.tscheckout.comCurrent host

Settings

Endpoints to interact with settings

Operations

GET/api/v2/settings/box-office PATCH/api/v2/settings/box-office GET/api/v2/settings/receipt PATCH/api/v2/settings/receipt GET/api/v2/settings/tickets PATCH/api/v2/settings/tickets GET/api/v2/settings/{name}DELETE/api/v2/settings/{name}PATCH/api/v2/settings/{name}GET/api/v2/settings POST/api/v2/settings POST/api/v2/settings/multiple

Get Box Office settings

GET

/api/v2/settings/box-office

Get Box Office settings

Authorizations

bearerAuth

Type

HTTP (bearer)

Responses

Box Office settings object

Content-Type

application/json

JSON

{

"data": "string"

}

GET

/api/v2/settings/box-office

Playground

Authorization

bearerAuth

Samples

Update Box Office settings

PATCH

/api/v2/settings/box-office

Update Box Office settings

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

JSON

"string"

Responses

Updated Box Office settings object

Content-Type

application/json

JSON

{

"data": "string"

}

PATCH

/api/v2/settings/box-office

Playground

Authorization

bearerAuth

Body

Samples

Get Receipt settings

GET

/api/v2/settings/receipt

Returns Receipt settings

Authorizations

bearerAuth

Type

HTTP (bearer)

Responses

Receipt settings

Content-Type

application/json

JSON

{

"data": "string"

}

GET

/api/v2/settings/receipt

Playground

Authorization

bearerAuth

Samples

Update Receipt settings

PATCH

/api/v2/settings/receipt

Partial update of receipt settings. Accepts application/json or multipart/form-data. companyLogo can be sent as a URL string in JSON or as a file upload in multipart requests.

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

JSON

"string"

Responses

Settings updated successfully

Content-Type

application/json

JSON

{

"data": "string"

}

PATCH

/api/v2/settings/receipt

Playground

Authorization

bearerAuth

Body

Samples

Get E Tickets settings

GET

/api/v2/settings/tickets

Returns E Tickets settings

Authorizations

bearerAuth

Type

HTTP (bearer)

Responses

Tickets settings

Content-Type

application/json

JSON

{

"data": "string"

}

GET

/api/v2/settings/tickets

Playground

Authorization

bearerAuth

Samples

Update Tickets settings

PATCH

/api/v2/settings/tickets

Partial update of Tickets settings.

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

JSON

"string"

Responses

Settings updated successfully

Content-Type

application/json

JSON

{

"data": "string"

}

PATCH

/api/v2/settings/tickets

Playground

Authorization

bearerAuth

Body

Samples

Find Settings by Name

GET

/api/v2/settings/{name}

Returns a single Settings

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

name*

Setting Name

Type

string

Required

Responses

GET

/api/v2/settings/{name}

Playground

Authorization

bearerAuth

Variables

Key

Value

name*

Samples

Delete one Settings by Setting Name

DELETE

/api/v2/settings/{name}

Deletes the identified Setting

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

name*

Name of Setting to delete

Type

string

Required

Responses

DELETE

/api/v2/settings/{name}

Playground

Authorization

bearerAuth

Variables

Key

Value

name*

Samples

Update a setting

PATCH

/api/v2/settings/{name}

Updates an existing Settings from the PATCH data

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

name*

Setting Name to update

Type

string

Required

Request Body

application/json

JSON

{

"name": "String",

"value": "String",

"encrypted": "0"

}

Responses

PATCH

/api/v2/settings/{name}

Playground

Authorization

bearerAuth

Variables

Key

Value

name*

Body

Samples

Find a list of Settings by a set of filters

GET

/api/v2/settings

Returns a list of Settings

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Query Parameters

_limit

Set the max number of objects to return

Type

number

Format

"int64"

_offset

Set the number of objects to ignore before starting

Type

number

Format

"int64"

_search

This will only return setting names that contain the string supplied. You can search for multiple values by using a comma (',') as a seperator

Type

string

name

search by setting name

Type

string

value

search by setting value

Type

string

groupSearch

group search can search for multiple values separated by comma and will return all settings within each setting group

Type

string

Responses

Create Settings

POST

/api/v2/settings

Creates a new Settings from the POST data

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

JSON

"string"

Responses

POST

/api/v2/settings

Playground

Authorization

bearerAuth

Body

Samples

Set the value of a global setting

POST

/api/v2/settings/multiple

Creates or updates a general setting

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

JSON

[

]

Responses

POST

/api/v2/settings/multiple

Playground

Authorization

bearerAuth

Body

V2 Staging API Documentation​

Servers​

Settings​

Operations​

Get Box Office settings​

Authorizations​

Responses​

Playground​

Samples​

Update Box Office settings​

Authorizations​

Request Body​

Responses​

V2 Staging API Documentation

Servers

Settings

Operations

Get Box Office settings

Authorizations

Responses

Playground

Samples

Update Box Office settings

Authorizations

Request Body

Responses