v2.84.0

TS Dev 108 API Documentation

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

---

Stored Value Codes

Endpoints to interact with stored value codes

Operations

GET/api/v2/stored-value-codesPOST/api/v2/stored-value-codesGET/api/v2/stored-value-codes/{id}DELETE/api/v2/stored-value-codes/{id}PATCH/api/v2/stored-value-codes/{id}POST/api/v2/stored-value-codes/bulk-deleteGET/api/v2/stored-value-code/GET/api/v2/stored-value-code/{id}POST/api/v2/stored-value-code

---

Get a list of stored value codes

GET

/api/v2/stored-value-codes

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Query Parameters

status

Filter by status

Type

string

Valid values

"active""inactive""soldOut""expired"

Example"active"

expired

Filter by expired codes (true/1 for expired, false/0 for active)

Example"true"

Responses

Stored value code list

Content-Type

application/json

{

  

"count": 10,

  

"totalCount": 25,

  

"limit": 50,

  

"offset": 25,

  

"data": [

  

]

}

GET

/api/v2/stored-value-codes

Playground

Authorization

bearerAuth

Variables

Key

Value

status

expired

Samples

---

Create stored value code

POST

/api/v2/stored-value-codes

Create stored value code

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

Stored value code created

Content-Type

application/json

{

  

"data": "string"

}

POST

/api/v2/stored-value-codes

Playground

Authorization

bearerAuth

Body

Samples

---

Get stored value code by ID

GET

/api/v2/stored-value-codes/{id}

Return a single stored value code

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Stored value code ID

Type

integer

Required

Format

"int64"

Responses

Stored value code

Content-Type

application/json

{

  

"data": "string"

}

GET

/api/v2/stored-value-codes/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Delete stored value code

DELETE

/api/v2/stored-value-codes/{id}

Soft delete stored value code by URL path id

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Stored value code ID

Type

integer

Required

Format

"int64"

Responses

Stored value code deleted

DELETE

/api/v2/stored-value-codes/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Update stored value code

PATCH

/api/v2/stored-value-codes/{id}

Update stored value code by id in request body

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Stored value code ID

Type

integer

Required

Format

"int64"

Request Body

application/json

"string"

Responses

Stored value code updated

Content-Type

application/json

{

  

"data": "string"

}

PATCH

/api/v2/stored-value-codes/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Body

Samples

---

Bulk delete stored value codes

POST

/api/v2/stored-value-codes/bulk-delete

Soft delete multiple stored value codes

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"ids": [

  

  

[

  

  

  

1,

  

  

  

2,

  

  

  

3

  

  

]

  

]

}

Responses

Stored value codes deleted

POST

/api/v2/stored-value-codes/bulk-delete

Playground

Authorization

bearerAuth

Body

Samples

---

Get a list of stored value codes

GET

/api/v2/stored-value-codes

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Query Parameters

status

Filter by status

Type

string

Valid values

"active""inactive""soldOut""expired"

Example"active"

expired

Filter by expired codes (true/1 for expired, false/0 for active)

Example"true"

Responses

Stored value code list

Content-Type

application/json

{

  

"count": 10,

  

"totalCount": 25,

  

"limit": 50,

  

"offset": 25,

  

"data": [

  

]

}

GET

/api/v2/stored-value-codes

Playground

Authorization

bearerAuth

Variables

Key

Value

status

expired

Samples

---

Get stored value code by ID

GET

/api/v2/stored-value-codes/{id}

Return a single stored value code

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Stored value code ID

Type

integer

Required

Format

"int64"

Responses

Stored value code

Content-Type

application/json

{

  

"data": "string"

}

GET

/api/v2/stored-value-codes/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Create stored value code

POST

/api/v2/stored-value-codes

Create stored value code

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

Stored value code created

Content-Type

application/json

{

  

"data": "string"

}

POST

/api/v2/stored-value-codes

Playground

Authorization

bearerAuth

Body

Samples

---

Powered by VitePress OpenAPI