Skip to content
API Catalog/
/
/
Delete purchase order by...

Swagger Petsstore - OpenAPI 3.0 (1.0.20-SNAPSHOT)

This is a sample Pets Store Server based on the OpenAPI 3.0 specification. You can find out more about Swagger at http://swagger.io. In the third iteration of the pets store, we've switched to the design first approach! You can now help us improve the API whether it's by making changes to the definition itself or to the code. That way, with time, we can improve the API in general, and expose some of the new features in OAS3.

Some useful links:

Find out more about Swagger
Download OpenAPI description
petsstore.json
petsstore.yaml
Overview
E-mail
apiteam@swagger.io
License
Apache 2.0
Terms of Service
Languages
Servers
Mock server
https://vlad.redocly.xyz/_mock/apis/petsstore
https://vlad.redocly.xyz/v3

pets

Everything about your Pets

Operations

store

Access to Petsstore orders

Operations

Returns pets inventories by status

Request

Returns a map of status codes to quantities

Security
api_key
curl -i -X GET \
  https://vlad.redocly.xyz/_mock/apis/petsstore/store/inventory \
  -H 'api_key: YOUR_API_KEY_HERE'

Responses

successful operation

Bodyapplication/json
property name*integer(int32)additional property
Response
application/json
{
  "property1": 0,
  "property2": 0
}

Place an order for a pets

Request

Place a new order in the store

Body
idinteger(int64)
Example: 10
petIdinteger(int64)
Example: 198772
quantityinteger(int32)
Example: 7
shipDatestring(date-time)
Example: "2023-03-15T10:30:00Z"
statusstring

Order Status

Enum"placed""approved""delivered"
Example: "approved"
completeboolean
Example: true
curl -i -X POST \
  https://vlad.redocly.xyz/_mock/apis/petsstore/store/order \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 10,
    "petId": 198772,
    "quantity": 7,
    "shipDate": "2023-03-15T10:30:00Z",
    "status": "approved",
    "complete": true
  }'

Responses

successful operation

Bodyapplication/json
idinteger(int64)
Example: 10
petIdinteger(int64)
Example: 198772
quantityinteger(int32)
Example: 7
shipDatestring(date-time)
Example: "2023-03-15T10:30:00Z"
statusstring

Order Status

Enum"placed""approved""delivered"
Example: "approved"
completeboolean
Example: true
Response
application/json
{
  "id": 10,
  "petId": 198772,
  "quantity": 7,
  "shipDate": "2023-03-15T10:30:00Z",
  "status": "approved",
  "complete": true
}

Find purchase order by ID

Request

For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions.

Path
orderIdinteger(int64)required

ID of order that needs to be fetched

curl -i -X GET \
  'https://vlad.redocly.xyz/_mock/apis/petsstore/store/order/{orderId}'

Responses

successful operation

Body
idinteger(int64)
Example: 10
petIdinteger(int64)
Example: 198772
quantityinteger(int32)
Example: 7
shipDatestring(date-time)
Example: "2023-03-15T10:30:00Z"
statusstring

Order Status

Enum"placed""approved""delivered"
Example: "approved"
completeboolean
Example: true
Response
<order>
  <id>10</id>
  <petId>198772</petId>
  <quantity>7</quantity>
  <shipDate>2023-03-15T10:30:00Z</shipDate>
  <status>approved</status>
  <complete>true</complete>
</order>

Delete purchase order by ID

Request

For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors

Path
orderIdinteger(int64)required

ID of the order that needs to be deleted

curl -i -X DELETE \
  'https://vlad.redocly.xyz/_mock/apis/petsstore/store/order/{orderId}'

Responses

Invalid ID supplied

user

Operations about user

Operations