Search
K
🌭 Hotdog stand

Update an order

Updates an existing order.

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

Path Parameters

orderIdstring(uuid)required

ID of the order to update

Body

application/json

OrderRequest

itemsarray[object]

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

Show Child Parameters

Response

application/json

Order updated 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

put/orders/{orderId}

Body

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

Cancel an order

Cancels an order.

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

Path Parameters

orderIdstring(uuid)required

ID of the order to cancel

Response

Order cancelled successfully

delete/orders/{orderId}
 

Process payment for an order

Processes payment for a specific order.

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

Path Parameters

orderIdstring(uuid)required

ID of the order to process payment for

Body

application/json

PaymentInfo

payment_methodstring

Payment method used

Allowed values:credit_cardpaypalcash

amountnumber(float)

Amount to be paid

Response

application/json

Payment processed successfully

statusstring

Status of the payment

post/orders/{orderId}/payment

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

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
 
200 application/json