🌭 Hotdog stand

Hot Dog Stand API

1.0.0OAS 3.1

API for placing orders, specifying condiments, and managing payments at a hot dog stand. Includes functionality to retrieve the menu.

API Base URL
  • Server 1:https://hotdog.example.com/api/v1

    Main server

Orders

Operations related to managing hot dog orders

Place a new order

Creates a new hot dog order.

post
https://hotdog.example.com/api/v1/orders

Body

application/json

OrderRequest

itemsarray[object]

Example:{"item_name":"Hot Dog","quantity":1,"condiments":["mustard","ketchup"]}

Show Child Parameters

Response

application/json

Order created successfully

Order

idstring(uuid)

Unique identifier for the order

itemsarray[object]

Example:{"item_name":"Hot Dog","quantity":1,"condiments":["mustard","ketchup"]}

Show Child Parameters
statusstring

Status of the order

Allowed values:pendingconfirmedcancelledcompleted

total_amountnumber(float)

Total amount of the order

post/orders

Body

{ "items": [ { "item_name": "Hot Dog", "quantity": 2, "condiments": [ "mustard", "relish" ] } ] }
 
application/json

List orders

Returns a list of all orders with pagination.

get
https://hotdog.example.com/api/v1/orders

Query Parameters

limitinteger(int32)

Maximum number of items to return

Default:20

>= 1<= 100

offsetinteger(int32)

Number of items to skip for pagination

Default:0

>= 0

Response

application/json

Successful operation

dataarray[object]

Example:{"id":"5fa7b5a7-3a0a-4b8a-8b3a-4b8a5b5a7b5a","items":[{"item_name":"Hot Dog","quantity":2,"condiments":["mustard","relish"]}],"status":"pending","total_amount":10}

Show Child Parameters
metaobject
Show Child Parameters
get/orders
 
application/json

Retrieve order details

Retrieves details of a specific order.

get
https://hotdog.example.com/api/v1/orders/{orderId}

Path Parameters

orderIdstring(uuid)required

ID of the order to retrieve

Response

application/json

Successful operation

Order

idstring(uuid)

Unique identifier for the order

itemsarray[object]

Example:{"item_name":"Hot Dog","quantity":1,"condiments":["mustard","ketchup"]}

Show Child Parameters
statusstring

Status of the order

Allowed values:pendingconfirmedcancelledcompleted

total_amountnumber(float)

Total amount of the order

get/orders/{orderId}
 
application/json