Acquire

uploads an image

POST /pet/{petId}/uploadImage

Add a new pet to the store

POST /pet

Update an existing pet

PUT /pet

Finds Pets by status

GET /pet/findByStatus

Finds Pets by tags

GET /pet/findByTags

Find pet by ID

GET /pet/{petId}

Updates a pet in the store with form data

POST /pet/{petId}

Deletes a pet

DELETE /pet/{petId}

POST /pet/{petId}/uploadImage

Authentication

petstore_auth

write:pets

read:pets

Path variables

petId

integer int64 required

ID of pet to update

Request body

multipart/form-data

string binary

Responses

200 200

successful operation

Body

application/json

ApiResponse

POST /pet

Authentication

petstore_auth

write:pets

read:pets

Request body

application/json

application/xml

Pet object that needs to be added to the store

Pet

Responses

405 405

Invalid input

application/json

application/xml

PUT /pet

Authentication

petstore_auth

write:pets

read:pets

Request body

application/json

application/xml

Pet object that needs to be added to the store

Pet

Responses

400 400

Invalid ID supplied

application/json

application/xml

404 404

Pet not found

application/json

application/xml

405 405

Validation exception

application/json

application/xml

GET /pet/findByStatus

Authentication

petstore_auth

write:pets

read:pets

Multiple status values can be provided with comma separated strings

Request parameters

status

array of string required

Status values that need to be considered for filter

Collection format: multi

Responses

200 200

successful operation

Body

application/json

application/xml

Array of Pet

400 400

Invalid status value

application/json

application/xml

GET /pet/findByTags

Authentication

petstore_auth

write:pets

read:pets

Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.

Request parameters

Responses

200 200

successful operation

Body

application/json

application/xml

Array of Pet

400 400

Invalid tag value

application/json

application/xml

GET /pet/{petId}

Authentication

api_key

Returns a single pet

Path variables

petId

integer int64 required

ID of pet to return

Responses

200 200

successful operation

Body

application/json

application/xml

Pet

400 400

Invalid ID supplied

application/json

application/xml

404 404

Pet not found

application/json

application/xml

POST /pet/{petId}

Authentication

petstore_auth

write:pets

read:pets

Path variables

petId

integer int64 required

ID of pet that needs to be updated

Request body

application/x-www-form-urlencoded

Object

name

string

Updated name of the pet

status

string

Updated status of the pet

Responses

405 405

Invalid input

application/json

application/xml

DELETE /pet/{petId}

Authentication

petstore_auth

write:pets

read:pets

Path variables

petId

integer int64 required

Pet id to delete

Request headers

api_key

string optional

Responses

400 400

Invalid ID supplied

application/json

application/xml

404 404

Pet not found

application/json

application/xml

Place an order for a pet

POST /store/order

Find purchase order by ID

GET /store/order/{orderId}

Delete purchase order by ID

DELETE /store/order/{orderId}

Returns pet inventories by status

GET /store/inventory

POST /store/order

Request body

application/json

order placed for purchasing the pet

Order

Responses

200 200

successful operation

Body

application/json

application/xml

Order

400 400

Invalid Order

application/json

application/xml

GET /store/order/{orderId}

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

Path variables

orderId

integer int64 required

ID of pet that needs to be fetched

Min: 1

Max: 10

Responses

200 200

successful operation

Body

application/json

application/xml

Order

400 400

Invalid ID supplied

application/json

application/xml

404 404

Order not found

application/json

application/xml

DELETE /store/order/{orderId}

For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors

Path variables

orderId

integer int64 required

ID of the order that needs to be deleted

Min: 1

Responses

400 400

Invalid ID supplied

application/json

application/xml

404 404

Order not found

application/json

application/xml

GET /store/inventory

Authentication

api_key

Returns a map of status codes to quantities

Responses

200 200

successful operation

Body

application/json

Object

integer int32

Creates list of users with given input array

POST /user/createWithArray

Creates list of users with given input array

POST /user/createWithList

Get user by user name

GET /user/{username}

Updated user

PUT /user/{username}

Delete user

DELETE /user/{username}

Logs user into the system

GET /user/login

Logs out current logged in user session

GET /user/logout

Create user

POST /user

POST /user/createWithArray

Request body

application/json

List of user object

Array of User

Responses

500 default

successful operation

application/json

application/xml

POST /user/createWithList

Request body

application/json

List of user object

Array of User

Responses

500 default

successful operation

application/json

application/xml

GET /user/{username}

Path variables

username

string required

The name that needs to be fetched. Use user1 for testing.

Responses

200 200

successful operation

Body

application/json

application/xml

User

400 400

Invalid username supplied

application/json

application/xml

404 404

User not found

application/json

application/xml

PUT /user/{username}

This can only be done by the logged in user.

Path variables

username

string required

name that need to be updated

Request body

application/json

Updated user object

User

Responses

400 400

Invalid user supplied

application/json

application/xml

404 404

User not found

application/json

application/xml

DELETE /user/{username}

This can only be done by the logged in user.

Path variables

username

string required

The name that needs to be deleted

Responses

400 400

Invalid username supplied

application/json

application/xml

404 404

User not found

application/json

application/xml

GET /user/login

Request parameters

username

string required

The user name for login

password

string required

The password for login in clear text

Responses

200 200

successful operation

Headers

X-Expires-After

string date-time optional

date in UTC when token expires

X-Rate-Limit

integer int32 optional

calls per hour allowed by the user

Body

application/json

application/xml

string

400 400

Invalid username/password supplied

application/json

application/xml

GET /user/logout

Responses

500 default

successful operation

application/json

application/xml

POST /user

This can only be done by the logged in user.

Request body

application/json

Created user object

User

Responses

500 default

successful operation

application/json

application/xml

Object

code

integer int32

type

string

message

string

Object

id

integer int64

name

string

Object

id

integer int64

petId

integer int64

quantity

integer int32

shipDate

string date-time

status

string

Order Status

Enumeration:

placed

approved

delivered

complete

boolean

Object

id

integer int64