Swagger Petstore - OpenAPI 3.0
POST/store/order

Place a pet order

Creates a new order in the store for a pet. Provide order details such as petId, quantity, and shipDate; status, if supplied, 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; send the request as JSON, XML, or URL-encoded form data.

idintegeroptional
The order's identifier.
petIdintegeroptional
The identifier of the pet being ordered.
quantityintegeroptional
The number of pets in the order.
shipDatestringoptional
The 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, including its identifier, pet ID, 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 request fails validation.
defaultReturned when an unexpected error occurs.

Error handling

A 400 is returned for invalid input, and a 422 when validation fails. When supplied, status must be one of placed, approved, or delivered, and shipDate must use ISO 8601 date-time format.