v2.84.0

TS Dev 108 API Documentation

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

---

Localization

Endpoints to interact with localization

Operations

GET/api/v2/localization/{id}/phrasesPOST/api/v2/localization/{id}/phrasesPATCH/api/v2/localization/{id}/phrasesGET/api/v2/localization/{id}/phrases/{phrase}DELETE/api/v2/localization/{id}/phrases/{phrase}GET/api/v2/localizationPOST/api/v2/localizationGET/api/v2/localization/{id}DELETE/api/v2/localization/{id}PATCH/api/v2/localization/{id}GET/api/v2/localization/names

---

Finds a locationzation by name

GET

/api/v2/localization/{id}/phrases

Returns a single locationization and language.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Id of the localization language.

Type

string

Required

Responses

The location was found.

Content-Type

application/json

[

]

GET

/api/v2/localization/{id}/phrases

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Adds new phrases for a localization.

POST

/api/v2/localization/{id}/phrases

Adds new phrases for a localization. You can pass in a single phrase or an array of phrases.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Id of the localization

Type

string

Required

Request Body

application/json

[

]

Responses

The phrases where added.

POST

/api/v2/localization/{id}/phrases

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Body

Samples

---

Updates existing phrase for a localization.

PATCH

/api/v2/localization/{id}/phrases

Updates existing phrase for a localization. You can pass in a single phrase or an array of phrases.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Id of the localization

Type

string

Required

Request Body

application/json

[

]

Responses

The phrases where updates.

PATCH

/api/v2/localization/{id}/phrases

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Body

Samples

---

Finds a locationzation by name

GET

/api/v2/localization/{id}/phrases/{phrase}

Returns a single locationization and language.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Id of the localization language.

Type

string

Required

phrase*

The start of name of phrase to search for.

Type

string

Required

Responses

The location was found.

Content-Type

application/json

[

]

GET

/api/v2/localization/{id}/phrases/{phrase}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

phrase*

Samples

---

Delete existing phrases for a localization.

DELETE

/api/v2/localization/{id}/phrases/{phrase}

Deletes existing phrases for a localization.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Id of the localization

Type

string

Required

phrase*

The phrases to delete. You can include multiple seperated by a comma.

Type

string

Required

Responses

The updates was added.

DELETE

/api/v2/localization/{id}/phrases/{phrase}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

phrase*

Samples

---

Searches the list of localization.

GET

/api/v2/localization

Returns a list of localizations.

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"

phrase

The phrase to include. Preforms a wild cart search.

Type

string

lang

Iso name of the language to return the localizations for.

Type

string

_include

Adds additional details to the results. Supports the following values:

• phrases - Include phrases for each localization.
• defaults - Include the list of default phrases.

Type

string

Responses

GET

/api/v2/localization

Playground

Authorization

bearerAuth

Variables

Key

Value

_limit

_offset

phrase

lang

_include

Samples

---

Adds an existing location.

POST

/api/v2/localization

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"name": true,

  

"abbreviation": 0,

  

"title": "string",

  

"iso": "string",

  

"phrases": "string"

}

Responses

The location was found.

Content-Type

application/json

"string"

POST

/api/v2/localization

Playground

Authorization

bearerAuth

Body

Samples

---

Finds a locationzation by id

GET

/api/v2/localization/{id}

Returns a single locationization

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Id of the localization

Type

string

Required

Query Parameters

phrase

The phrase to include. Preforms a wild cart search.

Type

string

_include

Adds additional details to the results. Supports the following values:

• phrases - Include phrases for each localization.
• defaults - Include the list of default phrases.

Type

string

Responses

The requested localization.

Content-Type

application/json

{

  

"id": "en-US",

  

"name": "en-US",

  

"created": "en-US",

  

"abbreviation": "en-US",

  

"title": "en-US",

  

"iso": "en-US",

  

"phrases": [

  

],

  

"defaults": {

  

}

}

GET

/api/v2/localization/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

phrase

_include

Samples

---

Deletes an existing location.

DELETE

/api/v2/localization/{id}

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Id of the localization

Type

string

Required

Query Parameters

result

Determines the format of repsonse. If not provided the default is id. Can be one of the following values:

• none - no body is returned.
• id - The id of the customer is returend.
• object - The entire object is returned.

Type

string

Responses

The location was found.

Content-Type

application/json

"string"

DELETE

/api/v2/localization/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

result

Samples

---

Updates an existing location.

PATCH

/api/v2/localization/{id}

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Id of the localization language.

Type

string

Required

Query Parameters

result

Determines the format of repsonse. If not provided the default is id. Can be one of the following values:

• none - no body is returned.
• id - The id of the customer is returend.
• object - The entire object is returned.

Type

string

Request Body

application/json

{

  

"name": true,

  

"abbreviation": 0,

  

"title": "string",

  

"iso": "string"

}

Responses

The location was found.

Content-Type

application/json

"string"

PATCH

/api/v2/localization/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

result

Body

Samples

---

List of available phrase names

GET

/api/v2/localization/names

Returns the list of available names

Authorizations

bearerAuth

Type

HTTP (bearer)

Responses

GET

/api/v2/localization/names

Playground

Authorization

bearerAuth

Samples

---

Powered by VitePress OpenAPI