Skip to main content
POST
/
orders
TypeScript SDK
import { PetStoreAPI } from '@petstoreapi/sdk';

const client = new PetStoreAPI({
  accessToken: process.env.OAUTH_ACCESS_TOKEN
});

const order = await client.orders.create({
  petId: 90180021,
  quantity: 1,
  shipDate: '2025-08-15',
  status: 'placed'
});

console.log(`Order ${order.id} created successfully`);
{
  "id": 44524671,
  "petId": 90180021,
  "quantity": 23,
  "shipDate": "2025-08-15",
  "status": "placed",
  "complete": false
}

Headers

​
X-Tenant-ID
string<uuid>

Optional tenant identifier for data isolation. When provided, all operations will be scoped to this tenant, ensuring data separation between different organizations or users. If omitted, operations will access the shared/public data pool where data may be visible to and modified by other users.

Body

application/json

Pet store order details

​
petId
string<uuid>
required

ID of the pet being ordered

Examples:

"019b4132-70aa-764f-b315-e2803d882a24"

"019b4127-54d5-76d9-b626-0d4c7bfce5b6"

​
userId
string<uuid>
required

ID of the user placing the order

Examples:

"019b4138-e0af-70b9-8f0c-6ea97d495dfa"

"019b4128-6a6b-777c-9ae8-335e962c68d8"

​
status
enum<string>
required

Order status

Available options:
PLACED,
APPROVED,
SHIPPED,
DELIVERED,
CANCELLED
Examples:

"PLACED"

"APPROVED"

​
totalAmount
string
required

Total order amount

Examples:

"125.50"

"75.00"

"200.99"

​
currency
string
default:USD
required

Currency code for the order amount (ISO 4217)

Examples:

"USD"

"EUR"

"GBP"

Response

Operation successful

Pet store order details

​
id
string<uuid>
required

Unique order identifier (UUID v7)

Examples:

"019b4139-1234-7abc-8def-123456789abc"

"019b4127-5678-7def-9012-234567890def"

​
petId
string<uuid>
required

ID of the pet being ordered

Examples:

"019b4132-70aa-764f-b315-e2803d882a24"

"019b4127-54d5-76d9-b626-0d4c7bfce5b6"

​
userId
string<uuid>
required

ID of the user placing the order

Examples:

"019b4138-e0af-70b9-8f0c-6ea97d495dfa"

"019b4128-6a6b-777c-9ae8-335e962c68d8"

​
status
enum<string>
required

Order status

Available options:
PLACED,
APPROVED,
SHIPPED,
DELIVERED,
CANCELLED
Examples:

"PLACED"

"APPROVED"

​
totalAmount
string
required

Total order amount

Examples:

"125.50"

"75.00"

"200.99"

​
currency
string
default:USD
required

Currency code for the order amount (ISO 4217)

Examples:

"USD"

"EUR"

"GBP"

​
createdAt
string<date-time>
required

Order creation timestamp (RFC 3339)

Examples:

"2025-12-21T13:56:23Z"

"2025-11-15T08:30:00Z"

​
updatedAt
string<date-time>
required

Order last update timestamp (RFC 3339)

Examples:

"2025-12-21T13:56:23Z"

"2025-12-21T15:30:45Z"

​
tenantId
string<uuid> | null

Optional tenant identifier for data isolation. When present, indicates this order belongs to a specific tenant. Null or omitted means the order is in the shared/public data pool.

Examples:

"550e8400-e29b-41d4-a716-446655440000"

"7c9e6679-7425-40de-944b-e07fc1f90ae7"