---
title: "Hot Dog Stand API"
url: "https://kongair.terwilligar.com/apis/hot-diggity-dog/versions/7450374c-0e43-4067-b83d-ec33667f4a58"
---

# Hot Dog Stand API

OpenAPI specification document.

```json
{"openapi":"3.1.0","info":{"title":"Hot Dog Stand API","description":"API for placing orders, specifying condiments, and managing payments at a hot dog stand. Includes functionality to retrieve the menu.","version":"1.0.0"},"servers":[{"url":"https://hotdog.example.com/api/v1","description":"Main server"}],"tags":[{"name":"Orders","description":"Operations related to managing hot dog orders"},{"name":"Condiments","description":"Operations related to available condiments"},{"name":"Menu","description":"Operations related to retrieving menu items"}],"paths":{"/orders":{"post":{"summary":"Place a new order","description":"Creates a new hot dog order.","operationId":"placeOrder","tags":["Orders"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderRequest"}}}},"responses":{"201":{"description":"Order created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"get":{"summary":"List orders","description":"Returns a list of all orders with pagination.","operationId":"listOrders","tags":["Orders"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of items to return","schema":{"type":"integer","format":"int32","minimum":1,"maximum":100,"default":20}},{"name":"offset","in":"query","description":"Number of items to skip for pagination","schema":{"type":"integer","format":"int32","minimum":0,"default":0}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Order"}},"meta":{"type":"object","properties":{"page":{"type":"object","properties":{"offset":{"type":"integer","description":"The offset used for pagination."},"limit":{"type":"integer","description":"The limit used for pagination."},"total":{"type":"integer","description":"The total number of items available."},"estimated_total":{"type":"boolean","description":"Indicates if the total is estimated."}}}}}}}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/orders/{orderId}":{"get":{"summary":"Retrieve order details","description":"Retrieves details of a specific order.","operationId":"getOrder","tags":["Orders"],"parameters":[{"name":"orderId","in":"path","required":true,"description":"ID of the order to retrieve","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"404":{"description":"Order not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"put":{"summary":"Update an order","description":"Updates an existing order.","operationId":"updateOrder","tags":["Orders"],"parameters":[{"name":"orderId","in":"path","required":true,"description":"ID of the order to update","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderRequest"}}}},"responses":{"200":{"description":"Order updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Order not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"summary":"Cancel an order","description":"Cancels an order.","operationId":"cancelOrder","tags":["Orders"],"parameters":[{"name":"orderId","in":"path","required":true,"description":"ID of the order to cancel","schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Order cancelled successfully"},"404":{"description":"Order not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/orders/{orderId}/payment":{"post":{"summary":"Process payment for an order","description":"Processes payment for a specific order.","operationId":"processPayment","tags":["Orders"],"parameters":[{"name":"orderId","in":"path","required":true,"description":"ID of the order to process payment for","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentInfo"}}}},"responses":{"200":{"description":"Payment processed successfully","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"Status of the payment"}}}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Order not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/condiments":{"get":{"summary":"List available condiments","description":"Returns a list of available condiments.","operationId":"listCondiments","tags":["Condiments"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of items to return","schema":{"type":"integer","format":"int32","minimum":1,"maximum":100,"default":20}},{"name":"offset","in":"query","description":"Number of items to skip for pagination","schema":{"type":"integer","format":"int32","minimum":0,"default":0}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Condiment"}},"meta":{"type":"object","properties":{"page":{"type":"object","properties":{"offset":{"type":"integer","description":"The offset used for pagination."},"limit":{"type":"integer","description":"The limit used for pagination."},"total":{"type":"integer","description":"The total number of items available."},"estimated_total":{"type":"boolean","description":"Indicates if the total is estimated."}}}}}}}}}}}}},"/menu":{"get":{"summary":"List available menu items","description":"Returns a list of available menu items.","operationId":"listMenuItems","tags":["Menu"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of items to return","schema":{"type":"integer","format":"int32","minimum":1,"maximum":100,"default":20}},{"name":"offset","in":"query","description":"Number of items to skip for pagination","schema":{"type":"integer","format":"int32","minimum":0,"default":0}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MenuItem"}},"meta":{"type":"object","properties":{"page":{"type":"object","properties":{"offset":{"type":"integer","description":"The offset used for pagination."},"limit":{"type":"integer","description":"The limit used for pagination."},"total":{"type":"integer","description":"The total number of items available."},"estimated_total":{"type":"boolean","description":"Indicates if the total is estimated."}}}}}}}}}}}}}},"components":{"schemas":{"Order":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the order"},"items":{"type":"array","items":{"$ref":"#/components/schemas/OrderItem"}},"status":{"type":"string","enum":["pending","confirmed","cancelled","completed"],"description":"Status of the order"},"total_amount":{"type":"number","format":"float","description":"Total amount of the order"}},"example":{"id":"5fa7b5a7-3a0a-4b8a-8b3a-4b8a5b5a7b5a","items":[{"item_name":"Hot Dog","quantity":2,"condiments":["mustard","relish"]}],"status":"pending","total_amount":10}},"OrderItem":{"type":"object","properties":{"item_name":{"type":"string","description":"Name of the item"},"quantity":{"type":"integer","description":"Quantity of the item"},"condiments":{"type":"array","items":{"type":"string"},"description":"List of condiments for the item"}},"example":{"item_name":"Hot Dog","quantity":1,"condiments":["mustard","ketchup"]}},"Condiment":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the condiment"},"name":{"type":"string","description":"Name of the condiment"},"description":{"type":"string","description":"Description of the condiment"},"price":{"type":"number","format":"float","description":"Price of the condiment"}},"example":{"id":"3e5f7b9a-1c3e-4b0a-8b3a-4b8a5b5a7b5a","name":"Mustard","description":"Yellow mustard","price":0.5}},"PaymentInfo":{"type":"object","properties":{"payment_method":{"type":"string","enum":["credit_card","paypal","cash"],"description":"Payment method used"},"amount":{"type":"number","format":"float","description":"Amount to be paid"}},"example":{"payment_method":"credit_card","amount":10}},"Error":{"type":"object","properties":{"code":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"}},"example":{"code":400,"message":"Invalid request"}},"OrderRequest":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/OrderItem"}}},"example":{"items":[{"item_name":"Hot Dog","quantity":2,"condiments":["mustard","relish"]}]}},"MenuItem":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the menu item"},"name":{"type":"string","description":"Name of the menu item"},"description":{"type":"string","description":"Description of the menu item"},"price":{"type":"number","format":"float","description":"Price of the menu item"}},"example":{"id":"a1b2c3d4-e5f6-7890-1234-567890abcdef","name":"Hot Dog","description":"Classic hot dog on a bun","price":5}}}}}
```