Premiere V2 API

Appearance

GET /api/v2/shipping-method/​

GET
/api/v2/shipping-method/

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Query Parameters

name

Search by the name of the shipping method.

Type
string
_limit

Limit Results to this number

Type
integer
Format
"int64"
_offset

Limit Results to this number

Type
integer
Format
"int64"

Responses​

Playground​

Authorization
Variables
Key
Value

Samples​

Returns the requested shipping method.​

GET
/api/v2/shipping-method/{id}

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*

The id of the shipping method

Type
string
Required

Responses​

The requested shipping method.

application/json
JSON
"string"

Playground​

Authorization
Variables
Key
Value

Samples​

Deletes the requested shipping method.​

DELETE
/api/v2/shipping-method/{id}

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*

The id of the shipping method.

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 shipping method is returend.
  • object - The entire object is returned.

Type
string

Responses​

The shipping method that has been deleted. The format of the response depends on the type requested in the _repsonse parameter.

application/json
JSON
"string"

Playground​

Authorization
Variables
Key
Value

Samples​

Updates an existing shipping method.​

PATCH
/api/v2/shipping-method/{id}

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*

The id of the shipping method.

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 shipping method is returend.
  • object - The entire object is returned.

Type
string

Request Body​

application/json
JSON
{
  
"name": "string",
  
"description": "string",
  
"charge": 0,
  
"twoPlusCharge": 0,
  
"chargeType": "string",
  
"hasETickets": true,
  
"requiresShippingInfo": true,
  
"allowInternational": true,
  
"hasBadges": true
}

Responses​

The shipping method was updated. The format of the response depends on the type requested in the _repsonse parameter.

application/json
JSON
"string"

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Add a new shipping method.​

POST
/api/v2/shipping-method

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

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 shipping method is returend.
  • object - The entire object is returned.

Type
string

Request Body​

application/json
JSON
"string"

Responses​

The shipping method was updated. The format of the response depends on the type requested in the _repsonse parameter.

application/json
JSON
"string"

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Returns multiple shipping methods by id.​

POST
/api/v2/shipping-method/bulk-read

Authorizations​

bearerAuth
Type
HTTP (bearer)

Request Body​

application/json
JSON
{
  
"count": 0,
  
"data": [
  
  
0
  
]
}

Responses​

The list of responses.

application/json
JSON
{
  
"count": "string",
  
"data": [
  
  
{
  
  
  
"id": "string",
  
  
  
"status": "string",
  
  
  
"object": "string",
  
  
  
"error": "string"
  
  
}
  
]
}

Playground​

Authorization
Body

Samples​

Adds multiple shipping methods.​

POST
/api/v2/shipping-method/bulk-create

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

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 shipping method is returend.
  • object - The entire object is returned.

Type
string

Request Body​

application/json
JSON
{
  
"count": 0,
  
"data": [
  
]
}

Responses​

The list of responses.

application/json
JSON
"string"

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Updates multiple shipping methods.​

POST
/api/v2/shipping-method/bulk-update

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

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 shipping method is returend.
  • object - The entire object is returned.

Type
string

Request Body​

application/json
JSON
{
  
"count": 0,
  
"data": [
  
  
{
  
  
  
"id": "string",
  
  
  
"data": "string"
  
  
}
  
]
}

Responses​

The list of responses.

application/json
JSON
"string"

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Deletes multiple shipping methods.​

POST
/api/v2/shipping-method/bulk-delete

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

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 shipping method is returend.
  • object - The entire object is returned.

Type
string

Request Body​

application/json
JSON
{
  
"count": 0,
  
"data": [
  
  
0
  
]
}

Responses​

The list of responses.

application/json
JSON
"string"

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI