My API
POST/store/order

Place an order for a pet

Creates a new order for a pet in the store. Provide any order details you want to set, including petId, quantity, and status as applicable; status must be placed, approved, or delivered. The request body is optional, so you can omit it when no order fields need to be supplied.

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

6 body fields

Optional order details to submit to the store.

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 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, including any supplied order identifier, pet identifier, quantity, shipping date, status, and completion value.
idintegeroptional
petIdintegeroptional
quantityintegeroptional
shipDatestringoptional
statusstringoptional
Order Status
Allowed:placedapproveddelivered
completebooleanoptional
400Returned when the order input is invalid.
422Returned when the order fails validation.
defaultReturned when an unexpected error occurs.

Error handling

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