v2.84.0

TS Dev 108 API Documentation

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

---

Print Template

Manages Print templates and commands

Operations

GET/api/v2/print-templatePOST/api/v2/print-templateGET/api/v2/print-template/signingGET/api/v2/print-template/certificateDELETE/api/v2/print-template/{id}PATCH/api/v2/print-template/{id}GET/api/v2/print-template/{id}/commandGET/api/v2/print-template/{id}/command/{commandId}POST/api/v2/print-template/{id}/command/{commandId}DELETE/api/v2/print-template/{id}/command/{commandId}PATCH/api/v2/print-template/{id}/command/{commandId}GET/api/v2/print-template/render/{ticketId}

---

Get Print Templates

GET

/api/v2/print-template

Get Print Templates

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Query Parameters

_limit

Set the max number of print templates to return.

Type

number

Format

"integer"

_offset

Set the number of objects to ignore before starting.

Type

number

Format

"integer"

Responses

A list of print templates.

GET

/api/v2/print-template

Playground

Authorization

bearerAuth

Variables

Key

Value

_limit

_offset

Samples

---

Create a print template

POST

/api/v2/print-template

Create a print template

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"name": "string",

  

"includeReceipt": true

}

Responses

Create template Succeeded

POST

/api/v2/print-template

Playground

Authorization

bearerAuth

Body

Samples

---

Get Print signature for Print print

GET

/api/v2/print-template/signing

Get Print signature for Print print

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Query Parameters

request*

request to sign

Type

string

Required

Responses

print printing signature

GET

/api/v2/print-template/signing

Playground

Authorization

bearerAuth

Variables

Key

Value

request*

Samples

---

Get Print certificate

GET

/api/v2/print-template/certificate

Get Print certificate

Authorizations

bearerAuth

Type

HTTP (bearer)

Responses

print printing certificate

GET

/api/v2/print-template/certificate

Playground

Authorization

bearerAuth

Samples

---

Deletes an existing print template

DELETE

/api/v2/print-template/{id}

Deletes an existing print template

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

The id of the print template

Type

string

Required

Responses

Deleted print template

DELETE

/api/v2/print-template/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Updates an existing print template

PATCH

/api/v2/print-template/{id}

Updates an existing custom dasbhboard

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

The id of the print template

Type

string

Required

Request Body

application/json

"string"

Responses

Update template succeeded

PATCH

/api/v2/print-template/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Body

Samples

---

Get Print Template commands

GET

/api/v2/print-template/{id}/command

Get Print Template commands

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

The id of the print template

Type

string

Required

Query Parameters

_limit

Set the max number of print commands to return.

Type

number

Format

"integer"

_offset

Set the number of objects to ignore before starting.

Type

number

Format

"integer"

Responses

A list of print commands.

GET

/api/v2/print-template/{id}/command

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

_limit

_offset

Samples

---

Get an Print Template command

GET

/api/v2/print-template/{id}/command/{commandId}

Get an Print Template command

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

The id of the print template

Type

string

Required

commandId*

The id of the print command

Type

string

Required

Responses

An print command.

GET

/api/v2/print-template/{id}/command/{commandId}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

commandId*

Samples

---

Create a command for an print template

POST

/api/v2/print-template/{id}/command/{commandId}

Create a command for an print template

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

The id of the print template

Type

string

Required

commandId*

The id of the command

Type

string

Required

Request Body

application/json

{

  

"type": "string",

  

"data": "string",

  

"font": "string",

  

"orientation": "string",

  

"row": 0,

  

"column": 0,

  

"height": 0,

  

"width": 0,

  

"boxHeight": 0,

  

"boxWidth": 0,

  

"raw": "string"

}

Responses

Create command Succeeded

POST

/api/v2/print-template/{id}/command/{commandId}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

commandId*

Body

Samples

---

Deletes an existing print command

DELETE

/api/v2/print-template/{id}/command/{commandId}

Deletes an existing print command

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

The id of the print template

Type

string

Required

commandId*

The id of the print command

Type

string

Required

Responses

Deleted print command

DELETE

/api/v2/print-template/{id}/command/{commandId}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

commandId*

Samples

---

Updates an existing print command

PATCH

/api/v2/print-template/{id}/command/{commandId}

Updates an existing print command

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

The id of the print template

Type

string

Required

commandId*

The id of the print command

Type

string

Required

Request Body

application/json

"string"

Responses

Update command succeeded

PATCH

/api/v2/print-template/{id}/command/{commandId}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

commandId*

Body

Samples

---

Render the Print Code from the template using the data from the ticketId specified

GET

/api/v2/print-template/render/{ticketId}

Render the Print Code from the template using the data from the ticketId specified

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

ticketId*

The id of the ticket to render with the template

Type

string

Required

Query Parameters

id

The id of the print template - optional - normal template lookup will occur otherwise (ticketType template, event template or site template)

Type

string

Responses

A list of printer commands.

GET

/api/v2/print-template/render/{ticketId}

Playground

Authorization

bearerAuth

Variables

Key

Value

ticketId*

id

Samples

---

Powered by VitePress OpenAPI