Swagger – Check Order Status

Check Order Status

This wiki page covers the API interaction for the Swagger Petstore API when checking the status of a purchase order.

Model

Because this is a path variable call, there is no model for the GET /store/order/{orderId} used to check the status of a purchase order using the Petstore API.

 

Parameters

Header Parameters

There are no Header Parameters for the GET /store/order/{orderId} call to the Petstore API.

Path Parameters

The Path Parameter for the GET /store/order/{orderId} call to the Petstore API is the orderId. This ID is assigned when the purchase order is made using the POST /store/order call to the API.

Query String Parameters

There are no Query String Parameters for the GET /store/order/{orderId} call to the Petstore API.

Request Body Parameters

There are no Request Body Parameters for the GET /store/order/{orderId} call to the Petstore API.

 

Sample Request

A sample Curl request is shown below, with the Path Parameter included.

curl -X GET "http://petstore.swagger.io/v2/store/order/3" -H "accept: application/xml"

This should be removed.

 

Sample Response and Schema

The following figure displays a sample response to the curl request shown in the previous section.

Curl Request Sample Response

Curl Request Sample Response

This response is broken down in the table that follows. It shows the current status for the purchase order with the orderId of 3.

It shows a successful purchase order status check for the PetId 9205439794349953000.

GET /store/order/{orderId} Response Schema
Response Item Data Type Description
complete boolean A true/false value which conveys whether the order is completed.
id integer Numerical ID for the individual purchase order.
petId integer Numerical ID for the individual pet.
quantity integer Number of pets to purchase.
shipDate string A date-time variable that displays the shipment date.
status string A status string limited to placed, approved, or delivered.

 

Other Topics