Skip to content
Barkend
Get started
API Reference
Pets

Add a new pet to the store.

POST/pets

Add a new pet to the store.

Body ParametersJSONExpand Collapse
name: string
photoUrls: array of string
id: optional number
formatint64
category: optional Category { id, name }
id: optional number
formatint64
name: optional string
status: optional "available" or "pending" or "sold"

pet status in the store

Accepts one of the following:
"available"
"pending"
"sold"
tags: optional array of Tag { id, name }
id: optional number
formatint64
name: optional string
ReturnsExpand Collapse
Pet = object { name, photoUrls, id, 3 more }
name: string
photoUrls: array of string
id: optional number
formatint64
category: optional Category { id, name }
id: optional number
formatint64
name: optional string
status: optional "available" or "pending" or "sold"

pet status in the store

Accepts one of the following:
"available"
"pending"
"sold"
tags: optional array of Tag { id, name }
id: optional number
formatint64
name: optional string

Add a new pet to the store.

curl http://localhost:4000/api/v3/pets \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $BARKEND_BEARER_TOKEN" \
    -d '{
          "name": "doggie",
          "photoUrls": [
            "string"
          ],
          "id": 10
        }'
{
  "id": 10,
  "name": "doggie",
  "photoUrls": [
    "https://example.com/dog.jpg"
  ],
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "tags": [
    {
      "id": 1,
      "name": "friendly"
    }
  ],
  "status": "available"
}
{
  "error": {
    "id": "invalid_input",
    "message": "Invalid input - name and photoUrls required"
  }
}
{
  "error": {
    "id": "duplicate_name",
    "message": "A pet with this name already exists"
  }
}
Returns Examples
{
  "id": 10,
  "name": "doggie",
  "photoUrls": [
    "https://example.com/dog.jpg"
  ],
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "tags": [
    {
      "id": 1,
      "name": "friendly"
    }
  ],
  "status": "available"
}
{
  "error": {
    "id": "invalid_input",
    "message": "Invalid input - name and photoUrls required"
  }
}
{
  "error": {
    "id": "duplicate_name",
    "message": "A pet with this name already exists"
  }
}