Skip to content
store
/
Subscribe to the Store events

Swagger Petstore (1.0.0)

My lovely API

This is a sample server Petstore server. You can find out more about Swagger at http://swagger.io or on irc.freenode.net, #swagger. For this sample, you can use the api key special-key to test the authorization filters.

Find out how to create Github repo for your OpenAPI spec.

Introduction

This API is documented in OpenAPI format and is based on Petstore sample provided by swagger.io team. It was extended to illustrate features of generator-openapi-repo tool and ReDoc documentation. In addition to standard OpenAPI syntax we use a few vendor extensions.

OpenAPI Specification

This API is documented in OpenAPI format and is based on Petstore sample provided by swagger.io team. It was extended to illustrate features of generator-openapi-repo tool and ReDoc documentation. In addition to standard OpenAPI syntax we use a few vendor extensions.

Cross-Origin Resource Sharing

This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with W3C spec. And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.

Authentication

Petstore offers two forms of authentication:

  • API Key
  • OAuth2 OAuth2 - an open protocol to allow secure authorization in a simple and standard method from web, mobile and desktop applications.
Download OpenAPI description
petstore.json
petstore.yaml
Overview
URL

https://github.com/Redocly/redoc

API Support

apiteam@swagger.io

License

Apache 2.0

Terms of Service

Languages
Servers
Mock server

https://innovario.apishowdown.com/_mock/petstore/

Default server

https://petstore.swagger.io/v2/

Sandbox server

https://petstore.swagger.io/sandbox/

pet

Everything about your Pets

Operations

store

Access to Petstore orders

Operations

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
orderIdstring>= 1required

ID of the order that needs to be deleted

curl -i -X DELETE \
  'https://innovario.apishowdown.com/_mock/petstore/store/order/{orderId}'

Responses

Invalid ID supplied

Subscribe to the Store events

Request

Add subscription for a store events

Bodyapplication/json
callbackUrlstring(uri)required

This URL will be called by the server when the desired event will occur

Example: "https://myserver.com/send/callback/here"
eventNamestringrequired

Event name for the subscription

Enum"orderInProgress""orderShipped""orderDelivered"
Example: "orderInProgress"
curl -i -X POST \
  https://innovario.apishowdown.com/_mock/petstore/store/subscribe \
  -H 'Content-Type: application/json' \
  -d '{
    "callbackUrl": "https://myserver.com/send/callback/here",
    "eventName": "orderInProgress"
  }'

Responses

Successful operation

Bodyapplication/jsonArray [Array [
number
]]
Response
application/json
[
  [
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0,
    0
  ]
]

Callbacks

Order in Progress (Summary)
post
Order in Progress (Only Description)
put
Very long description Lorem ipsum dolor sit amet,
post
Order delivered
post
Deprecated

webhooks

Everything about your Webhooks

Webhooks

user

Operations about user

Operations