Swagger Petstore - OpenAPI 3.0
POST/store/order

Place a pet order

Creates a new order in the store for a pet. You can provide order details such as petId, quantity, shipDate, and status; the request body is optional. If supplied, status must be placed, approved, or delivered.

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

6 body fields

Optional order details.

idintegeroptional
The integer identifier for the order.
petIdintegeroptional
The integer identifier of the pet being ordered.
quantityintegeroptional
The number of pets in the order.
shipDatestringoptional
The scheduled 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, including its identifiers, quantity, shipping date, status, and completion value.
idintegeroptional
petIdintegeroptional
quantityintegeroptional
shipDatestringoptional
statusstringoptional
Order Status
Allowed:placedapproveddelivered
completebooleanoptional
400Returned when the input is invalid.
422Returned when the input fails validation.
defaultUnexpected error

Error handling

A 400 is returned for invalid input, and a 422 for a validation exception. If supplied, shipDate must use the date-time format, and status must be placed, approved, or delivered.