POST/store/order

Place a pet order

Creates a new order for a pet in the store. You can provide order details such as petId, quantity, shipDate, and status; status, if supplied, must be placed, approved, or delivered. A 200 response returns the order object.

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

6 body fields

Order details for a pet purchase; all fields are optional.

completebooleanoptional

Whether the order is complete.

idintegeroptional

The integer identifier of the order.

petIdintegeroptional

The integer identifier of the pet being ordered.

quantityintegeroptional

The number of pets in the order.

shipDatestringoptional

The shipping date and time in date-time format.

statusstringoptional

Order Status

Allowed:placedapproveddelivered

4 status codes
200Returns the order object, including its identifier, pet identifier, quantity, shipping date, status, and completion state.
completebooleanoptional
idintegeroptional
petIdintegeroptional
quantityintegeroptional
shipDatestringoptional
statusstringoptional

Order Status

Allowed:placedapproveddelivered
400Returned when the input is invalid.
422Returned when the request fails validation.
defaultUnexpected error

Error handling

status must be one of placed, approved, or delivered when provided, and shipDate must use a date-time format when supplied. Invalid input returns a 400; a validation failure returns a 422.