Swagger Petstore - OpenAPI 3.0
POST/store/order

Place a pet order

Creates a new order for a pet in the store. The request body is optional, and status, if supplied, must be placed, approved, or delivered. The response contains the order details.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

6 body fields

Optional order details; all fields can be omitted.

idintegeroptional
The order's unique identifier.
petIdintegeroptional
The identifier of the pet being ordered.
quantityintegeroptional
The number of pets in the order.
shipDatestringoptional
The order's shipping date and time in date-time format.
statusstringoptional
Order Status
Allowed:placedapproveddelivered
completebooleanoptional
Whether the order is complete.

4 status codes
200Returns the order object with its identifier, pet identifier, quantity, shipping date, status, and completion state.
idintegeroptional
petIdintegeroptional
quantityintegeroptional
shipDatestringoptional
statusstringoptional
Order Status
Allowed:placedapproveddelivered
completebooleanoptional
400Returned when the input is invalid.
422Returned when the request fails validation.
defaultUnexpected error

Error handling

A 400 is returned when the input is invalid. A 422 is returned when the request fails validation; shipDate, if supplied, must be a date-time, and status must be placed, approved, or delivered.