API blocks

A first block:

Add a new pet to the store.

post

Add a new pet to the store.

Authorizations

Body

application/jsonapplication/xmlapplication/x-www-form-urlencoded

idinteger · int64

Example: 10

namestringrequired

Example: doggie

categoryobject

photoUrlsstring[]required

tagsobject[]

statusstring · enum

pet status in the store

Options: available, pending, sold

Responses

application/jsonapplication/xml

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v3/pet' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": 10,
    "name": "doggie",
    "category": {
      "id": 1,
      "name": "Dogs"
    },
    "photoUrls": [
      "text"
    ],
    "tags": [
      {
        "id": 1,
        "name": "text"
      }
    ],
    "status": "available"
  }'

200

400

422

default

200

application/json

application/xml

application/json

{
  "id": 10,
  "name": "doggie",
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "photoUrls": [
    "text"
  ],
  "tags": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "status": "available"
}

Successful operation

Update an existing pet.

put

Update an existing pet by Id.

Authorizations

Body

application/jsonapplication/xmlapplication/x-www-form-urlencoded

idinteger · int64

Example: 10

namestringrequired

Example: doggie

categoryobject

photoUrlsstring[]required

tagsobject[]

statusstring · enum

pet status in the store

Options: available, pending, sold

Responses

application/jsonapplication/xml

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/v3/pet' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": 10,
    "name": "doggie",
    "category": {
      "id": 1,
      "name": "Dogs"
    },
    "photoUrls": [
      "text"
    ],
    "tags": [
      {
        "id": 1,
        "name": "text"
      }
    ],
    "status": "available"
  }'

200

400

404

422

default

200

application/json

application/xml

application/json

{
  "id": 10,
  "name": "doggie",
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "photoUrls": [
    "text"
  ],
  "tags": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "status": "available"
}

Successful operation

Finds Pets by status.

get

Multiple status values can be provided with comma separated strings.

Authorizations

Query parameters

statusstring · enum · default: "available"

Status values that need to be considered for filter

Options: available, pending, sold

Responses

application/jsonapplication/xml

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v3/pet/findByStatus'

200

400

default

200

application/json

application/xml

application/json

[
  {
    "id": 10,
    "name": "doggie",
    "category": {
      "id": 1,
      "name": "Dogs"
    },
    "photoUrls": [
      "text"
    ],
    "tags": [
      {
        "id": 1,
        "name": "text"
      }
    ],
    "status": "available"
  }
]

successful operation

Deletes a pet.

delete

Delete a pet.

Authorizations

Path parameters

petIdinteger · int64required

Pet id to delete

Header parameters

api_keystring

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/v3/pet/{petId}'

200

400

default

200

No body

Pet deleted

Webhooks :

Models:

idinteger · int64

Example: 10

namestringrequired

Example: doggie

categoryobject

photoUrlsstring[]required

tagsobject[]

statusstring · enum

pet status in the store

Options: available, pending, sold