order
Operations related to order management.
createOrder
Create a new Order
post
https://localhost:9443/am/sample/pizzashack/v1/api/order
Body
application/json
Body
application/json
Order object that needs to be added
Pizza Order
customerNamestring
deliveredboolean
addressstring
pizzaTypestring
creditCardNumberstring
quantitynumber
orderIdstringrequired
Response
application/json
Response
application/json
Created. Successful response with the newly created object as entity inthe body.Location header contains URL of newly created entity.
Pizza Order
customerNamestring
deliveredboolean
addressstring
pizzaTypestring
creditCardNumberstring
quantitynumber
orderIdstringrequired
post/order
Authentication
Body
{
"orderId": "orderId"
}
application/json
getOrderById
Get details of an Order
get
https://localhost:9443/am/sample/pizzashack/v1/api/order/{orderId}
Path Parameters
orderIdstring(string)required
Order Id
Response
application/json
Response
application/json
OK Requested Order will be returned
Pizza Order
customerNamestring
deliveredboolean
addressstring
pizzaTypestring
creditCardNumberstring
quantitynumber
orderIdstringrequired
get/order/{orderId}
Authentication
Path Parameters
application/json
updateOrder
Update an existing Order
put
https://localhost:9443/am/sample/pizzashack/v1/api/order/{orderId}
Path Parameters
orderIdstring(string)required
Order Id
Body
application/json
Body
application/json
Order object that needs to be added
Pizza Order
customerNamestring
deliveredboolean
addressstring
pizzaTypestring
creditCardNumberstring
quantitynumber
orderIdstringrequired
Response
application/json
Response
application/json
OK. Successful response with updated Order
Pizza Order
customerNamestring
deliveredboolean
addressstring
pizzaTypestring
creditCardNumberstring
quantitynumber
orderIdstringrequired
put/order/{orderId}
Authentication
Path Parameters
Body
{
"orderId": "orderId"
}
application/json
deleteOrder
Delete an existing Order
delete
https://localhost:9443/am/sample/pizzashack/v1/api/order/{orderId}
Path Parameters
orderIdstring(string)required
Order Id
Response
Response
OK. Resource successfully deleted.
delete/order/{orderId}