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

---

CategoryGroups

Endpoints to interact with category groups

Operations

GET/api/v2/category-groupsPOST/api/v2/category-groupsGET/api/v2/category-groups/{id}DELETE/api/v2/category-groups/{id}PATCH/api/v2/category-groups/{id}

---

Get category groups

GET

/api/v2/category-groups

Returns a list of category groups

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Responses

Category group list

Content-Type

application/json

{

  

"count": 10,

  

"totalCount": 25,

  

"limit": 50,

  

"offset": 25,

  

"data": [

  

]

}

GET

/api/v2/category-groups

Playground

Authorization

bearerAuth

Samples

---

Create a new category group

POST

/api/v2/category-groups

Create category group

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"title": "Category Group A"

}

Responses

Created category group object

Content-Type

application/json

{

  

"data": "string"

}

POST

/api/v2/category-groups

Playground

Authorization

bearerAuth

Body

Samples

---

Get category group by ID

GET

/api/v2/category-groups/{id}

Returns a single category group

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Category Group Id

Type

integer

Required

Format

"int64"

Responses

Category group object

Content-Type

application/json

{

  

"data": "string"

}

GET

/api/v2/category-groups/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Delete a category group

DELETE

/api/v2/category-groups/{id}

Delete a category group

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Category Group Id

Type

integer

Required

Format

"int64"

Responses

Category group deleted successfully

DELETE

/api/v2/category-groups/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Update a category group

PATCH

/api/v2/category-groups/{id}

Update an existing category group

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Category Group Id

Type

integer

Required

Format

"int64"

Request Body

application/json

{

  

"title": "Category Group A"

}

Responses

Updated category group object

Content-Type

application/json

{

  

"data": "string"

}

PATCH

/api/v2/category-groups/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Body

Samples

---

Powered by VitePress OpenAPI