swagger_client.ApiApi

All URIs are relative to /

Method	HTTP request	Description
create_address	POST /api/addresses/
create_customer	POST /api/customers/
create_order	POST /api/orders/
create_product	POST /api/products/
create_review	POST /api/reviews/
destroy_address	DELETE /api/addresses/{id}/
destroy_customer	DELETE /api/customers/{id}/
destroy_order	DELETE /api/orders/{id}/
destroy_product	DELETE /api/products/{id}/
destroy_review	DELETE /api/reviews/{id}/
list_address	GET /api/addresses/
list_customers	GET /api/customers/
list_orders	GET /api/orders/
list_products	GET /api/products/
list_reviews	GET /api/reviews/
partial_update_address	PATCH /api/addresses/{id}/
partial_update_customer	PATCH /api/customers/{id}/
partial_update_order	PATCH /api/orders/{id}/
partial_update_product	PATCH /api/products/{id}/
partial_update_review	PATCH /api/reviews/{id}/
retrieve_address	GET /api/addresses/{id}/
retrieve_customer	GET /api/customers/{id}/
retrieve_order	GET /api/orders/{id}/
retrieve_product	GET /api/products/{id}/
retrieve_review	GET /api/reviews/{id}/
update_address	PUT /api/addresses/{id}/
update_customer	PUT /api/customers/{id}/
update_order	PUT /api/orders/{id}/
update_product	PUT /api/products/{id}/
update_review	PUT /api/reviews/{id}/

create_address

Address create_address(body=body)

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: TokenAuthentication
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApiApi(swagger_client.ApiClient(configuration))
body = swagger_client.Address() # Address |  (optional)

try:
    api_response = api_instance.create_address(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->create_address: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	Address		[optional]

Return type

Address

Authorization

TokenAuthentication

HTTP request headers

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

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

create_customer

Customer create_customer(body=body)

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: TokenAuthentication
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApiApi(swagger_client.ApiClient(configuration))
body = swagger_client.Customer() # Customer |  (optional)

try:
    api_response = api_instance.create_customer(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->create_customer: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	Customer		[optional]

Return type

Customer

Authorization

TokenAuthentication

HTTP request headers

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

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

create_order

Order create_order(body=body)

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: TokenAuthentication
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApiApi(swagger_client.ApiClient(configuration))
body = swagger_client.Order() # Order |  (optional)

try:
    api_response = api_instance.create_order(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->create_order: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	Order		[optional]

Return type

Order

Authorization

TokenAuthentication

HTTP request headers

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

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

create_product

Product create_product(body=body)

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: TokenAuthentication
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApiApi(swagger_client.ApiClient(configuration))
body = swagger_client.Product() # Product |  (optional)

try:
    api_response = api_instance.create_product(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->create_product: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	Product		[optional]

Return type

Product

Authorization

TokenAuthentication

HTTP request headers

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

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

create_review

Review create_review(body=body)

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: TokenAuthentication
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApiApi(swagger_client.ApiClient(configuration))
body = swagger_client.Review() # Review |  (optional)

try:
    api_response = api_instance.create_review(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->create_review: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	Review		[optional]

Return type

Review

Authorization

TokenAuthentication

HTTP request headers

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

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

destroy_address

destroy_address(id)

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: TokenAuthentication
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApiApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | A unique integer value identifying this address.

try:
    api_instance.destroy_address(id)
except ApiException as e:
    print("Exception when calling ApiApi->destroy_address: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	A unique integer value identifying this address.

Return type

void (empty response body)

Authorization

TokenAuthentication

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

destroy_customer

destroy_customer(id)

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: TokenAuthentication
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApiApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | A unique integer value identifying this customer.

try:
    api_instance.destroy_customer(id)
except ApiException as e:
    print("Exception when calling ApiApi->destroy_customer: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	A unique integer value identifying this customer.

Return type

void (empty response body)

Authorization

TokenAuthentication

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

destroy_order

destroy_order(id)

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: TokenAuthentication
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApiApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | A unique integer value identifying this order.

try:
    api_instance.destroy_order(id)
except ApiException as e:
    print("Exception when calling ApiApi->destroy_order: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	A unique integer value identifying this order.

Return type

void (empty response body)

Authorization

TokenAuthentication

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

destroy_product

destroy_product(id)

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: TokenAuthentication
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApiApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | A unique integer value identifying this product.

try:
    api_instance.destroy_product(id)
except ApiException as e:
    print("Exception when calling ApiApi->destroy_product: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	A unique integer value identifying this product.

Return type

void (empty response body)

Authorization

TokenAuthentication

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

destroy_review

destroy_review(id)

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: TokenAuthentication
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApiApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | A unique integer value identifying this review.

try:
    api_instance.destroy_review(id)
except ApiException as e:
    print("Exception when calling ApiApi->destroy_review: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	A unique integer value identifying this review.

Return type

void (empty response body)

Authorization

TokenAuthentication

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

list_address

list[Address] list_address()

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: TokenAuthentication
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApiApi(swagger_client.ApiClient(configuration))

try:
    api_response = api_instance.list_address()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->list_address: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

list[Address]

Authorization

TokenAuthentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

list_customers

list[Customer] list_customers()

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: TokenAuthentication
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApiApi(swagger_client.ApiClient(configuration))

try:
    api_response = api_instance.list_customers()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->list_customers: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

list[Customer]

Authorization

TokenAuthentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

list_orders

list[Order] list_orders()

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: TokenAuthentication
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApiApi(swagger_client.ApiClient(configuration))

try:
    api_response = api_instance.list_orders()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->list_orders: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

list[Order]

Authorization

TokenAuthentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

list_products

list[Product] list_products()

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: TokenAuthentication
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApiApi(swagger_client.ApiClient(configuration))

try:
    api_response = api_instance.list_products()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->list_products: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

list[Product]

Authorization

TokenAuthentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

list_reviews

list[Review] list_reviews()

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: TokenAuthentication
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApiApi(swagger_client.ApiClient(configuration))

try:
    api_response = api_instance.list_reviews()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->list_reviews: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

list[Review]

Authorization

TokenAuthentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

partial_update_address

Address partial_update_address(id, body=body)

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: TokenAuthentication
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApiApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | A unique integer value identifying this address.
body = swagger_client.Address() # Address |  (optional)

try:
    api_response = api_instance.partial_update_address(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->partial_update_address: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	A unique integer value identifying this address.
body	Address		[optional]

Return type

Address

Authorization

TokenAuthentication

HTTP request headers

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

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

partial_update_customer

Customer partial_update_customer(id, body=body)

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: TokenAuthentication
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApiApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | A unique integer value identifying this customer.
body = swagger_client.Customer() # Customer |  (optional)

try:
    api_response = api_instance.partial_update_customer(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->partial_update_customer: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	A unique integer value identifying this customer.
body	Customer		[optional]

Return type

Customer

Authorization

TokenAuthentication

HTTP request headers

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

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

partial_update_order

Order partial_update_order(id, body=body)

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: TokenAuthentication
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApiApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | A unique integer value identifying this order.
body = swagger_client.Order() # Order |  (optional)

try:
    api_response = api_instance.partial_update_order(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->partial_update_order: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	A unique integer value identifying this order.
body	Order		[optional]

Return type

Order

Authorization

TokenAuthentication

HTTP request headers

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

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

partial_update_product

Product partial_update_product(id, body=body)

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: TokenAuthentication
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApiApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | A unique integer value identifying this product.
body = swagger_client.Product() # Product |  (optional)

try:
    api_response = api_instance.partial_update_product(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->partial_update_product: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	A unique integer value identifying this product.
body	Product		[optional]

Return type

Product

Authorization

TokenAuthentication

HTTP request headers

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

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

partial_update_review

Review partial_update_review(id, body=body)

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: TokenAuthentication
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApiApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | A unique integer value identifying this review.
body = swagger_client.Review() # Review |  (optional)

try:
    api_response = api_instance.partial_update_review(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->partial_update_review: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	A unique integer value identifying this review.
body	Review		[optional]

Return type

Review

Authorization

TokenAuthentication

HTTP request headers

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

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

retrieve_address

Address retrieve_address(id)

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: TokenAuthentication
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApiApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | A unique integer value identifying this address.

try:
    api_response = api_instance.retrieve_address(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->retrieve_address: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	A unique integer value identifying this address.

Return type

Address

Authorization

TokenAuthentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

retrieve_customer

Customer retrieve_customer(id)

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: TokenAuthentication
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApiApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | A unique integer value identifying this customer.

try:
    api_response = api_instance.retrieve_customer(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->retrieve_customer: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	A unique integer value identifying this customer.

Return type

Customer

Authorization

TokenAuthentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

retrieve_order

Order retrieve_order(id)

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: TokenAuthentication
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApiApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | A unique integer value identifying this order.

try:
    api_response = api_instance.retrieve_order(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->retrieve_order: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	A unique integer value identifying this order.

Return type

Order

Authorization

TokenAuthentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

retrieve_product

Product retrieve_product(id)

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: TokenAuthentication
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApiApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | A unique integer value identifying this product.

try:
    api_response = api_instance.retrieve_product(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->retrieve_product: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	A unique integer value identifying this product.

Return type

Product

Authorization

TokenAuthentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

retrieve_review

Review retrieve_review(id)

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: TokenAuthentication
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApiApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | A unique integer value identifying this review.

try:
    api_response = api_instance.retrieve_review(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->retrieve_review: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	A unique integer value identifying this review.

Return type

Review

Authorization

TokenAuthentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

update_address

Address update_address(id, body=body)

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: TokenAuthentication
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApiApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | A unique integer value identifying this address.
body = swagger_client.Address() # Address |  (optional)

try:
    api_response = api_instance.update_address(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->update_address: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	A unique integer value identifying this address.
body	Address		[optional]

Return type

Address

Authorization

TokenAuthentication

HTTP request headers

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

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

update_customer

Customer update_customer(id, body=body)

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: TokenAuthentication
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApiApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | A unique integer value identifying this customer.
body = swagger_client.Customer() # Customer |  (optional)

try:
    api_response = api_instance.update_customer(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->update_customer: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	A unique integer value identifying this customer.
body	Customer		[optional]

Return type

Customer

Authorization

TokenAuthentication

HTTP request headers

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

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

update_order

Order update_order(id, body=body)

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: TokenAuthentication
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApiApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | A unique integer value identifying this order.
body = swagger_client.Order() # Order |  (optional)

try:
    api_response = api_instance.update_order(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->update_order: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	A unique integer value identifying this order.
body	Order		[optional]

Return type

Order

Authorization

TokenAuthentication

HTTP request headers

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

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

update_product

Product update_product(id, body=body)

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: TokenAuthentication
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApiApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | A unique integer value identifying this product.
body = swagger_client.Product() # Product |  (optional)

try:
    api_response = api_instance.update_product(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->update_product: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	A unique integer value identifying this product.
body	Product		[optional]

Return type

Product

Authorization

TokenAuthentication

HTTP request headers

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

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

update_review

Review update_review(id, body=body)

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: TokenAuthentication
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApiApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | A unique integer value identifying this review.
body = swagger_client.Review() # Review |  (optional)

try:
    api_response = api_instance.update_review(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->update_review: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	A unique integer value identifying this review.
body	Review		[optional]

Return type

Review

Authorization

TokenAuthentication

HTTP request headers

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

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

Files

ApiApi.md

Latest commit

History

ApiApi.md

File metadata and controls

swagger_client.ApiApi

create_address

Example

Parameters

Return type

Authorization

HTTP request headers

create_customer

Example

Parameters

Return type

Authorization

HTTP request headers

create_order

Example

Parameters

Return type

Authorization

HTTP request headers

create_product

Example

Parameters

Return type

Authorization

HTTP request headers

create_review

Example

Parameters

Return type

Authorization

HTTP request headers

destroy_address

Example

Parameters

Return type

Authorization

HTTP request headers

destroy_customer

Example

Parameters

Return type

Authorization

HTTP request headers

destroy_order

Example

Parameters

Return type

Authorization

HTTP request headers

destroy_product

Example

Parameters

Return type

Authorization

HTTP request headers

destroy_review

Example

Parameters

Return type

Authorization

HTTP request headers

list_address

Example

Parameters

Return type

Authorization

HTTP request headers

list_customers

Example

Parameters

Return type

Authorization

HTTP request headers

list_orders