v2.84.0

TS Dev 108 API Documentation

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

---

Customer

Manages customers

Operations

GET/api/v2/customer/{id}DELETE/api/v2/customer/{id}PATCH/api/v2/customer/{id}GET/api/v2/customerPOST/api/v2/customer

---

Returns the customer's user information

GET

/api/v2/customer/{id}

Returns a single customer

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

The id of the customer

Type

string

Required

Responses

The requested customer.

Content-Type

application/json

"string"

GET

/api/v2/customer/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Deletes an existing customer.

DELETE

/api/v2/customer/{id}

Deletes an existing customer.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

The id of the customer

Type

string

Required

Query Parameters

_response

Determines the format of response. Default is id. Values:

• none
• id
• object

Type

string

Responses

The customer was deleted. The format depends on the _response parameter.

Content-Type

application/json

"string"

DELETE

/api/v2/customer/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

_response

Samples

---

Updates an existing customer.

PATCH

/api/v2/customer/{id}

Updates the existing customer.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

The id of the customer

Type

string

Required

Query Parameters

_response

Determines the format of response. Default is id. Values:

• none
• id
• object

Type

string

Request Body

application/json

"string"

Responses

The customer was updated. The format depends on the _response parameter.

Content-Type

application/json

"string"

PATCH

/api/v2/customer/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

_response

Body

Samples

---

Retrieves a list of customers.

GET

/api/v2/customer

Returns a list of customer user's information.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Query Parameters

_limit

Set the max number of customers to return.

Type

integer

Format

"int64"

_offset

Set the number of customers to ignore before starting.

Type

integer

Format

"int64"

_sort

Sets the order the customers can be returned. Can include one or more columns separated by a comma. Prefix + for ascending, - for descending. If not provided, sorted by id.

• id
• firstName
• lastName
• emailAddress
• username

Type

string

emailAddress

Search by the customer's username.

Type

string

firstName

Search by the customer's first name.

Type

string

lastName

Search by the customer's last name.

Type

string

Responses

A list of matching customers.

Content-Type

application/json

"string"

GET

/api/v2/customer

Playground

Authorization

bearerAuth

Variables

Key

Value

_limit

_offset

_sort

emailAddress

firstName

lastName

Samples

---

Create customer

POST

/api/v2/customers

Create a new customer

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

Created customer

Content-Type

application/json

{

  

"data": "string"

}

POST

/api/v2/customers

Playground

Authorization

bearerAuth

Body

Samples

---

Powered by VitePress OpenAPI