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

---

Affiliates

Endpoints to interact with affiliates

Operations

GET/api/v2/affiliatesPOST/api/v2/affiliatesGET/api/v2/affiliates/{id}DELETE/api/v2/affiliates/{id}PATCH/api/v2/affiliates/{id}POST/api/v2/affiliates/bulk-delete

---

List affiliates

GET

/api/v2/affiliates

Returns a list of affiliates

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Query Parameters

isFrontEndUser

Filter by frontend-linked affiliate. 1/true = frontendUserId > 0 (referrer picker). 0/false = admin-created only (frontendUserId = 0). Omit for all.

Type

integer

Valid values

01

Responses

Affiliate list

Content-Type

application/json

{

  

"count": 10,

  

"totalCount": 25,

  

"limit": 50,

  

"offset": 25,

  

"data": [

  

]

}

GET

/api/v2/affiliates

Playground

Authorization

bearerAuth

Variables

Key

Value

isFrontEndUser

Samples

---

Create affiliate

POST

/api/v2/affiliates

Create a new affiliate

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

Created affiliate

Content-Type

application/json

{

  

"data": "string"

}

POST

/api/v2/affiliates

Playground

Authorization

bearerAuth

Body

Samples

---

Get affiliate by ID

GET

/api/v2/affiliates/{id}

Returns a single affiliate by ID

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Affiliate ID

Type

integer

Required

Format

"int64"

Responses

Affiliate object

Content-Type

application/json

{

  

"data": "string"

}

GET

/api/v2/affiliates/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Delete affiliate

DELETE

/api/v2/affiliates/{id}

Delete an affiliate

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Affiliate ID

Type

integer

Required

Format

"int64"

Responses

Affiliate deleted successfully

DELETE

/api/v2/affiliates/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Update affiliate

PATCH

/api/v2/affiliates/{id}

Update an existing affiliate

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Affiliate ID

Type

integer

Required

Format

"int64"

Request Body

application/json

"string"

Responses

Updated affiliate

Content-Type

application/json

{

  

"data": "string"

}

PATCH

/api/v2/affiliates/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Body

Samples

---

Delete multiple affiliates

POST

/api/v2/affiliates/bulk-delete

Deletes multiple affiliates

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"ids": [

  

  

[

  

  

  

1,

  

  

  

2,

  

  

  

3

  

  

]

  

]

}

Responses

Affiliates deleted successfully

POST

/api/v2/affiliates/bulk-delete

Playground

Authorization

bearerAuth

Body

Samples

---

Powered by VitePress OpenAPI