swagger_client.VShopsApi

All URIs are relative to https://localhost/api/v5

Method	HTTP request	Description
add_shop_item	POST /vshop/shop/{id}/item	Add Shop Item
create_shop	POST /vshop/shop	Create Shops
delete_shop	DELETE /vshop/shop/{id}	Delete a Shop
delete_shop_item	DELETE /vshop/shop/{id}/item/{item}	Removes a Shop Item
get_shop	GET /vshop/shop/{id}	Get a Shop
get_shop_item	GET /vshop/shop/{id}/item/{item}	Get a Shop
list_shop_items	GET /vshop/shop/{id}/item	List Shop Items
list_shops	GET /vshop/shop	List Shops
update_shop	PUT /vshop/shop/{id}	Change Shop
update_shop_item	PUT /vshop/shop/{id}/item/{item}	Change Shop Item

add_shop_item

VillagerShopsStockItem add_shop_item(id, body=body, details=details, accept=accept, pretty=pretty)

Add Shop Item

Add a item to the shops listing Required permissions: - vshop.vshop.item.create

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
configuration = swagger_client.Configuration()
configuration.api_key['X-WebAPI-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-WebAPI-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
configuration = swagger_client.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VShopsApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | 
body = swagger_client.VillagerShopsStockItem() # VillagerShopsStockItem |  (optional)
details = true # bool | Add to include additional details, omit or false otherwise (optional)
accept = 'accept_example' # str | Override the 'Accept' request header (useful for debugging your requests) (optional)
pretty = true # bool | Add to make the Web-API pretty print the response (useful for debugging your requests) (optional)

try:
    # Add Shop Item
    api_response = api_instance.add_shop_item(id, body=body, details=details, accept=accept, pretty=pretty)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VShopsApi->add_shop_item: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
body	VillagerShopsStockItem		[optional]
details	bool	Add to include additional details, omit or false otherwise	[optional]
accept	str	Override the 'Accept' request header (useful for debugging your requests)	[optional]
pretty	bool	Add to make the Web-API pretty print the response (useful for debugging your requests)	[optional]

Return type

VillagerShopsStockItem

Authorization

ApiKeyHeader, ApiKeyQuery

HTTP request headers

Content-Type: application/json, application/xml
Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_shop

VillagerShopsShop create_shop(body=body, details=details, accept=accept, pretty=pretty)

Create Shops

Spawn a new shop with base values; Some values are only set by update Required permissions: - vshop.vshop.create

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
configuration = swagger_client.Configuration()
configuration.api_key['X-WebAPI-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-WebAPI-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
configuration = swagger_client.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VShopsApi(swagger_client.ApiClient(configuration))
body = swagger_client.VillagerShopsShop() # VillagerShopsShop |  (optional)
details = true # bool | Add to include additional details, omit or false otherwise (optional)
accept = 'accept_example' # str | Override the 'Accept' request header (useful for debugging your requests) (optional)
pretty = true # bool | Add to make the Web-API pretty print the response (useful for debugging your requests) (optional)

try:
    # Create Shops
    api_response = api_instance.create_shop(body=body, details=details, accept=accept, pretty=pretty)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VShopsApi->create_shop: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	VillagerShopsShop		[optional]
details	bool	Add to include additional details, omit or false otherwise	[optional]
accept	str	Override the 'Accept' request header (useful for debugging your requests)	[optional]
pretty	bool	Add to make the Web-API pretty print the response (useful for debugging your requests)	[optional]

Return type

VillagerShopsShop

Authorization

ApiKeyHeader, ApiKeyQuery

HTTP request headers

Content-Type: application/json, application/xml
Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_shop

VillagerShopsShop delete_shop(id, details=details, accept=accept, pretty=pretty)

Delete a Shop

Permanently delete a shop from the server Required permissions: - vshop.vshop.delete

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
configuration = swagger_client.Configuration()
configuration.api_key['X-WebAPI-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-WebAPI-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
configuration = swagger_client.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VShopsApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | 
details = true # bool | Add to include additional details, omit or false otherwise (optional)
accept = 'accept_example' # str | Override the 'Accept' request header (useful for debugging your requests) (optional)
pretty = true # bool | Add to make the Web-API pretty print the response (useful for debugging your requests) (optional)

try:
    # Delete a Shop
    api_response = api_instance.delete_shop(id, details=details, accept=accept, pretty=pretty)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VShopsApi->delete_shop: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
details	bool	Add to include additional details, omit or false otherwise	[optional]
accept	str	Override the 'Accept' request header (useful for debugging your requests)	[optional]
pretty	bool	Add to make the Web-API pretty print the response (useful for debugging your requests)	[optional]

Return type

VillagerShopsShop

Authorization

ApiKeyHeader, ApiKeyQuery

HTTP request headers

Content-Type: application/json, application/xml
Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_shop_item

VillagerShopsShop delete_shop_item(id, item, details=details, accept=accept, pretty=pretty)

Removes a Shop Item

Remove an item from this shop Required permissions: - vshop.vshop.item.delete

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
configuration = swagger_client.Configuration()
configuration.api_key['X-WebAPI-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-WebAPI-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
configuration = swagger_client.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VShopsApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | 
item = 56 # int | 
details = true # bool | Add to include additional details, omit or false otherwise (optional)
accept = 'accept_example' # str | Override the 'Accept' request header (useful for debugging your requests) (optional)
pretty = true # bool | Add to make the Web-API pretty print the response (useful for debugging your requests) (optional)

try:
    # Removes a Shop Item
    api_response = api_instance.delete_shop_item(id, item, details=details, accept=accept, pretty=pretty)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VShopsApi->delete_shop_item: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
item	int
details	bool	Add to include additional details, omit or false otherwise	[optional]
accept	str	Override the 'Accept' request header (useful for debugging your requests)	[optional]
pretty	bool	Add to make the Web-API pretty print the response (useful for debugging your requests)	[optional]

Return type

VillagerShopsShop

Authorization

ApiKeyHeader, ApiKeyQuery

HTTP request headers

Content-Type: application/json, application/xml
Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_shop

VillagerShopsShop get_shop(id, details=details, accept=accept, pretty=pretty)

Get a Shop

Get detailed information about a shop Required permissions: - vshop.vshop.one

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
configuration = swagger_client.Configuration()
configuration.api_key['X-WebAPI-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-WebAPI-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
configuration = swagger_client.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VShopsApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | 
details = true # bool | Add to include additional details, omit or false otherwise (optional)
accept = 'accept_example' # str | Override the 'Accept' request header (useful for debugging your requests) (optional)
pretty = true # bool | Add to make the Web-API pretty print the response (useful for debugging your requests) (optional)

try:
    # Get a Shop
    api_response = api_instance.get_shop(id, details=details, accept=accept, pretty=pretty)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VShopsApi->get_shop: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
details	bool	Add to include additional details, omit or false otherwise	[optional]
accept	str	Override the 'Accept' request header (useful for debugging your requests)	[optional]
pretty	bool	Add to make the Web-API pretty print the response (useful for debugging your requests)	[optional]

Return type

VillagerShopsShop

Authorization

ApiKeyHeader, ApiKeyQuery

HTTP request headers

Content-Type: application/json, application/xml
Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_shop_item

VillagerShopsStockItem get_shop_item(id, item, details=details, accept=accept, pretty=pretty)

Get a Shop

Get detailed information about a shop item Required permissions: - vshop.vshop.item.one

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
configuration = swagger_client.Configuration()
configuration.api_key['X-WebAPI-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-WebAPI-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
configuration = swagger_client.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VShopsApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | 
item = 56 # int | 
details = true # bool | Add to include additional details, omit or false otherwise (optional)
accept = 'accept_example' # str | Override the 'Accept' request header (useful for debugging your requests) (optional)
pretty = true # bool | Add to make the Web-API pretty print the response (useful for debugging your requests) (optional)

try:
    # Get a Shop
    api_response = api_instance.get_shop_item(id, item, details=details, accept=accept, pretty=pretty)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VShopsApi->get_shop_item: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
item	int
details	bool	Add to include additional details, omit or false otherwise	[optional]
accept	str	Override the 'Accept' request header (useful for debugging your requests)	[optional]
pretty	bool	Add to make the Web-API pretty print the response (useful for debugging your requests)	[optional]

Return type

VillagerShopsStockItem

Authorization

ApiKeyHeader, ApiKeyQuery

HTTP request headers

Content-Type: application/json, application/xml
Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_shop_items

list[VillagerShopsStockItem] list_shop_items(id, details=details, accept=accept, pretty=pretty)

List Shop Items

Return a list of all shops items Required permissions: - vshop.vshop.item.list

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
configuration = swagger_client.Configuration()
configuration.api_key['X-WebAPI-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-WebAPI-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
configuration = swagger_client.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VShopsApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | 
details = true # bool | Add to include additional details, omit or false otherwise (optional)
accept = 'accept_example' # str | Override the 'Accept' request header (useful for debugging your requests) (optional)
pretty = true # bool | Add to make the Web-API pretty print the response (useful for debugging your requests) (optional)

try:
    # List Shop Items
    api_response = api_instance.list_shop_items(id, details=details, accept=accept, pretty=pretty)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VShopsApi->list_shop_items: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
details	bool	Add to include additional details, omit or false otherwise	[optional]
accept	str	Override the 'Accept' request header (useful for debugging your requests)	[optional]
pretty	bool	Add to make the Web-API pretty print the response (useful for debugging your requests)	[optional]

Return type

list[VillagerShopsStockItem]

Authorization

ApiKeyHeader, ApiKeyQuery

HTTP request headers

Content-Type: application/json, application/xml
Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_shops

list[VillagerShopsShop] list_shops(details=details, accept=accept, pretty=pretty)

List Shops

Return a list of all shops Required permissions: - vshop.vshop.list

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
configuration = swagger_client.Configuration()
configuration.api_key['X-WebAPI-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-WebAPI-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
configuration = swagger_client.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VShopsApi(swagger_client.ApiClient(configuration))
details = true # bool | Add to include additional details, omit or false otherwise (optional)
accept = 'accept_example' # str | Override the 'Accept' request header (useful for debugging your requests) (optional)
pretty = true # bool | Add to make the Web-API pretty print the response (useful for debugging your requests) (optional)

try:
    # List Shops
    api_response = api_instance.list_shops(details=details, accept=accept, pretty=pretty)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VShopsApi->list_shops: %s\n" % e)

Parameters

Name	Type	Description	Notes
details	bool	Add to include additional details, omit or false otherwise	[optional]
accept	str	Override the 'Accept' request header (useful for debugging your requests)	[optional]
pretty	bool	Add to make the Web-API pretty print the response (useful for debugging your requests)	[optional]

Return type

list[VillagerShopsShop]

Authorization

ApiKeyHeader, ApiKeyQuery

HTTP request headers

Content-Type: application/json, application/xml
Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_shop

VillagerShopsShop update_shop(id, body=body, details=details, accept=accept, pretty=pretty)

Change Shop

Modifies values for this shop, but items Required permissions: - vshop.vshop.edit

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
configuration = swagger_client.Configuration()
configuration.api_key['X-WebAPI-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-WebAPI-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
configuration = swagger_client.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VShopsApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | 
body = swagger_client.VillagerShopsShop() # VillagerShopsShop |  (optional)
details = true # bool | Add to include additional details, omit or false otherwise (optional)
accept = 'accept_example' # str | Override the 'Accept' request header (useful for debugging your requests) (optional)
pretty = true # bool | Add to make the Web-API pretty print the response (useful for debugging your requests) (optional)

try:
    # Change Shop
    api_response = api_instance.update_shop(id, body=body, details=details, accept=accept, pretty=pretty)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VShopsApi->update_shop: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
body	VillagerShopsShop		[optional]
details	bool	Add to include additional details, omit or false otherwise	[optional]
accept	str	Override the 'Accept' request header (useful for debugging your requests)	[optional]
pretty	bool	Add to make the Web-API pretty print the response (useful for debugging your requests)	[optional]

Return type

VillagerShopsShop

Authorization

ApiKeyHeader, ApiKeyQuery

HTTP request headers

Content-Type: application/json, application/xml
Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_shop_item

VillagerShopsStockItem update_shop_item(id, item, body=body, details=details, accept=accept, pretty=pretty)

Change Shop Item

Modifies values for this shop item Required permissions: - vshop.vshop.item.edit

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
configuration = swagger_client.Configuration()
configuration.api_key['X-WebAPI-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-WebAPI-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
configuration = swagger_client.Configuration()
configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VShopsApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | 
item = 56 # int | 
body = swagger_client.VillagerShopsStockItem() # VillagerShopsStockItem |  (optional)
details = true # bool | Add to include additional details, omit or false otherwise (optional)
accept = 'accept_example' # str | Override the 'Accept' request header (useful for debugging your requests) (optional)
pretty = true # bool | Add to make the Web-API pretty print the response (useful for debugging your requests) (optional)

try:
    # Change Shop Item
    api_response = api_instance.update_shop_item(id, item, body=body, details=details, accept=accept, pretty=pretty)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VShopsApi->update_shop_item: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
item	int
body	VillagerShopsStockItem		[optional]
details	bool	Add to include additional details, omit or false otherwise	[optional]
accept	str	Override the 'Accept' request header (useful for debugging your requests)	[optional]
pretty	bool	Add to make the Web-API pretty print the response (useful for debugging your requests)	[optional]

Return type

VillagerShopsStockItem

Authorization

ApiKeyHeader, ApiKeyQuery

HTTP request headers

Content-Type: application/json, application/xml
Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

VShopsApi.md

Latest commit

History

VShopsApi.md

File metadata and controls

swagger_client.VShopsApi

add_shop_item

Example

Parameters

Return type

Authorization

HTTP request headers

create_shop

Example

Parameters

Return type

Authorization

HTTP request headers

delete_shop

Example

Parameters

Return type

Authorization

HTTP request headers

delete_shop_item

Example

Parameters

Return type

Authorization

HTTP request headers

get_shop

Example

Parameters

Return type

Authorization

HTTP request headers

get_shop_item

Example

Parameters

Return type

Authorization

HTTP request headers

list_shop_items

Example

Parameters

Return type

Authorization

HTTP request headers

list_shops

Example

Parameters

Return type

Authorization

HTTP request headers

update_shop

Example

Parameters

Return type

Authorization

HTTP request headers

update_shop_item

Example

Parameters

Return type

Authorization

HTTP request headers