Swagger Petstore - OpenAPI 3.0
POST/store/order

Place a pet order

Creates a new order for a pet in the store. Supply order details such as petId, quantity, shipDate, status, and complete when those values are needed. The response contains the created order and its current state.

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

6 body fields

Optional order details for the pet purchase.

idintegeroptional
The unique integer identifier of the order.
petIdintegeroptional
The unique integer identifier of the pet being ordered.
quantityintegeroptional
The integer number of pets included in the order.
shipDatestringoptional
The scheduled shipping date and time in ISO 8601 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 order input is invalid.
422Returned when the order data fails validation.
defaultUnexpected error

Error handling

shipDate must use ISO 8601 date-time format, and status must be one of: placed, approved, or delivered. Invalid order input returns a 400, while data that fails validation returns a 422.