orderIdstring(uuid)required
ID of the order to process payment for
Process payment for an order
Processes payment for a specific order.
post
https://hotdog.example.com/api/v1/orders/{orderId}/payment
Path Parameters
Body
application/json
Body
application/json
PaymentInfo
payment_methodstring
Payment method used
Allowed values:credit_cardpaypalcash
amountnumber(float)
Amount to be paid
Response
application/json
Response
application/json
Payment processed successfully
statusstring
Status of the payment
post/orders/{orderId}/payment
Path Parameters
Body
{
"payment_method": "credit_card",
"amount": 10
}
application/json
Condiments
Operations related to available condiments
List available condiments
Returns a list of available condiments.
get
https://hotdog.example.com/api/v1/condiments
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
200 application/json
Response
200 application/json
Successful operation
dataarray[object]
Example:{"id":"3e5f7b9a-1c3e-4b0a-8b3a-4b8a5b5a7b5a","name":"Mustard","description":"Yellow mustard","price":0.5}
Show Child Parameters
metaobject
Show Child Parameters
get/condiments
Query Parameters
200 application/json
List available menu items
Returns a list of available menu items.
get
https://hotdog.example.com/api/v1/menu
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
200 application/json
Response
200 application/json
Successful operation
dataarray[object]
Example:{"id":"a1b2c3d4-e5f6-7890-1234-567890abcdef","name":"Hot Dog","description":"Classic hot dog on a bun","price":5}
Show Child Parameters
metaobject
Show Child Parameters
get/menu
Query Parameters
200 application/json