API docs by Redocly

Munchies Order Service API (1.0)

Download OpenAPI specification:

Advance order status

Advances an order to the next status.

Request Body schema: application/json
required

Request containing the order identifier.

orderId
required
string

Responses

Request samples

Content type
application/json
{
  • "orderId": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "result": "string"
}

Update delivery order info

Updates delivery information for a delivery order.

Request Body schema: application/json
required

Request containing delivery order update details.

bellName
required
string
customerId
required
string
customerPhone
required
string
deliveryAddress
required
string
estimatedDeliveryTime
required
string
orderId
required
string

Responses

Request samples

Content type
application/json
{
  • "bellName": "string",
  • "customerId": "string",
  • "customerPhone": "string",
  • "deliveryAddress": "string",
  • "estimatedDeliveryTime": "string",
  • "orderId": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "result": "string"
}

Update order items

Updates the items in an order.

Request Body schema: application/json
required

Request containing order identifier and new items.

customerId
required
string
required
Array of objects (OrderItemDto)
orderId
required
string

Responses

Request samples

Content type
application/json
{
  • "customerId": "string",
  • "items": [
    ],
  • "orderId": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "result": "string"
}

Place a new order

Places a new order with the provided order type and details.

Request Body schema: application/json
required

Place order payload containing order type and details.

bellName
string or null
customerId
required
string
customerName
string or null
customerPhone
string or null
deliveryAddress
string or null
estimatedDeliveryTime
string or null
required
Array of objects (OrderItemDto)
numberOfGuests
integer or null <int32>
orderType
required
string (OrderType)
Enum: "DELIVERY" "TAKEAWAY" "DINE_IN"
pickupTime
string or null
restaurantId
required
string
tableNumber
integer or null <int32>

Responses

Request samples

Content type
application/json
{
  • "bellName": "string",
  • "customerId": "string",
  • "customerName": "string",
  • "customerPhone": "string",
  • "deliveryAddress": "string",
  • "estimatedDeliveryTime": "string",
  • "items": [
    ],
  • "numberOfGuests": 0,
  • "orderType": "DELIVERY",
  • "pickupTime": "string",
  • "restaurantId": "string",
  • "tableNumber": 0
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "result": {
    }
}

Update takeaway order info

Updates pickup information for a takeaway order.

Request Body schema: application/json
required

Request containing takeaway order update details.

customerId
required
string
customerName
required
string
orderId
required
string
pickupTime
required
string

Responses

Request samples

Content type
application/json
{
  • "customerId": "string",
  • "customerName": "string",
  • "orderId": "string",
  • "pickupTime": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "result": "string"
}

Get order by id

Retrieves an order by its unique identifier.

path Parameters
id
required
string

The order identifier received from the path.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "result": {
    }
}

Discard/Cancel an order

Cancels an order if it is still in a cancellable state.

path Parameters
id
required
string

Request containing order identifiers.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "result": "string"
}