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

---

ThirdPartyAccounts

Third-party Stripe payout accounts for shared inventory

Operations

GET/api/v2/settings/third-party-accountsPOST/api/v2/settings/third-party-accountsGET/api/v2/settings/third-party-accounts/{id}DELETE/api/v2/settings/third-party-accounts/{id}PATCH/api/v2/settings/third-party-accounts/{id}POST/api/v2/settings/third-party-accounts/bulk-delete

---

List third party accounts

GET

/api/v2/settings/third-party-accounts

Returns a searchable paginated list of third party accounts

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Responses

Third party account list

Content-Type

application/json

{

  

"count": 10,

  

"totalCount": 25,

  

"limit": 50,

  

"offset": 25,

  

"data": [

  

]

}

GET

/api/v2/settings/third-party-accounts

Playground

Authorization

bearerAuth

Samples

---

Create third party account

POST

/api/v2/settings/third-party-accounts

Create a new third party account

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

Created third party account

Content-Type

application/json

{

  

"data": "string"

}

POST

/api/v2/settings/third-party-accounts

Playground

Authorization

bearerAuth

Body

Samples

---

Get third party account by ID

GET

/api/v2/settings/third-party-accounts/{id}

Returns a single third party account by ID

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Third party account ID

Type

integer

Required

Format

"int64"

Responses

Third party account object

Content-Type

application/json

{

  

"data": "string"

}

GET

/api/v2/settings/third-party-accounts/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Delete third party account

DELETE

/api/v2/settings/third-party-accounts/{id}

Delete a third party account

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Third party account ID

Type

integer

Required

Format

"int64"

Responses

Third party account deleted successfully

DELETE

/api/v2/settings/third-party-accounts/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Update third party account

PATCH

/api/v2/settings/third-party-accounts/{id}

Update an existing third party account

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Third party account ID

Type

integer

Required

Format

"int64"

Request Body

application/json

"string"

Responses

Updated third party account

Content-Type

application/json

{

  

"data": "string"

}

PATCH

/api/v2/settings/third-party-accounts/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Body

Samples

---

Bulk delete third party accounts

POST

/api/v2/settings/third-party-accounts/bulk-delete

Deletes multiple third party accounts

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"ids": [

  

  

[

  

  

  

1,

  

  

  

2,

  

  

  

3

  

  

]

  

]

}

Responses

Third party accounts deleted successfully

POST

/api/v2/settings/third-party-accounts/bulk-delete

Playground

Authorization

bearerAuth

Body

Samples

---

Powered by VitePress OpenAPI