r_keeper Documentation

https://docs.rkeeper.ru
Admin
r_keeper is a comprehensive system for automating cafes, bars, and restaurants of any format,...
Tokens:138,377
Snippets:1,743
Trust Score:8.1
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install Cash Server as Service

Source: https://docs.rkeeper.ru/cloud/r_keeper-7-83198292.html

Use the /install parameter to register the cash server as a system service.

```shell
/install
```

--------------------------------

### Create order response

Source: https://docs.rkeeper.ru/delivery/sozdanie-zakaza-s-loyal-nost-yu-74645587.html

Example JSON response returned upon successful order creation.

```json
{
   "result":{
      "orderId":"123"
   }
}
```

--------------------------------

### Installing SH4DAPI Server for UTM Connection

Source: https://docs.rkeeper.ru/cloud/nastrojka-egais-v-sh4-cloud-77465557.html

Download and install the SH4DAPI server from the provided FTP link. This server is required to establish a connection with UTM for the Alcohol Declaration module.

```bash
ftp://ftp.ucs.ru/storehouse/sh4/sh4_Alc_Declaration/Setup.SH4DAPI.v1.10.7z
```

--------------------------------

### GET /restaurants/{guid}/settings/currencies

Source: https://docs.rkeeper.ru/delivery/delivery-21-04-2025-149849044.html

Retrieve the currency dictionary for a specific restaurant.

```APIDOC
## GET /restaurants/{guid}/settings/currencies

### Description
Retrieves the list of currencies available for a specific restaurant, identified by its GUID.

### Method
GET

### Endpoint
/restaurants/{guid}/settings/currencies

### Parameters
#### Path Parameters
- **guid** (string) - Required - The unique identifier (GUID) of the restaurant.

### Response
(Success response details not provided in the source text)
```

--------------------------------

### Loyalty Program Discount Response

Source: https://docs.rkeeper.ru/delivery/sozdanie-zakaza-s-loyal-nost-yu-74645587.html

Example response from the pre-calculation method when a loyalty program discount is applied.

```json
{
   "result":{
      "amount":{
         "totalAmount":1260.00,
         "orderAmount":1400.00,
         "deliveryAmount":0.0,
         "discountDeliveryAmount":null,
         "minOrderAmountFreeDelivery":0.0,
         "needForFree":0.0,
         "dishList":[
            {
               "id":"b5a5e2e8-958e-765c-2822-d5cf7c60df7d",
               "name":"Салат Мимоза",
               "price":200.0,
               "measure":{
                  "value":0.0,
                  "unit":""
               },
               "quantity":7.0,
               "ingredients":[
                  
               ],
               "discount":0.0
            }
         ],
         "loyaltyAmount":{
            "totalAmount":1260.00,
            "loyaltyDiscountAmount":140.0,
            "bonuses":{
               "guestBalance":1230.58,
               "rankName":"Платиновый	",
               "maxBonusesForPayment":0.0,
               "accrualWithPayment":0.0,
               "accrualWithoutPayment":0.0
            },
            "loyaltyPrograms":[
               {
                  "programName":"Базовая акция скидка на чек 10% за чек от 1000р",
                  "programNotification":[
                     "Вы получили скидку 10% по акции \"Базовая акция скидка на чек 10% за чек от 1000р\"."
                  ]
               }
            ],
            "fingerPrint":"eyJQYXR0ZXJuIjowLCJPcmRlckhhc2giOi0zNDA5MTI4NTMsIkRpc2NvdW50U3VtIjoxNDAuMDB9",
            "useRkLoyalty":true,
            "useLoyaltyBonusPayments":true
         },
         "discounts":{
            "useRk7Discounts":false,
            "total":1260.0,
            "discount":0.0,
            "discountList":[
               
            ]
         }
      },
      "times":{
         "deliveryTime":360
      }
   }
}
```

--------------------------------

### Launch Cash Server as Application

Source: https://docs.rkeeper.ru/cloud/r_keeper-7-83198292.html

Use the /desktop parameter to run the cash server as an application for the first time.

```shell
midserv.exe /desktop
```

--------------------------------

### GET /orderSources/{orderSourceId}/restaurants

Source: https://docs.rkeeper.ru/delivery/delivery-21-04-2025-149849044.html

Retrieve restaurants associated with a specific order source.

```APIDOC
## GET /orderSources/{orderSourceId}/restaurants

### Description
Retrieves a list of restaurants associated with a given order source ID. The currencies returned by this method are those configured in the restaurant's settings in the Admin Panel.

### Method
GET

### Endpoint
/orderSources/{orderSourceId}/restaurants

### Parameters
#### Path Parameters
- **orderSourceId** (string) - Required - The ID of the order source.

### Response
(Success response details not provided in the source text)
```
Tokens:
Raw