v12.11.0

V2 Staging API Documentation

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

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

---

LinkedSites

Endpoints to interact with linked sites

Operations

GET/api/v2/linked-sitesPOST/api/v2/linked-sitesGET/api/v2/linked-sites/{id}DELETE/api/v2/linked-sites/{id}PATCH/api/v2/linked-sites/{id}POST/api/v2/linked-sites/bulk-deletePOST/api/v2/linked-sites/{id}/test

---

List linked sites

GET

/api/v2/linked-sites

Returns a list of linked sites

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Responses

Linked site list

Content-Type

application/json

{

  

"count": 10,

  

"totalCount": 25,

  

"limit": 50,

  

"offset": 25,

  

"data": [

  

]

}

GET

/api/v2/linked-sites

Playground

Authorization

bearerAuth

Samples

---

Create linked site

POST

/api/v2/linked-sites

Create a new linked site

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

Created linked site

Content-Type

application/json

{

  

"data": "string"

}

POST

/api/v2/linked-sites

Playground

Authorization

bearerAuth

Body

Samples

---

Get linked site by ID

GET

/api/v2/linked-sites/{id}

Returns a single linked site by ID

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Linked Site ID

Type

integer

Required

Format

"int64"

Responses

Linked site object

Content-Type

application/json

{

  

"data": "string"

}

GET

/api/v2/linked-sites/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Delete linked site

DELETE

/api/v2/linked-sites/{id}

Delete a linked site

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Linked Site ID

Type

integer

Required

Format

"int64"

Responses

Linked site deleted successfully

DELETE

/api/v2/linked-sites/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Update linked site

PATCH

/api/v2/linked-sites/{id}

Update an existing linked site

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Linked Site ID

Type

integer

Required

Format

"int64"

Request Body

application/json

"string"

Responses

Updated linked site

Content-Type

application/json

{

  

"data": "string"

}

PATCH

/api/v2/linked-sites/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Body

Samples

---

Delete multiple linked sites

POST

/api/v2/linked-sites/bulk-delete

Deletes multiple linked sites

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"ids": [

  

  

[

  

  

  

1,

  

  

  

2,

  

  

  

3

  

  

]

  

]

}

Responses

Linked sites deleted successfully

POST

/api/v2/linked-sites/bulk-delete

Playground

Authorization

bearerAuth

Body

Samples

---

Test linked site connection

POST

/api/v2/linked-sites/{id}/test

Attempts to obtain a fresh API token from the linked site (same as v1 Test action).

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Linked Site ID

Type

integer

Required

Format

"int64"

Responses

Connection test result (success or failure details in body)

Content-Type

application/json

{

  

"data": "string"

}

POST

/api/v2/linked-sites/{id}/test

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Powered by VitePress OpenAPI