Skip to content

Petstore

This is a sample Pet Store Server based on the OpenAPI 3.0 specification.

Type: petstore/v1


Connections

Version: 1

OAuth2 Implicit

Properties

NameLabelTypeDescriptionRequired
clientIdClient IdSTRINGtrue
clientSecretClient SecretSTRINGtrue

API Key

Properties

NameLabelTypeDescriptionRequired
keyKeySTRINGtrue
valueValueSTRINGtrue

Actions

Add a new pet to the store

Name: addPet

Add a new pet to the store

Properties

NameLabelTypeDescriptionRequired
idIdINTEGERfalse
nameNameSTRINGtrue
categoryCategoryOBJECT
Properties {INTEGER(id), STRING(name)}
false
photoUrlsPhoto UrlsARRAY
Items [STRING]
true
tagsTagsARRAY
Items [{INTEGER(id), STRING(name)}]
false
statusStatusSTRING
Options available, pending, sold
pet status in the storefalse

Example JSON Structure

{
"label" : "Add a new pet to the store",
"name" : "addPet",
"parameters" : {
"id" : 1,
"name" : "",
"category" : {
"id" : 1,
"name" : ""
},
"photoUrls" : [ "" ],
"tags" : [ {
"id" : 1,
"name" : ""
} ],
"status" : ""
},
"type" : "petstore/v1/addPet"
}

Output

Type: OBJECT

Properties

NameTypeDescription
idINTEGER
nameSTRING
categoryOBJECT
Properties {INTEGER(id), STRING(name)}
photoUrlsARRAY
Items [STRING]
tagsARRAY
Items [{INTEGER(id), STRING(name)}]
statusSTRING
Options available, pending, sold
pet status in the store

Output Example

{
"id" : 1,
"name" : "",
"category" : {
"id" : 1,
"name" : ""
},
"photoUrls" : [ "" ],
"tags" : [ {
"id" : 1,
"name" : ""
} ],
"status" : ""
}

Update an existing pet

Name: updatePet

Update an existing pet by Id

Properties

NameLabelTypeDescriptionRequired
idIdINTEGERfalse
nameNameSTRINGtrue
categoryCategoryOBJECT
Properties {INTEGER(id), STRING(name)}
false
photoUrlsPhoto UrlsARRAY
Items [STRING]
true
tagsTagsARRAY
Items [{INTEGER(id), STRING(name)}]
false
statusStatusSTRING
Options available, pending, sold
pet status in the storefalse

Example JSON Structure

{
"label" : "Update an existing pet",
"name" : "updatePet",
"parameters" : {
"id" : 1,
"name" : "",
"category" : {
"id" : 1,
"name" : ""
},
"photoUrls" : [ "" ],
"tags" : [ {
"id" : 1,
"name" : ""
} ],
"status" : ""
},
"type" : "petstore/v1/updatePet"
}

Output

Type: OBJECT

Properties

NameTypeDescription
idINTEGER
nameSTRING
categoryOBJECT
Properties {INTEGER(id), STRING(name)}
photoUrlsARRAY
Items [STRING]
tagsARRAY
Items [{INTEGER(id), STRING(name)}]
statusSTRING
Options available, pending, sold
pet status in the store

Output Example

{
"id" : 1,
"name" : "",
"category" : {
"id" : 1,
"name" : ""
},
"photoUrls" : [ "" ],
"tags" : [ {
"id" : 1,
"name" : ""
} ],
"status" : ""
}

Finds Pets by status

Name: findPetsByStatus

Multiple status values can be provided with comma separated strings

Properties

NameLabelTypeDescriptionRequired
statusStatusSTRING
Options available, pending, sold
Status values that need to be considered for filterfalse

Example JSON Structure

{
"label" : "Finds Pets by status",
"name" : "findPetsByStatus",
"parameters" : {
"status" : ""
},
"type" : "petstore/v1/findPetsByStatus"
}

Output

Type: ARRAY

Items Type: OBJECT

Properties

NameTypeDescription
idINTEGER
nameSTRING
categoryOBJECT
Properties {INTEGER(id), STRING(name)}
photoUrlsARRAY
Items [STRING]
tagsARRAY
Items [{INTEGER(id), STRING(name)}]
statusSTRING
Options available, pending, sold
pet status in the store

Output Example

[ {
"id" : 1,
"name" : "",
"category" : {
"id" : 1,
"name" : ""
},
"photoUrls" : [ "" ],
"tags" : [ {
"id" : 1,
"name" : ""
} ],
"status" : ""
} ]

Finds Pets by tags

Name: findPetsByTags

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

Properties

NameLabelTypeDescriptionRequired
tagsTagsARRAY
Items [STRING]
Tags to filter byfalse

Example JSON Structure

{
"label" : "Finds Pets by tags",
"name" : "findPetsByTags",
"parameters" : {
"tags" : [ "" ]
},
"type" : "petstore/v1/findPetsByTags"
}

Output

Type: ARRAY

Items Type: OBJECT

Properties

NameTypeDescription
idINTEGER
nameSTRING
categoryOBJECT
Properties {INTEGER(id), STRING(name)}
photoUrlsARRAY
Items [STRING]
tagsARRAY
Items [{INTEGER(id), STRING(name)}]
statusSTRING
Options available, pending, sold
pet status in the store

Output Example

[ {
"id" : 1,
"name" : "",
"category" : {
"id" : 1,
"name" : ""
},
"photoUrls" : [ "" ],
"tags" : [ {
"id" : 1,
"name" : ""
} ],
"status" : ""
} ]

Deletes a pet

Name: deletePet

delete a pet

Properties

NameLabelTypeDescriptionRequired
api_keyApi KeySTRINGfalse
petIdPet IdINTEGERPet id to deletetrue

Example JSON Structure

{
"label" : "Deletes a pet",
"name" : "deletePet",
"parameters" : {
"api_key" : "",
"petId" : 1
},
"type" : "petstore/v1/deletePet"
}

Output

This action does not produce any output.

Find pet by ID

Name: getPetById

Returns a single pet

Properties

NameLabelTypeDescriptionRequired
petIdPet IdINTEGERID of pet to returntrue

Example JSON Structure

{
"label" : "Find pet by ID",
"name" : "getPetById",
"parameters" : {
"petId" : 1
},
"type" : "petstore/v1/getPetById"
}

Output

Type: OBJECT

Properties

NameTypeDescription
idINTEGER
nameSTRING
categoryOBJECT
Properties {INTEGER(id), STRING(name)}
photoUrlsARRAY
Items [STRING]
tagsARRAY
Items [{INTEGER(id), STRING(name)}]
statusSTRING
Options available, pending, sold
pet status in the store

Output Example

{
"id" : 1,
"name" : "",
"category" : {
"id" : 1,
"name" : ""
},
"photoUrls" : [ "" ],
"tags" : [ {
"id" : 1,
"name" : ""
} ],
"status" : ""
}

Updates a pet in the store with form data

Name: updatePetWithForm

Properties

NameLabelTypeDescriptionRequired
petIdPet IdINTEGERID of pet that needs to be updatedtrue
nameNameSTRINGName of pet that needs to be updatedfalse
statusStatusSTRINGStatus of pet that needs to be updatedfalse

Example JSON Structure

{
"label" : "Updates a pet in the store with form data",
"name" : "updatePetWithForm",
"parameters" : {
"petId" : 1,
"name" : "",
"status" : ""
},
"type" : "petstore/v1/updatePetWithForm"
}

Output

This action does not produce any output.

uploads an image

Name: uploadFile

Properties

NameLabelTypeDescriptionRequired
petIdPet IdINTEGERID of pet to updatetrue
additionalMetadataAdditional MetadataSTRINGAdditional Metadatafalse
fileEntryFILE_ENTRYnull

Example JSON Structure

{
"label" : "uploads an image",
"name" : "uploadFile",
"parameters" : {
"petId" : 1,
"additionalMetadata" : "",
"fileEntry" : {
"extension" : "",
"mimeType" : "",
"name" : "",
"url" : ""
}
},
"type" : "petstore/v1/uploadFile"
}

Output

Type: OBJECT

Properties

NameTypeDescription
codeINTEGER
typeSTRING
messageSTRING

Output Example

{
"code" : 1,
"type" : "",
"message" : ""
}

Returns pet inventories by status

Name: getInventory

Returns a map of status codes to quantities

Example JSON Structure

{
"label" : "Returns pet inventories by status",
"name" : "getInventory",
"type" : "petstore/v1/getInventory"
}

Output

Type: OBJECT

Place an order for a pet

Name: placeOrder

Place a new order in the store

Properties

NameLabelTypeDescriptionRequired
idIdINTEGERfalse
petIdPet IdINTEGERfalse
quantityQuantityINTEGERfalse
shipDateShip DateDATE_TIMEfalse
statusStatusSTRING
Options placed, approved, delivered
Order Statusfalse
completeCompleteBOOLEAN
Options true, false
false

Example JSON Structure

{
"label" : "Place an order for a pet",
"name" : "placeOrder",
"parameters" : {
"id" : 1,
"petId" : 1,
"quantity" : 1,
"shipDate" : "2021-01-01T00:00:00",
"status" : "",
"complete" : false
},
"type" : "petstore/v1/placeOrder"
}

Output

Type: OBJECT

Properties

NameTypeDescription
idINTEGER
petIdINTEGER
quantityINTEGER
shipDateDATE_TIME
statusSTRING
Options placed, approved, delivered
Order Status
completeBOOLEAN
Options true, false

Output Example

{
"id" : 1,
"petId" : 1,
"quantity" : 1,
"shipDate" : "2021-01-01T00:00:00",
"status" : "",
"complete" : false
}

Delete purchase order by ID

Name: deleteOrder

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

Properties

NameLabelTypeDescriptionRequired
orderIdOrder IdINTEGERID of the order that needs to be deletedtrue

Example JSON Structure

{
"label" : "Delete purchase order by ID",
"name" : "deleteOrder",
"parameters" : {
"orderId" : 1
},
"type" : "petstore/v1/deleteOrder"
}

Output

This action does not produce any output.

Find purchase order by ID

Name: getOrderById

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

Properties

NameLabelTypeDescriptionRequired
orderIdOrder IdINTEGERID of order that needs to be fetchedtrue

Example JSON Structure

{
"label" : "Find purchase order by ID",
"name" : "getOrderById",
"parameters" : {
"orderId" : 1
},
"type" : "petstore/v1/getOrderById"
}

Output

Type: OBJECT

Properties

NameTypeDescription
idINTEGER
petIdINTEGER
quantityINTEGER
shipDateDATE_TIME
statusSTRING
Options placed, approved, delivered
Order Status
completeBOOLEAN
Options true, false

Output Example

{
"id" : 1,
"petId" : 1,
"quantity" : 1,
"shipDate" : "2021-01-01T00:00:00",
"status" : "",
"complete" : false
}

Create user

Name: createUser

This can only be done by the logged in user.

Properties

NameLabelTypeDescriptionRequired
idIdINTEGERfalse
usernameUsernameSTRINGfalse
firstNameFirst NameSTRINGfalse
lastNameLast NameSTRINGfalse
emailEmailSTRINGfalse
passwordPasswordSTRINGfalse
phonePhoneSTRINGfalse
userStatusUser StatusINTEGERUser Statusfalse

Example JSON Structure

{
"label" : "Create user",
"name" : "createUser",
"parameters" : {
"id" : 1,
"username" : "",
"firstName" : "",
"lastName" : "",
"email" : "",
"password" : "",
"phone" : "",
"userStatus" : 1
},
"type" : "petstore/v1/createUser"
}

Output

Type: OBJECT

Properties

NameTypeDescription
idINTEGER
usernameSTRING
firstNameSTRING
lastNameSTRING
emailSTRING
passwordSTRING
phoneSTRING
userStatusINTEGERUser Status

Output Example

{
"id" : 1,
"username" : "",
"firstName" : "",
"lastName" : "",
"email" : "",
"password" : "",
"phone" : "",
"userStatus" : 1
}

Creates list of users with given input array

Name: createUsersWithListInput

Creates list of users with given input array

Properties

NameLabelTypeDescriptionRequired
__itemsItemsARRAY
Items [{INTEGER(id), STRING(username), STRING(firstName), STRING(lastName), STRING(email), STRING(password), STRING(phone), INTEGER(userStatus)}]
null

Example JSON Structure

{
"label" : "Creates list of users with given input array",
"name" : "createUsersWithListInput",
"parameters" : {
"__items" : [ {
"id" : 1,
"username" : "",
"firstName" : "",
"lastName" : "",
"email" : "",
"password" : "",
"phone" : "",
"userStatus" : 1
} ]
},
"type" : "petstore/v1/createUsersWithListInput"
}

Output

Type: ARRAY

Items Type: OBJECT

Properties

NameTypeDescription
idINTEGER
usernameSTRING
firstNameSTRING
lastNameSTRING
emailSTRING
passwordSTRING
phoneSTRING
userStatusINTEGERUser Status

Output Example

[ {
"id" : 1,
"username" : "",
"firstName" : "",
"lastName" : "",
"email" : "",
"password" : "",
"phone" : "",
"userStatus" : 1
} ]

Delete user

Name: deleteUser

This can only be done by the logged in user.

Properties

NameLabelTypeDescriptionRequired
usernameUsernameSTRINGThe name that needs to be deletedtrue

Example JSON Structure

{
"label" : "Delete user",
"name" : "deleteUser",
"parameters" : {
"username" : ""
},
"type" : "petstore/v1/deleteUser"
}

Output

This action does not produce any output.

Get user by user name

Name: getUserByName

Properties

NameLabelTypeDescriptionRequired
usernameUsernameSTRINGThe name that needs to be fetched. Use user1 for testing.true

Example JSON Structure

{
"label" : "Get user by user name",
"name" : "getUserByName",
"parameters" : {
"username" : ""
},
"type" : "petstore/v1/getUserByName"
}

Output

Type: OBJECT

Properties

NameTypeDescription
idINTEGER
usernameSTRING
firstNameSTRING
lastNameSTRING
emailSTRING
passwordSTRING
phoneSTRING
userStatusINTEGERUser Status

Output Example

{
"id" : 1,
"username" : "",
"firstName" : "",
"lastName" : "",
"email" : "",
"password" : "",
"phone" : "",
"userStatus" : 1
}

Update user

Name: updateUser

This can only be done by the logged in user.

Properties

NameLabelTypeDescriptionRequired
usernameUsernameSTRINGname that need to be deletedtrue
idIdINTEGERfalse
usernameUsernameSTRINGfalse
firstNameFirst NameSTRINGfalse
lastNameLast NameSTRINGfalse
emailEmailSTRINGfalse
passwordPasswordSTRINGfalse
phonePhoneSTRINGfalse
userStatusUser StatusINTEGERUser Statusfalse

Example JSON Structure

{
"label" : "Update user",
"name" : "updateUser",
"parameters" : {
"username" : "",
"id" : 1,
"firstName" : "",
"lastName" : "",
"email" : "",
"password" : "",
"phone" : "",
"userStatus" : 1
},
"type" : "petstore/v1/updateUser"
}

Output

Type: OBJECT

Properties

NameTypeDescription
idINTEGER
usernameSTRING
firstNameSTRING
lastNameSTRING
emailSTRING
passwordSTRING
phoneSTRING
userStatusINTEGERUser Status

Output Example

{
"id" : 1,
"username" : "",
"firstName" : "",
"lastName" : "",
"email" : "",
"password" : "",
"phone" : "",
"userStatus" : 1
}