v2.84.0

TS Dev 108 API Documentation

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

---

EventShippingMethods

Endpoints to interact with event-level shipping method settings

Operations

GET/api/v2/events/{eventId}/shipping-methodsPATCH/api/v2/events/{eventId}/shipping-methods/{id}PATCH/api/v2/events/{eventId}/shipping-methods/bulk-update

---

Get event shipping methods

GET

/api/v2/events/{eventId}/shipping-methods

Returns a list of shipping methods assigned to the given event, including event-specific settings such as shipping cutoff.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

eventId*

Event ID

Type

integer

Required

Format

"int64"

Responses

Paginated list of event shipping methods

Content-Type

application/json

{

  

"count": 10,

  

"totalCount": 25,

  

"limit": 50,

  

"offset": 25,

  

"data": [

  

]

}

GET

/api/v2/events/{eventId}/shipping-methods

Playground

Authorization

bearerAuth

Variables

Key

Value

eventId*

Samples

---

Update event shipping method settings

PATCH

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

Update event-specific shipping method settings (e.g. shipping cutoff)

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

eventId*

Event ID

Type

integer

Required

Format

"int64"

id*

Shipping Method ID

Type

integer

Required

Format

"int64"

Request Body

application/json

"string"

Responses

Updated event shipping method

Content-Type

application/json

{

  

"data": "string"

}

PATCH

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

Playground

Authorization

bearerAuth

Variables

Key

Value

eventId*

id*

Body

Samples

---

Bulk update event shipping method settings

PATCH

/api/v2/events/{eventId}/shipping-methods/bulk-update

Update event-specific shipping method settings (e.g. shipping cutoff) for multiple shipping methods.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

eventId*

Event ID

Type

integer

Required

Format

"int64"

Request Body

application/json

"string"

Responses

Updated event shipping methods

Content-Type

application/json

{

  

"data": [

  

]

}

PATCH

/api/v2/events/{eventId}/shipping-methods/bulk-update

Playground

Authorization

bearerAuth

Variables

Key

Value

eventId*

Body

Samples

---

Powered by VitePress OpenAPI