object	object
id	int64
name	string
category	object
id	int64
name	string
photoUrls	array[string]
tags	array[object]
id	int64
name	string
status	string	pet status in the store Enum: `available`,`pending`,`sold`

PUT /pet

xxxxxxxxxx
 
curl --request PUT \ --url 'https://petstore3.swagger.io/api/v3/pet' \ --header 'api_key: {api_key}' \ --data '{  "id": 10,  "name": "doggie",  "category": {    "id": 1,    "name": "Dogs"  },  "photoUrls": [    "{array[string]...}"  ],  "tags": [    {      "id": "{int64}",      "name": "{string}"    }  ],  "status": "{string}"}'
Copy

Responses

200

Successful operation

object	object
id	int64
name	string
category	object
id	int64
name	string
photoUrls	array[string]
tags	array[object]
id	int64
name	string
status	string	pet status in the store Enum: `available`,`pending`,`sold`

400

Invalid ID supplied

404

Pet not found

405

Validation exception

Response

xxxxxxxxxx
 
{ "id": 10, "name": "doggie", "category": {  "id": 1,  "name": "Dogs" }, "photoUrls": [  "{array[string]...}" ], "tags": [  {   "id": "{int64}",   "name": "{string}"  } ], "status": "{string}"}
Copy

Add a new pet to the store

Auth

Request Body

Create a new pet in the store

object	object
id	int64
name	string
category	object
id	int64
name	string
photoUrls	array[string]
tags	array[object]
id	int64
name	string
status	string	pet status in the store Enum: `available`,`pending`,`sold`

POST /pet

xxxxxxxxxx
 
curl --request POST \ --url 'https://petstore3.swagger.io/api/v3/pet' \ --header 'api_key: {api_key}' \ --data '{  "id": 10,  "name": "doggie",  "category": {    "id": 1,    "name": "Dogs"  },  "photoUrls": [    "{array[string]...}"  ],  "tags": [    {      "id": "{int64}",      "name": "{string}"    }  ],  "status": "{string}"}'
Copy

Responses

200

Successful operation

object	object
id	int64
name	string
category	object
id	int64
name	string
photoUrls	array[string]
tags	array[object]
id	int64
name	string
status	string	pet status in the store Enum: `available`,`pending`,`sold`

405

Invalid input

Response

xxxxxxxxxx
 
{ "id": 10, "name": "doggie", "category": {  "id": 1,  "name": "Dogs" }, "photoUrls": [  "{array[string]...}" ], "tags": [  {   "id": "{int64}",   "name": "{string}"  } ], "status": "{string}"}
Copy

Finds Pets by status

Multiple status values can be provided with comma separated strings

Auth

Query String

status

string

Status values that need to be considered for filter

Enum: available,pending,sold

Default: available

GET /pet/findByStatus

xxxxxxxxxx
 
curl --get \ --url 'https://petstore3.swagger.io/api/v3/pet/findByStatus' \ --header 'api_key: {api_key}' \ --data status=available
Copy

Responses

200

successful operation

array	array[object]
id	int64
name	string
category	object
id	int64
name	string
photoUrls	array[string]
tags	array[object]
id	int64
name	string
status	string	pet status in the store Enum: `available`,`pending`,`sold`

400

Invalid status value

Response

xxxxxxxxxx
 
[ {  "id": 10,  "name": "doggie",  "category": {   "id": 1,   "name": "Dogs"  },  "photoUrls": [   "{array[string]...}"  ],  "tags": [   {    "id": "{int64}",    "name": "{string}"   }  ],  "status": "{string}" }]
Copy

Finds Pets by tags

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

Auth

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://petstore3.swagger.io/api/v3/pet/{petId}' \ --header 'api_key: {api_key}'
Copy

Responses

200

successful operation

object	object
id	int64
name	string
category	object
id	int64
name	string
photoUrls	array[string]
tags	array[object]
id	int64
name	string
status	string	pet status in the store Enum: `available`,`pending`,`sold`

400

Invalid ID supplied

404

Pet not found

Response

xxxxxxxxxx
 
{ "id": 10, "name": "doggie", "category": {  "id": 1,  "name": "Dogs" }, "photoUrls": [  "{array[string]...}" ], "tags": [  {   "id": "{int64}",   "name": "{string}"  } ], "status": "{string}"}
Copy

Updates a pet in the store with form data

Auth

Path Params

petId

integer

ID of pet that needs to be updated

Query String

name	string	Name of pet that needs to be updated
status	string	Status of pet that needs to be updated

POST /pet/{petId}

xxxxxxxxxx
 
curl --request POST \ --url 'https://petstore3.swagger.io/api/v3/pet/{petId}' \ --header 'api_key: {api_key}' \ --data name={name} \ --data status={status}
Copy

Responses

405

Invalid input

No response body

Response

xxxxxxxxxx
 
No response
Copy

Deletes a pet

Auth

Headers

api_key string

Path Params

petId

integer

Pet id to delete

DELETE /pet/{petId}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://petstore3.swagger.io/api/v3/pet/{petId}' \ --header 'api_key: {api_key}' \ --header 'api_key: {api_key}'
Copy

Responses

400

Invalid pet value

No response body

Response

xxxxxxxxxx
 
No response
Copy

uploads an image

Auth

Path Params

petId

integer

ID of pet to update

Query String

additionalMetadata

string

Additional Metadata

Request Body

file file

POST /pet/{petId}/uploadImage

xxxxxxxxxx
 
curl --request POST \ --url 'https://petstore3.swagger.io/api/v3/pet/{petId}/uploadImage' \ --header 'api_key: {api_key}' \ --data additionalMetadata={additionalMetadata} \ --data-binary '{  "schema": "{file}"}'
Copy

Responses

200

successful operation

object	object
code	int32
type	string
message	string

Response

xxxxxxxxxx
 
{ "code": "{int32}", "type": "{string}", "message": "{string}"}
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://petstore3.swagger.io/api/v3/store/inventory' \ --header 'api_key: {api_key}'
Copy

Responses

200

successful operation

object	object
*	int32

Response

xxxxxxxxxx
 
{}
Copy

Place an order for a pet

Place a new order in the store

Auth

Request Body

object	object
id	int64
petId	int64
quantity	int32
shipDate	date-time
status	string	Order Status Enum: `placed`,`approved`,`delivered`
complete	boolean

POST /store/order

xxxxxxxxxx
 
curl --request POST \ --url 'https://petstore3.swagger.io/api/v3/store/order' \ --header 'api_key: {api_key}' \ --data '{  "id": 10,  "petId": 198772,  "quantity": 7,  "shipDate": "{date-time}",  "status": "approved",  "complete": "{boolean}"}'
Copy

Responses

200

successful operation

object	object
id	int64
petId	int64
quantity	int32
shipDate	date-time
status	string	Order Status Enum: `placed`,`approved`,`delivered`
complete	boolean

405

Invalid input

Response

xxxxxxxxxx
 
{ "id": 10, "petId": 198772, "quantity": 7, "shipDate": "{date-time}", "status": "approved", "complete": "{boolean}"}
Copy

Find purchase order by ID

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

Auth

Path Params

orderId

integer

ID of order that needs to be fetched

GET /store/order/{orderId}

xxxxxxxxxx
 
curl --get \ --url 'https://petstore3.swagger.io/api/v3/store/order/{orderId}' \ --header 'api_key: {api_key}'
Copy

Responses

200

successful operation

object	object
id	int64
petId	int64
quantity	int32
shipDate	date-time
status	string	Order Status Enum: `placed`,`approved`,`delivered`
complete	boolean

400

Invalid ID supplied

404

Order not found

Response

xxxxxxxxxx
 
{ "id": 10, "petId": 198772, "quantity": 7, "shipDate": "{date-time}", "status": "approved", "complete": "{boolean}"}
Copy

Delete purchase order by ID

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

Auth

Path Params

orderId

integer

ID of the order that needs to be deleted

DELETE /store/order/{orderId}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://petstore3.swagger.io/api/v3/store/order/{orderId}' \ --header 'api_key: {api_key}'
Copy

Responses

400

Invalid ID supplied

No response body

404

Order not found

Response

xxxxxxxxxx
 
No response
Copy

User

Operations about user

Create user

This can only be done by the logged in user.

Auth

Request Body

Created user object

object	object
id	int64
username	string
firstName	string
lastName	string
email	string
password	string
phone	string
userStatus	int32	User Status

POST /user

xxxxxxxxxx
 
curl --request POST \ --url 'https://petstore3.swagger.io/api/v3/user' \ --header 'api_key: {api_key}' \ --data '{  "id": 10,  "username": "theUser",  "firstName": "John",  "lastName": "James",  "email": "john@email.com",  "password": "12345",  "phone": "12345",  "userStatus": 1}'
Copy

Responses

default

successful operation

object	object
id	int64
username	string
firstName	string
lastName	string
email	string
password	string
phone	string
userStatus	int32	User Status

Response

xxxxxxxxxx
 
{ "id": 10, "username": "theUser", "firstName": "John", "lastName": "James", "email": "john@email.com", "password": "12345", "phone": "12345", "userStatus": 1}
Copy

Creates list of users with given input array

Auth

Request Body

array	array[object]
id	int64
username	string
firstName	string
lastName	string
email	string
password	string
phone	string
userStatus	int32	User Status

POST /user/createWithList

xxxxxxxxxx
 
curl --request POST \ --url 'https://petstore3.swagger.io/api/v3/user/createWithList' \ --header 'api_key: {api_key}' \ --data '[  {    "id": 10,    "username": "theUser",    "firstName": "John",    "lastName": "James",    "email": "john@email.com",    "password": "12345",    "phone": "12345",    "userStatus": 1  }]'
Copy

Responses

200

Successful operation

object	object
id	int64
username	string
firstName	string
lastName	string
email	string
password	string
phone	string
userStatus	int32	User Status

default

successful operation

Response

xxxxxxxxxx
 
{ "id": 10, "username": "theUser", "firstName": "John", "lastName": "James", "email": "john@email.com", "password": "12345", "phone": "12345", "userStatus": 1}
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://petstore3.swagger.io/api/v3/user/login' \ --header 'api_key: {api_key}' \ --data username={username} \ --data password={password}
Copy

Responses

200

successful operation

Headers
X-Rate-Limit	integer	calls per hour allowed by the user
X-Expires-After	string	date in UTC when token expires
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://petstore3.swagger.io/api/v3/user/logout' \ --header 'api_key: {api_key}'
Copy

Responses

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://petstore3.swagger.io/api/v3/user/{username}' \ --header 'api_key: {api_key}'
Copy

Responses

200

successful operation

object	object
id	int64
username	string
firstName	string
lastName	string
email	string
password	string
phone	string
userStatus	int32	User Status

400

Invalid username supplied

404

User not found

Response

xxxxxxxxxx
 
{ "id": 10, "username": "theUser", "firstName": "John", "lastName": "James", "email": "john@email.com", "password": "12345", "phone": "12345", "userStatus": 1}
Copy

Update user

This can only be done by the logged in user.

Auth

Path Params

username

string

name that need to be deleted

Request Body

Update an existent user in the store

object	object
id	int64
username	string
firstName	string
lastName	string
email	string
password	string
phone	string
userStatus	int32	User Status

PUT /user/{username}

xxxxxxxxxx
 
curl --request PUT \ --url 'https://petstore3.swagger.io/api/v3/user/{username}' \ --header 'api_key: {api_key}' \ --data '{  "id": 10,  "username": "theUser",  "firstName": "John",  "lastName": "James",  "email": "john@email.com",  "password": "12345",  "phone": "12345",  "userStatus": 1}'
Copy

Responses

default

successful operation

No response body

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://petstore3.swagger.io/api/v3/user/{username}' \ --header 'api_key: {api_key}'
Copy

Responses

400

Invalid username supplied

No response body

404

User not found

Response

xxxxxxxxxx
 
No response
Copy

Swagger Petstore - OpenAPI 3.0 1.0.17Terms of ServiceApache 2.0

Authentication

Pet

Update an existing pet

Add a new pet to the store

Finds Pets by status

Finds Pets by tags

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

Logs user into the system

Logs out current logged in user session

Get user by user name

Update user

Delete user

Swagger Petstore - OpenAPI 3.0 1.0.17 Terms of Service Apache 2.0