v2.84.0

TS Dev 108 API Documentation

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

---

ShippingMethods

Endpoints to interact with shipping methods

Operations

GET/api/v2/shipping-methodsPOST/api/v2/shipping-methodsGET/api/v2/shipping-methods/{id}DELETE/api/v2/shipping-methods/{id}PATCH/api/v2/shipping-methods/{id}POST/api/v2/shipping-methods/bulk-delete

---

Get shipping methods

GET

/api/v2/shipping-methods

Returns a list of shipping methods

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Responses

Shipping method list

Content-Type

application/json

{

  

"count": 10,

  

"totalCount": 25,

  

"limit": 50,

  

"offset": 25,

  

"data": [

  

]

}

GET

/api/v2/shipping-methods

Playground

Authorization

bearerAuth

Samples

---

Create a new shipping method

POST

/api/v2/shipping-methods

Create shipping method

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

Shipping method object

Content-Type

application/json

{

  

"data": "string"

}

POST

/api/v2/shipping-methods

Playground

Authorization

bearerAuth

Body

Samples

---

Get shipping method by ID

GET

/api/v2/shipping-methods/{id}

Returns a single shipping method

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Shipping method Id

Type

integer

Required

Format

"int64"

Responses

Shipping method object

Content-Type

application/json

{

  

"data": "string"

}

GET

/api/v2/shipping-methods/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Delete a shipping method

DELETE

/api/v2/shipping-methods/{id}

Deletes a shipping method

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

ID of the shipping method to delete

Type

integer

Required

Format

"int64"

Responses

Shipping method deleted successfully

DELETE

/api/v2/shipping-methods/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Update a shipping method

PATCH

/api/v2/shipping-methods/{id}

Update an existing shipping method

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

ID of the shipping method to update

Type

integer

Required

Format

"int64"

Request Body

application/json

"string"

Responses

Shipping method updated

Content-Type

application/json

{

  

"data": "string"

}

PATCH

/api/v2/shipping-methods/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Body

Samples

---

Delete multiple shipping methods

POST

/api/v2/shipping-methods/bulk-delete

Deletes multiple shipping methods

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"ids": [

  

  

[

  

  

  

1,

  

  

  

2,

  

  

  

3

  

  

]

  

]

}

Responses

Shipping methods deleted successfully

POST

/api/v2/shipping-methods/bulk-delete

Playground

Authorization

bearerAuth

Body

Samples

---

Powered by VitePress OpenAPI