Add a new pet to the store.

client.pets.create(, ?): Pet { name, photoUrls, id, 3 more }

POST/pets

ParametersExpand Collapse

body: PetCreateParams { name, photoUrls, id, 3 more }

name: string

photoUrls: Array<string>

id?: number

formatint64

category?: Category { id, name }

id?: number

formatint64

name?: string

status?: "available" | "pending" | "sold"

pet status in the store

Accepts one of the following:

"available"

"pending"

"sold"

tags?: Array<Tag { id, name } >

id?: number

formatint64

name?: string

ReturnsExpand Collapse

Pet { name, photoUrls, id, 3 more }

name: string

photoUrls: Array<string>

id?: number

formatint64

category?: Category { id, name }

id?: number

formatint64

name?: string

status?: "available" | "pending" | "sold"

pet status in the store

Accepts one of the following:

"available"

"pending"

"sold"

tags?: Array<Tag { id, name } >

id?: number

formatint64

name?: string

Add a new pet to the store.

import Barkend from 'barkend';

const client = new Barkend({
  bearerToken: process.env['BARKEND_BEARER_TOKEN'], // This is the default and can be omitted
});

const pet = await client.pets.create({ name: 'doggie', photoUrls: ['string'] });

console.log(pet.id);

{
  "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"
  }
}