Platform

cxp orchestration / Reference / REST API

pet

Everything about your Pets

Operations

PUT/pet POST/pet GET/pet/findByStatus GET/pet/findByTags GET/pet/{petId}POST/pet/{petId}DEL/pet/{petId}POST/pet/{petId}/uploadImage

PUT

Update an existing pet

OAuth 2.0 scopes required:

write:pets

read:pets

Request

Request bodyapplication/json application/xml

Pet object that needs to be added to the store

integer

category

Responses

Invalid ID supplied

PUT/pet

curl

Node.js

Java

Python

PHP

curl --request PUT \
  --url 'https://petstore.swagger.io/v2/pet' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 2154,
  "category": {
    "id": 2154,
    "name": "<string>"
  },
  "name": "doggie",
  "photoUrls": [
    "<string>"
  ],
  "tags": [
    {
      "id": 2154,
      "name": "<string>"
    }
  ],
  "status": "available"
}'

POST

Add a new pet to the store

OAuth 2.0 scopes required:

write:pets

read:pets

Request

Request bodyapplication/json application/xml

Pet object that needs to be added to the store

integer

category

Responses

Invalid input

POST/pet

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'https://petstore.swagger.io/v2/pet' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 2154,
  "category": {
    "id": 2154,
    "name": "<string>"
  },
  "name": "doggie",
  "photoUrls": [
    "<string>"
  ],
  "tags": [
    {
      "id": 2154,
      "name": "<string>"
    }
  ],
  "status": "available"
}'

GET

Finds Pets by status

Multiple status values can be provided with comma separated strings

OAuth 2.0 scopes required:

write:pets

read:pets

Request

Query parameters

status

array<string>

Required

Responses

successful operation

application/xml application/json

array<Pet>

GET/pet/findByStatus

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://petstore.swagger.io/v2/pet/findByStatus?status={status}' \
  --header 'Accept: application/xml'

200Response

[
  {
    "id": 2154,
    "category": {
      "id": 2154,
      "name": "<string>"
    },
    "name": "doggie",
    "photoUrls": [
      "<string>"
    ],
    "tags": [
      {
        "id": 2154,
        "name": "<string>"
      }
    ],
    "status": "available"
  }
]

GET

Finds Pets by tagsDeprecated

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

OAuth 2.0 scopes required:

write:pets

read:pets

Request

Query parameters

tags

array<string>

Required

Responses

successful operation

application/xml application/json

array<Pet>

GET/pet/findByTags

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://petstore.swagger.io/v2/pet/findByTags?tags={tags}' \
  --header 'Accept: application/xml'

200Response

[
  {
    "id": 2154,
    "category": {
      "id": 2154,
      "name": "<string>"
    },
    "name": "doggie",
    "photoUrls": [
      "<string>"
    ],
    "tags": [
      {
        "id": 2154,
        "name": "<string>"
      }
    ],
    "status": "available"
  }
]

GET

Find pet by ID

Returns a single pet

Request

Path parameters

petId

integer

Required

Responses

successful operation

application/xml application/json

Pet

GET/pet/{petId}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://petstore.swagger.io/v2/pet/{petId}' \
  --header 'Accept: application/xml'

200Response

{
  "id": 2154,
  "category": {
    "id": 2154,
    "name": "<string>"
  },
  "name": "doggie",
  "photoUrls": [
    "<string>"
  ],
  "tags": [
    {
      "id": 2154,
      "name": "<string>"
    }
  ],
  "status": "available"
}

POST

Updates a pet in the store with form data

OAuth 2.0 scopes required:

write:pets

read:pets

Request

Path parameters

petId

integer

Required

Request bodyapplication/x-www-form-urlencoded

name

string

status

string

Responses

Invalid input

POST/pet/{petId}

curl

Node.js

Java

Python

PHP

1
2

curl --request POST \
  --url 'https://petstore.swagger.io/v2/pet/{petId}'

DEL

Deletes a pet

OAuth 2.0 scopes required:

write:pets

read:pets

Request

Path parameters

petId

integer

Required

Header parameters

api_key

string

Responses

Invalid ID supplied

DEL/pet/{petId}

curl

Node.js

Java

Python

PHP

1
2

curl --request DELETE \
  --url 'https://petstore.swagger.io/v2/pet/{petId}'

POST

uploads an image

OAuth 2.0 scopes required:

write:pets

read:pets

Request

Path parameters

petId

integer

Required

Request bodymultipart/form-data

additionalMetadata

string

file

string

Responses

successful operation

application/json

ApiResponse

POST/pet/{petId}/uploadImage

curl

Node.js

Java

Python

PHP

1
2
3

curl --request POST \
  --url 'https://petstore.swagger.io/v2/pet/{petId}/uploadImage' \
  --header 'Accept: application/json'

200Response

{
  "code": 2154,
  "type": "<string>",
  "message": "<string>"
}