Swagger Petstore 1.0.0 Terms of Service Apache 2.0

This is a sample server Petstore server. You can find out more about Swagger at http://swagger.io or on irc.freenode.net, #swagger. For this sample, you can use the api key special-key to test the authorization filters.

Server

petstore.swagger.io

Authentication

oauth2 petstore_auth

OAuth2 implicit authentication through a dialog

FlowImplicit

Authorization URLhttps://petstore.swagger.io/oauth/dialog

Scopes

Name	Description
read:pets	Read your pets
write:pets	Modify pets in your account

apiKey api_key

Use your API Key provided in your Account Settings

Fields

Key	In
api_key	Header

Pet

Everything about your Pets

/pet/{petId}/uploadImage

Add a new pet to the store

Auth

Required Scopes:write:petsread:pets

Request Body application/json application/xml

object	object	Pet object
id	int64	Pet ID
category	object	Category object
id	int64	Category ID
name	string	Category name
name	string	Name of the pet
photoUrls	array[string]	Array of all photo URLs of the pet
tags	array[object]	Tags associated with the pet
id	int64	Tag ID
name	string	Tag name
status	string	Pet status in the store Enum: `available`,`pending`,`sold`

POST /pet

xxxxxxxxxx
 
curl --request POST \ --url 'https://petstore.swagger.io/v2/pet' \ --header 'Authorization: Bearer {token}' \ --data '{  "category": {    "id": 2,    "name": "dogs"  },  "name": "doggie",  "photoUrls": [    "https://swaggerphoto.com/photo.png"  ],  "tags": [    {      "id": 5,      "name": "adult"    }  ],  "status": "available"}'
Copy

Responses application/xml application/json

405

Invalid input

No response body

Response

xxxxxxxxxx
 
No response
Copy

Update an existing pet

Auth

Required Scopes:write:petsread:pets

Request Body application/json application/xml

object	object	Pet object
id	int64	Pet ID
category	object	Category object
id	int64	Category ID
name	string	Category name
name	string	Name of the pet
photoUrls	array[string]	Array of all photo URLs of the pet
tags	array[object]	Tags associated with the pet
id	int64	Tag ID
name	string	Tag name
status	string	Pet status in the store Enum: `available`,`pending`,`sold`

PUT /pet

xxxxxxxxxx
 
curl --request PUT \ --url 'https://petstore.swagger.io/v2/pet' \ --header 'Authorization: Bearer {token}' \ --data '{  "category": {    "id": 2,    "name": "dogs"  },  "name": "doggie",  "photoUrls": [    "https://swaggerphoto.com/photo.png"  ],  "tags": [    {      "id": 5,      "name": "adult"    }  ],  "status": "available"}'
Copy

Responses application/xml application/json

400

Invalid ID supplied

No response body

404

Pet not found

405

Validation exception

Response

xxxxxxxxxx
 
No response
Copy

Finds Pets by status

Multiple status values can be provided with comma separated strings

Auth

Required Scopes:write:petsread:pets

Query String

status

array

Status values that need to be considered for filter

Enum: available,pending,sold

GET /pet/findByStatus

xxxxxxxxxx
 
curl --get \ --url 'https://petstore.swagger.io/v2/pet/findByStatus' \ --header 'Authorization: Bearer {token}' \ --data status={status}
Copy

Responses application/xml application/json

200

Successful Operation

array	array[object]
id	int64	Pet ID
category	object	Category object
id	int64	Category ID
name	string	Category name
name	string	Name of the pet
photoUrls	array[string]	Array of all photo URLs of the pet
tags	array[object]	Tags associated with the pet
id	int64	Tag ID
name	string	Tag name
status	string	Pet status in the store Enum: `available`,`pending`,`sold`

400

Invalid status value

Response

xxxxxxxxxx
 
{ "id": 10, "category": {  "id": 2,  "name": "dogs" }, "name": "doggie", "photoUrls": [  "https://swaggerphoto.com/photo.png" ], "tags": [  {   "id": 5,   "name": "adult"  } ], "status": "available"}
Copy

Finds Pets by tagsDeprecated

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

Auth

Required Scopes:write:petsread:pets

Query String

Find pet by ID

Returns a single pet

Auth

Path Params

petId

integer

ID of pet to return

GET /pet/{petId}

xxxxxxxxxx
 
curl --get \ --url 'https://petstore.swagger.io/v2/pet/%7BpetId%7D' \ --header 'api_key: {api_key}'
Copy

Responses application/xml application/json

200

Successful Operation

object	object	Pet object
id	int64	Pet ID
category	object	Category object
id	int64	Category ID
name	string	Category name
name	string	Name of the pet
photoUrls	array[string]	Array of all photo URLs of the pet
tags	array[object]	Tags associated with the pet
id	int64	Tag ID
name	string	Tag name
status	string	Pet status in the store Enum: `available`,`pending`,`sold`

400

Invalid ID supplied

404

Pet not found

Response

xxxxxxxxxx
 
{ "id": 10, "category": {  "id": 2,  "name": "dogs" }, "name": "doggie", "photoUrls": [  "https://swaggerphoto.com/photo.png" ], "tags": [  {   "id": 5,   "name": "adult"  } ], "status": "available"}
Copy

Updates a pet in the store with form data

Auth

Required Scopes:write:petsread:pets

Path Params

petId

integer

ID of pet that needs to be updated

Form Data

name	string	Updated name of the pet
status	string	Updated status of the pet

POST /pet/{petId}

xxxxxxxxxx
 
curl --request POST \ --url 'https://petstore.swagger.io/v2/pet/%7BpetId%7D' \ --header 'Authorization: Bearer {token}' \ --data 'name={name}' \ --data 'status={status}'
Copy

Responses application/xml application/json

405

Invalid input

No response body

Response

xxxxxxxxxx
 
No response
Copy

Deletes a pet

Auth

Required Scopes:write:petsread:pets

Headers

api_key string

Path Params

petId

integer

Pet ID to delete

DELETE /pet/{petId}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://petstore.swagger.io/v2/pet/%7BpetId%7D' \ --header 'api_key: {api_key}' \ --header 'Authorization: Bearer {token}'
Copy

Responses application/xml application/json

400

Invalid ID supplied

No response body

404

Pet not found

Response

xxxxxxxxxx
 
No response
Copy

Uploads an image

Auth

Required Scopes:write:petsread:pets

Path Params

petId

integer

ID of pet to update

Form Data

additionalMetadata	string	Additional data to pass to server
file	file	File to upload

POST /pet/{petId}/uploadImage

xxxxxxxxxx
 
curl --request POST \ --url 'https://petstore.swagger.io/v2/pet/%7BpetId%7D/uploadImage' \ --header 'Authorization: Bearer {token}' \ --form 'additionalMetadata={additionalMetadata}' --form 'file=@{file}'
Copy

Responses application/json

200

Successful Operation

object	object
code	int32	Response code
type	string	Response type
message	string	Response message

Response

xxxxxxxxxx
 
{ "code": 10, "type": "success", "message": "Image uploaded"}
Copy

Store

Access to Petstore orders

/store/order/{orderId}

DELETE

/store/order/{orderId}

Returns pet inventories by status

Returns a map of status codes to quantities

Auth

GET /store/inventory

xxxxxxxxxx
 
curl --get \ --url 'https://petstore.swagger.io/v2/store/inventory' \ --header 'api_key: {api_key}'
Copy

Responses application/json

200

Successful Operation

object	object
*	int32

Response

xxxxxxxxxx
 
{}
Copy

Place an order for a pet

Auth

Request Body

object	object
id	int64	Order ID
petId	int64	Pet ID
quantity	int32	Order quantity
shipDate	date-time	Ship date
status	string	Order Status Enum: `placed`,`approved`,`delivered`
complete	boolean	Is order complete?

POST /store/order

xxxxxxxxxx
 
curl --request POST \ --url 'https://petstore.swagger.io/v2/store/order' \ --data '{  "petId": 23,  "quantity": 5,  "shipDate": "2018-11-28T20:29:18.937Z",  "status": "placed",  "complete": false}'
Copy

Responses application/xml application/json

200

Successful Operation

object	object
id	int64	Order ID
petId	int64	Pet ID
quantity	int32	Order quantity
shipDate	date-time	Ship date
status	string	Order Status Enum: `placed`,`approved`,`delivered`
complete	boolean	Is order complete?

400

Invalid Order

Response

xxxxxxxxxx
 
{ "id": 1, "petId": 23, "quantity": 5, "shipDate": "2018-11-28T20:29:18.937Z", "status": "placed", "complete": false}
Copy

Find purchase order by ID

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

Auth

Path Params

orderId

integer

ID of pet that needs to be fetched

maximum: 10

minimum: 1

GET /store/order/{orderId}

xxxxxxxxxx
 
curl --get \ --url 'https://petstore.swagger.io/v2/store/order/%7BorderId%7D'
Copy

Responses application/xml application/json

200

Successful Operation

object	object
id	int64	Order ID
petId	int64	Pet ID
quantity	int32	Order quantity
shipDate	date-time	Ship date
status	string	Order Status Enum: `placed`,`approved`,`delivered`
complete	boolean	Is order complete?

400

Invalid ID supplied

404

Order not found

Response

xxxxxxxxxx
 
{ "id": 1, "petId": 23, "quantity": 5, "shipDate": "2018-11-28T20:29:18.937Z", "status": "placed", "complete": false}
Copy

Delete purchase order by ID

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

Auth

Path Params

orderId

integer

ID of the order that needs to be deleted

minimum: 1

DELETE /store/order/{orderId}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://petstore.swagger.io/v2/store/order/%7BorderId%7D'
Copy

Responses application/xml application/json

400

Invalid ID supplied

No response body

404

Order not found

Response

xxxxxxxxxx
 
No response
Copy

User

Operations about user

POST

/user

POST

/user/createWithArray

Create user

This can only be done by the logged in user.

Auth

Request Body

object	object	User object
id	int64	User ID
username	string	Username
firstName	string	First Name
lastName	string	Last Name
email	string	User e-mail address
password	string	User password
phone	string	Phone Number
userStatus	int32	User Status

POST /user

xxxxxxxxxx
 
curl --request POST \ --url 'https://petstore.swagger.io/v2/user' \ --data '{  "username": "user1",  "firstName": "John",  "lastName": "Doe",  "email": "john@doe.com",  "password": "johnd0e",  "phone": "09125553234",  "userStatus": 3}'
Copy

Responses application/xml application/json

default

Successful Operation

No response body

Response

xxxxxxxxxx
 
No response
Copy

Creates list of users with given input array

Auth

Request Body

array	array[object]
id	int64	User ID
username	string	Username
firstName	string	First Name
lastName	string	Last Name
email	string	User e-mail address
password	string	User password
phone	string	Phone Number
userStatus	int32	User Status

POST /user/createWithArray

xxxxxxxxxx
 
curl --request POST \ --url 'https://petstore.swagger.io/v2/user/createWithArray' \ --data '[  {    "username": "user1",    "firstName": "John",    "lastName": "Doe",    "email": "john@doe.com",    "password": "johnd0e",    "phone": "09125553234",    "userStatus": 3  }]'
Copy

Responses application/xml application/json

default

Successful Operation

No response body

Response

xxxxxxxxxx
 
No response
Copy

Creates list of users with given input array

Auth

Request Body

array	array[object]
id	int64	User ID
username	string	Username
firstName	string	First Name
lastName	string	Last Name
email	string	User e-mail address
password	string	User password
phone	string	Phone Number
userStatus	int32	User Status

POST /user/createWithList

xxxxxxxxxx
 
curl --request POST \ --url 'https://petstore.swagger.io/v2/user/createWithList' \ --data '{  "username": "user1",  "firstName": "John",  "lastName": "Doe",  "email": "john@doe.com",  "password": "johnd0e",  "phone": "09125553234",  "userStatus": 3}'
Copy

Responses application/xml application/json

default

Successful Operation

No response body

Response

xxxxxxxxxx
 
No response
Copy

Logs user into the system

Auth

Query String

username	string	The user name for login
password	string	The password for login in clear text

GET /user/login

xxxxxxxxxx
 
curl --get \ --url 'https://petstore.swagger.io/v2/user/login' \ --data username={username} \ --data password={password}
Copy

Responses application/xml application/json

200

Successful Operation

Headers
Body
string	string

400

Invalid username/password supplied

Response

xxxxxxxxxx
 
{ "schema": "{string}"}
Copy

Logs out current logged in user session

Auth

GET /user/logout

xxxxxxxxxx
 
curl --get \ --url 'https://petstore.swagger.io/v2/user/logout'
Copy

Responses application/xml application/json

default

Successful Operation

No response body

Response

xxxxxxxxxx
 
No response
Copy

Get user by user name

Auth

Path Params

username

string

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

GET /user/{username}

xxxxxxxxxx
 
curl --get \ --url 'https://petstore.swagger.io/v2/user/%7Busername%7D'
Copy

Responses application/xml application/json

200

Successful Operation

object	object	User object
id	int64	User ID
username	string	Username
firstName	string	First Name
lastName	string	Last Name
email	string	User e-mail address
password	string	User password
phone	string	Phone Number
userStatus	int32	User Status

400

Invalid username supplied

404

User not found

Response

xxxxxxxxxx
 
{ "id": 5, "username": "user1", "firstName": "John", "lastName": "Doe", "email": "john@doe.com", "password": "johnd0e", "phone": "09125553234", "userStatus": 3}
Copy

Updated user

This can only be done by the logged in user.

Auth

Path Params

username

string

Name that needs to be updated

Request Body

object	object	User object
id	int64	User ID
username	string	Username
firstName	string	First Name
lastName	string	Last Name
email	string	User e-mail address
password	string	User password
phone	string	Phone Number
userStatus	int32	User Status

PUT /user/{username}

xxxxxxxxxx
 
curl --request PUT \ --url 'https://petstore.swagger.io/v2/user/%7Busername%7D' \ --data '{  "username": "user1",  "firstName": "John",  "lastName": "Doe",  "email": "john@doe.com",  "password": "johnd0e",  "phone": "09125553234",  "userStatus": 3}'
Copy

Responses application/xml application/json

400

Invalid user supplied

No response body

404

User not found

Response

xxxxxxxxxx
 
No response
Copy

Delete user

This can only be done by the logged in user.

Auth

Path Params

username

string

The name that needs to be deleted

DELETE /user/{username}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://petstore.swagger.io/v2/user/%7Busername%7D'
Copy

Responses application/xml application/json

400

Invalid username supplied

No response body

404

User not found

Response

xxxxxxxxxx
 
No response
Copy

Swagger Petstore 1.0.0Terms of ServiceApache 2.0

Authentication

Pet

Add a new pet to the store

Update an existing pet

Finds Pets by status

Finds Pets by tagsDeprecated

Find pet by ID

Updates a pet in the store with form data

Deletes a pet

Uploads an image

Store

Returns pet inventories by status

Place an order for a pet

Find purchase order by ID

Delete purchase order by ID

User

Create user

Creates list of users with given input array

Creates list of users with given input array

Logs user into the system

Logs out current logged in user session

Get user by user name

Updated user

Delete user

Swagger Petstore 1.0.0 Terms of Service Apache 2.0