Orders
Set an order to handed to customer
API Documentation
Ranking Key
Staff History
Workspace
Sessions
Orders
Orders
Set an order to handed to customer
PUT
/
orders
/
{orderId}
/
setHandedToCustomer
curl --request PUT \
--url https://api.readmin.app/orders/{orderId}/setHandedToCustomer \
--header 'Content-Type: application/json' \
--header 'loader-id: <api-key>' \
--data '{
"actorId": "<string>"
}'
{
"success": true,
"order": {
"_id": "<string>",
"groupId": "<string>",
"customerId": "<string>",
"cashierId": "<string>",
"status": "submitted",
"items": [
{
"item": "<string>",
"quantity": 123
}
],
"log": [
{
"event": "<string>",
"userId": "<string>",
"date": "2023-11-07T05:31:56Z"
}
],
"involvedUsers": [
"<string>"
],
"placeId": "<string>",
"gameId": "<string>",
"created": "2023-11-07T05:31:56Z",
"lastModified": "2023-11-07T05:31:56Z"
}
}
Authorizations
Path Parameters
Body
application/json
Response
200
application/json
Order updated successfully
Available options:
submitted
, claimed
, released
, completed
, cancelled
, awaiting_customer
, handed_to_customer
curl --request PUT \
--url https://api.readmin.app/orders/{orderId}/setHandedToCustomer \
--header 'Content-Type: application/json' \
--header 'loader-id: <api-key>' \
--data '{
"actorId": "<string>"
}'
{
"success": true,
"order": {
"_id": "<string>",
"groupId": "<string>",
"customerId": "<string>",
"cashierId": "<string>",
"status": "submitted",
"items": [
{
"item": "<string>",
"quantity": 123
}
],
"log": [
{
"event": "<string>",
"userId": "<string>",
"date": "2023-11-07T05:31:56Z"
}
],
"involvedUsers": [
"<string>"
],
"placeId": "<string>",
"gameId": "<string>",
"created": "2023-11-07T05:31:56Z",
"lastModified": "2023-11-07T05:31:56Z"
}
}