Premiere V2 API

Appearance

v12.11.0

V2 Staging API Documentation​

Download OpenAPI Document

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

Order Note​

Endpoints to interact with order note

Operations​

GET/api/v2/order-note/{id}GET/api/v2/order-notePOST/api/v2/order-note

Find order note by Id​

GET
/api/v2/order-note/{id}

Returns a single order note

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*

id

Type
integer
Required
Format
"int64"

Responses​

Playground​

Authorization
Variables
Key
Value

Samples​

Find a list of order notes by a set of filters​

GET
/api/v2/order-note

Returns a list of Orders

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Query Parameters

_limit

Set the max number of objects to return

Type
number
Format
"int64"
_offset

Set the number of objects to ignore before starting

Type
number
Format
"int64"
_select

comma separated list of items to select ('tickets.*, ticketTypes.name')

Type
string
orderId*

Id of order to retreive the notes for

Type
integer
Required
Format
"int64"

Responses​

Playground​

Authorization
Variables
Key
Value

Samples​

Create note for an order​

POST
/api/v2/order-note

Creates a new Order Note from the POST data

Authorizations​

bearerAuth
Type
HTTP (bearer)

Request Body​

application/json
JSON
{
  
"orderId": "1015",
  
"type": "String",
  
"adminId": "1016",
  
"text": "String"
}

Responses​

Playground​

Authorization
Body

Samples​

Powered by VitePress OpenAPI