Swagger Petstore - OpenAPI 3.0
POST/store/order

Place a pet order

Creates a new order in the store for a pet. Supply order details such as petId, quantity, and shipDate; the body is optional, and status, when provided, must be placed, approved, or delivered. The response contains the order record.

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

6 body fields

Optional order details. The body can be sent as JSON, XML, or URL-encoded form data; all fields are optional.

idintegeroptional
The order's integer identifier.
petIdintegeroptional
The integer 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 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 payload fails validation.
defaultUnexpected error

Error handling

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