Skip to content

StoreApi.md

Latest commit

 

History

History
291 lines (189 loc) · 8.08 KB

StoreApi.md

File metadata and controls

291 lines (189 loc) · 8.08 KB

petstore_api.StoreApi

All URIs are relative to http://petstore.swagger.io:80/v2

Method HTTP request Description
delete_order DELETE /store/order/{order_id} Delete purchase order by ID
get_inventory GET /store/inventory Returns pet inventories by status
get_order_by_id GET /store/order/{order_id} Find purchase order by ID
place_order POST /store/order Place an order for a pet

delete_order

delete_order(order_id)

Delete purchase order by ID

For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors

Example

import petstore_api
from petstore_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://petstore.swagger.io:80/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = petstore_api.Configuration(
    host = "http://petstore.swagger.io:80/v2"
)


# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = petstore_api.StoreApi(api_client)
    order_id = 'order_id_example' # str | ID of the order that needs to be deleted

    try:
        # Delete purchase order by ID
        api_instance.delete_order(order_id)
    except Exception as e:
        print("Exception when calling StoreApi->delete_order: %s\n" % e)

Parameters

Name Type Description Notes
order_id str ID of the order that needs to be deleted

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
400 Invalid ID supplied -
404 Order not found -

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

get_inventory

Dict[str, int] get_inventory()

Returns pet inventories by status

Returns a map of status codes to quantities

Example

  • Api Key Authentication (api_key):
import petstore_api
from petstore_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://petstore.swagger.io:80/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = petstore_api.Configuration(
    host = "http://petstore.swagger.io:80/v2"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = petstore_api.StoreApi(api_client)

    try:
        # Returns pet inventories by status
        api_response = api_instance.get_inventory()
        print("The response of StoreApi->get_inventory:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling StoreApi->get_inventory: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

Dict[str, int]

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -

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

get_order_by_id

Order get_order_by_id(order_id)

Find purchase order by ID

For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions

Example

import petstore_api
from petstore_api.models.order import Order
from petstore_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://petstore.swagger.io:80/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = petstore_api.Configuration(
    host = "http://petstore.swagger.io:80/v2"
)


# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = petstore_api.StoreApi(api_client)
    order_id = 56 # int | ID of pet that needs to be fetched

    try:
        # Find purchase order by ID
        api_response = api_instance.get_order_by_id(order_id)
        print("The response of StoreApi->get_order_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling StoreApi->get_order_by_id: %s\n" % e)

Parameters

Name Type Description Notes
order_id int ID of pet that needs to be fetched

Return type

Order

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/xml, application/json

HTTP response details

Status code Description Response headers
200 successful operation -
400 Invalid ID supplied -
404 Order not found -

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

place_order

Order place_order(order)

Place an order for a pet

Example

import petstore_api
from petstore_api.models.order import Order
from petstore_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://petstore.swagger.io:80/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = petstore_api.Configuration(
    host = "http://petstore.swagger.io:80/v2"
)


# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = petstore_api.StoreApi(api_client)
    order = petstore_api.Order() # Order | order placed for purchasing the pet

    try:
        # Place an order for a pet
        api_response = api_instance.place_order(order)
        print("The response of StoreApi->place_order:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling StoreApi->place_order: %s\n" % e)

Parameters

Name Type Description Notes
order Order order placed for purchasing the pet

Return type

Order

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 successful operation -
400 Invalid Order -

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