### Get Preliminary Orders Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v8/html/T_Resto_Front_Api_IOperationService.htm Get all preliminary orders. ```APIDOC ## GET /api/orders/preliminary ### Description Get all preliminary orders. ### Method GET ### Endpoint /api/orders/preliminary ### Parameters #### Query Parameters - **None** ### Request Example ```json {} ``` ### Response #### Success Response (200) - **preliminaryOrders** (array) - A list of preliminary order objects. #### Response Example ```json { "preliminaryOrders": [ { "id": "prelim1", "orderNumber": "PRE-001" }, { "id": "prelim2", "orderNumber": "PRE-002" } ] } ``` ``` -------------------------------- ### StartService Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v8/html/T_Resto_Front_Api_IOperationService.htm Starts the specified service. ```APIDOC ## POST /api/services/start ### Description Starts the specified service. ### Method POST ### Endpoint /api/services/start ### Parameters #### Request Body - **serviceName** (string) - Required - The name of the service to start. ### Request Example ```json { "serviceName": "ReportingService" } ``` ### Response #### Success Response (200) - **status** (string) - Indicates the status of the service start operation. #### Response Example ```json { "status": "started" } ``` ``` -------------------------------- ### Get Product By ID Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v8/html/T_Resto_Front_Api_IOperationService.htm Returns product by id. ```APIDOC ## GET /api/products/{productId} ### Description Returns product by id. ### Method GET ### Endpoint /api/products/{productId} ### Parameters #### Path Parameters - **productId** (string) - Required - The ID of the product. ### Request Example ```json {} ``` ### Response #### Success Response (200) - **product** (object) - The product details. #### Response Example ```json { "product": { "id": "prod1", "name": "Burger" } } ``` ``` -------------------------------- ### StartProductsCooking Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v8/html/T_Resto_Front_Api_IOperationService.htm Starts cooking for the specified order item products. ```APIDOC ## POST /api/cooking/products/start ### Description Starts cooking for the specified order item products. ### Method POST ### Endpoint /api/cooking/products/start ### Parameters #### Request Body - **orderItemIds** (array) - Required - A list of order item IDs for which to start cooking. - **orderItemId** (string) - The ID of an order item. ### Request Example ```json { "orderItemIds": ["item_001", "item_002"] } ``` ### Response #### Success Response (200) - **status** (string) - Indicates the status of the cooking start request. #### Response Example ```json { "status": "cooking_started" } ``` ``` -------------------------------- ### StartCourseCooking Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v8/html/T_Resto_Front_Api_IOperationService.htm Starts cooking for all order item products of the specified course. ```APIDOC ## POST /api/cooking/course/start ### Description Starts cooking for all order item products of the specified course. ### Method POST ### Endpoint /api/cooking/course/start ### Parameters #### Request Body - **courseId** (string) - Required - The ID of the course for which to start cooking. ### Request Example ```json { "courseId": "course_main" } ``` ### Response #### Success Response (200) - **status** (string) - Indicates the status of the cooking start request. #### Response Example ```json { "status": "cooking_started" } ``` ``` -------------------------------- ### Get Product Category By ID Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v8/html/T_Resto_Front_Api_IOperationService.htm Returns productCategory by id. ```APIDOC ## GET /api/products/categories/{categoryId} ### Description Returns productCategory by id. ### Method GET ### Endpoint /api/products/categories/{categoryId} ### Parameters #### Path Parameters - **categoryId** (string) - Required - The ID of the product category. ### Request Example ```json {} ``` ### Response #### Success Response (200) - **productCategory** (object) - The product category details. #### Response Example ```json { "productCategory": { "id": "catA", "name": "Appetizers" } } ``` ``` -------------------------------- ### Get Product By Barcode Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v8/html/T_Resto_Front_Api_IOperationService.htm Returns product by barcode or null if it is not found. ```APIDOC ## GET /api/products/by-barcode ### Description Returns product by barcode or null if it is not found. ### Method GET ### Endpoint /api/products/by-barcode ### Parameters #### Query Parameters - **barcode** (string) - Required - The barcode of the product. ### Request Example ```json {} ``` ### Response #### Success Response (200) - **product** (object | null) - The product details or null if not found. #### Response Example ```json { "product": { "id": "prod1", "name": "Burger", "barcode": "123456789012" } } ``` ``` -------------------------------- ### Get Product Scale By ID Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v8/html/T_Resto_Front_Api_IOperationService.htm Returns productScale by id. ```APIDOC ## GET /api/products/scales/{scaleId} ### Description Returns productScale by id. ### Method GET ### Endpoint /api/products/scales/{scaleId} ### Parameters #### Path Parameters - **scaleId** (string) - Required - The ID of the product scale. ### Request Example ```json {} ``` ### Response #### Success Response (200) - **productScale** (object) - The product scale details. #### Response Example ```json { "productScale": { "id": "scale1", "name": "Weighable" } } ``` ``` -------------------------------- ### Get Product Group By ID Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v8/html/T_Resto_Front_Api_IOperationService.htm Returns productGroup by id. ```APIDOC ## GET /api/products/groups/{groupId} ### Description Returns productGroup by id. ### Method GET ### Endpoint /api/products/groups/{groupId} ### Parameters #### Path Parameters - **groupId** (string) - Required - The ID of the product group. ### Request Example ```json {} ``` ### Response #### Success Response (200) - **productGroup** (object) - The product group details. #### Response Example ```json { "productGroup": { "id": "group1", "name": "Combo Meals" } } ``` ``` -------------------------------- ### Get Discount Type by ID in C# Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v7preview7/html/M_Resto_Front_Api_IOperationService_GetDiscountTypeById.htm Retrieves an IDiscountType object from the Resto.Front.Api using its GUID. This method is part of the IOperationService and requires a valid GUID as input. ```csharp IDiscountType GetDiscountTypeById( Guid id ) ``` -------------------------------- ### Setup Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v7preview7/html/Methods_T_Resto_Front_Api_Devices_IDevice.htm Performs a setup operation for a device with new configuration. ```APIDOC ## POST /api/devices/{deviceId}/setup ### Description Performs a setup operation for a specific device, applying a new configuration. ### Method POST ### Endpoint /api/devices/{deviceId}/setup ### Parameters #### Path Parameters - **deviceId** (string) - Required - The unique identifier of the device to set up. #### Request Body - **configuration** (object) - Required - The new configuration settings for the device. - **setting1** (string) - Description of setting 1. - **setting2** (number) - Description of setting 2. ### Request Example ```json { "configuration": { "setting1": "value1", "setting2": 123 } } ``` ### Response #### Success Response (200) - **status** (string) - The result of the setup operation (e.g., 'success', 'pending'). - **message** (string) - A message providing details about the setup outcome. #### Response Example ```json { "status": "success", "message": "Device setup completed successfully." } ``` ``` -------------------------------- ### StartBanquet Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v8/html/T_Resto_Front_Api_IOperationService.htm Transits a banquet to the started status. Requires user rights to edit orders. ```APIDOC ## POST /api/banquets/start ### Description Transits banquet to the started status. User must have rights to edit orders. ### Method POST ### Endpoint /api/banquets/start ### Parameters #### Request Body - **banquetId** (String) - Required - The ID of the banquet to start. - **credentials** (ICredentials) - Required - User credentials. ### Request Example ```json { "banquetId": "banquet123", "credentials": { ... } } ``` ### Response #### Success Response (200) - **success** (Boolean) - Indicates if the operation was successful. #### Response Example ```json { "success": true } ``` ``` -------------------------------- ### GET /api/products/{productId} Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v8/html/T_Resto_Front_Api_IOperationService.htm Retrieves a product by its ID, or null if the product does not exist. ```APIDOC ## GET /api/products/{productId} ### Description Returns product by id or null if product with specified id doesn't exist. ### Method GET ### Endpoint /api/products/{productId} ### Parameters #### Path Parameters - **productId** (string) - Required - The ID of the product. ### Response #### Success Response (200) - **product** (object) - The product object. - **null** - Returned if the product does not exist. #### Response Example ```json { "id": "product123", "name": "Burger" } ``` ``` -------------------------------- ### Get and Set BoundEntityId Property (C#) Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v8/html/P_Resto_Front_Api_Data_Settings_PluginSettings_BoundEntityId.htm This C# code snippet demonstrates how to get and set the BoundEntityId property of the PluginSettings class. The property is of type Nullable Guid, allowing it to be null or a valid Guid. It is used to identify the entity associated with the plugin settings. ```csharp public Guid? BoundEntityId { get; set; } ``` -------------------------------- ### StartBanquet Method Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v8/html/M_Resto_Front_Api_Editors_IEditSession_ChangeOrderIikoCard5Coupon.htm No description -------------------------------- ### Get Price Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v8/html/T_Resto_Front_Api_IOperationService.htm Returns price for the product according to the given client price category. ```APIDOC ## GET /api/products/price ### Description Returns price for the product according to the given client price category. ### Method GET ### Endpoint /api/products/price ### Parameters #### Query Parameters - **productId** (string) - Required - The ID of the product. - **priceCategoryId** (string) - Required - The ID of the price category. ### Request Example ```json {} ``` ### Response #### Success Response (200) - **price** (number) - The price of the product. #### Response Example ```json { "price": 15.75 } ``` ``` -------------------------------- ### Get Product Groups Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v8/html/T_Resto_Front_Api_IOperationService.htm Retrieves a list of all available product groups. ```APIDOC ## GET /api/products/groups ### Description Retrieves a list of all available product groups. ### Method GET ### Endpoint /api/products/groups ### Parameters #### Query Parameters - **None** ### Request Example ```json {} ``` ### Response #### Success Response (200) - **productGroups** (array) - A list of product group objects. #### Response Example ```json { "productGroups": [ { "id": "group1", "name": "Combo Meals" }, { "id": "group2", "name": "Specials" } ] } ``` ``` -------------------------------- ### Get Conception By ID (C#) Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v7preview7/html/M_Resto_Front_Api_IOperationService_GetConceptionById.htm Retrieves a specific Conception object from the API using its unique Guid identifier. This method is part of the IOperationService and requires a valid Guid as input. ```csharp IConception GetConceptionById( Guid id ) ``` -------------------------------- ### StartProductsCooking Method Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v7preview7/html/M_Resto_Front_Api_IOperationService_GetReserves.htm Starts the cooking process for a list of products. This is a more granular way to manage kitchen preparation. ```APIDOC ## POST /api/kitchen/products/start-cooking ### Description Initiates the cooking process for a specified list of products. This allows for detailed tracking of individual item preparation in the kitchen. ### Method POST ### Endpoint /api/kitchen/products/start-cooking ### Parameters #### Request Body - **productIds** (array) - Required - A list of product identifiers for which cooking should commence. - **productId** (string) - Required - The ID of the product. - **quantity** (number) - Required - The quantity of the product to be cooked. ### Response #### Success Response (200) - **message** (string) - Confirmation message indicating that the cooking process has started for the specified products. #### Response Example ```json { "message": "Cooking started for specified products." } ``` ``` -------------------------------- ### Get Role by ID (C#) Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v7preview7/html/M_Resto_Front_Api_IOperationService_GetRoleById.htm Retrieves a role from the system using its unique GUID. This method is part of the IOperationService and requires a valid Guid as input. It returns an IRole object representing the found role. ```csharp IRole GetRoleById( Guid id ) ``` -------------------------------- ### StartService Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v7preview7/html/M_Resto_Front_Api_IOperationService_StartService.htm Starts a service for a given order using provided credentials. ```APIDOC ## POST /api/services/start ### Description Starts a service for a given order using provided credentials. This method is part of the IOperationService interface. ### Method POST ### Endpoint /api/services/start ### Parameters #### Request Body - **credentials** (ICredentials) - Required - The credentials returned by AuthenticateByPin method. - **order** (IOrder) - Required - The order to start the service from. - **service** (IOrderServiceItem) - Required - The service to start. ### Request Example ```json { "credentials": { ... }, "order": { ... }, "service": { ... } } ``` ### Response #### Success Response (200) Indicates that the service was successfully started. The response body might be empty or contain a confirmation status. #### Response Example ```json { "status": "success" } ``` ``` -------------------------------- ### Get Product Item Categories Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v8/html/T_Resto_Front_Api_IOperationService.htm Retrieves a list of all available product item categories. ```APIDOC ## GET /api/products/item-categories ### Description Retrieves a list of all available product item categories. ### Method GET ### Endpoint /api/products/item-categories ### Parameters #### Query Parameters - **None** ### Request Example ```json {} ``` ### Response #### Success Response (200) - **productItemCategories** (array) - A list of product item category objects. #### Response Example ```json { "productItemCategories": [ { "id": "itemCat1", "name": "Toppings" }, { "id": "itemCat2", "name": "Sauces" } ] } ``` ``` -------------------------------- ### Get Table By ID (C#) Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v7preview7/html/M_Resto_Front_Api_IOperationService_GetTableById.htm Retrieves an ITable object using its unique Guid identifier. This method is part of the IOperationService interface and requires a valid Guid as input. It returns an ITable object representing the table. ```csharp ITable GetTableById( Guid id ) ``` -------------------------------- ### Start Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v7preview7/html/Methods_T_Resto_Front_Api_Devices_IDevice.htm Initiates the start operation for a device. ```APIDOC ## POST /api/devices/{deviceId}/start ### Description Initiates the start operation for a specific device. ### Method POST ### Endpoint /api/devices/{deviceId}/start ### Parameters #### Path Parameters - **deviceId** (string) - Required - The unique identifier of the device to start. ### Response #### Success Response (200) - **message** (string) - Confirmation message indicating the device start operation has begun. #### Response Example ```json { "message": "Device start operation initiated for device ID: abc123xyz" } ``` ``` -------------------------------- ### Get Price Categories Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v8/html/T_Resto_Front_Api_IOperationService.htm Retrieves a list of all available price categories. ```APIDOC ## GET /api/products/price-categories ### Description Retrieves a list of all available price categories. ### Method GET ### Endpoint /api/products/price-categories ### Parameters #### Query Parameters - **None** ### Request Example ```json {} ``` ### Response #### Success Response (200) - **priceCategories** (array) - A list of price category objects. #### Response Example ```json { "priceCategories": [ { "id": "cat1", "name": "Standard" }, { "id": "cat2", "name": "VIP" } ] } ``` ``` -------------------------------- ### Get Tax Category by ID (C#) Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v7preview7/html/M_Resto_Front_Api_IOperationService_GetTaxCategoryById.htm Retrieves a specific tax category using its unique Guid. This method is part of the IOperationService and requires the Resto.Front.Api assembly. It takes a Guid as input and returns an ITaxCategory object. ```csharp ITaxCategory GetTaxCategoryById( Guid id ) ``` -------------------------------- ### Get Quick Menu Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v8/html/M_Resto_Front_Api_IOperationService_GetCafeSessionById.htm Retrieves the configuration -------------------------------- ### Get Product Item Category By ID Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v8/html/T_Resto_Front_Api_IOperationService.htm Returns productItemCategory by id. ```APIDOC ## GET /api/products/item-categories/{itemCategoryId} ### Description Returns productItemCategory by id. ### Method GET ### Endpoint /api/products/item-categories/{itemCategoryId} ### Parameters #### Path Parameters - **itemCategoryId** (string) - Required - The ID of the product item category. ### Request Example ```json {} ``` ### Response #### Success Response (200) - **productItemCategory** (object) - The product item category details. #### Response Example ```json { "productItemCategory": { "id": "itemCat1", "name": "Toppings" } } ``` ``` -------------------------------- ### Setup Device Configuration (C#) Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v8/html/M_Resto_Front_Api_Devices_IDevice_Setup.htm The Setup method is used to perform a new configuration setup operation for a device. It takes a DeviceSettings object as input, which contains the new device configuration. This method may throw a DeviceException if the device actions are not successful. ```csharp void Setup( DeviceSettings settings ) ``` -------------------------------- ### Get Order Type by ID (C#) Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v7preview7/html/M_Resto_Front_Api_IOperationService_GetOrderTypeById.htm Retrieves an IOrderType object from the API using its unique Guid. This method is part of the IOperationService and requires a valid Guid as input. It returns the corresponding IOrderType or null if not found. ```csharp IOrderType GetOrderTypeById( Guid id ) ``` -------------------------------- ### Get Kitchen Order by ID (C#) Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v7preview7/html/M_Resto_Front_Api_IOperationService_GetKitchenOrderById.htm Retrieves a specific kitchen order using its unique GUID. This method is part of the IOperationService and requires the Resto.Front.Api assembly. It takes a Guid as input and returns an IKitchenOrder object. ```csharp IKitchenOrder GetKitchenOrderById( Guid id ); ``` -------------------------------- ### Setup Device Configuration (C#) Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v7preview7/html/M_Resto_Front_Api_Devices_IDevice_Setup.htm The Setup method is used to perform a new configuration operation for a device. It takes a DeviceSettings object as input, which contains the new device configuration. This method may throw a DeviceException if the operation is not successful. ```csharp void Setup( DeviceSettings settings ) ``` -------------------------------- ### Get Printing Device Infos Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v8/html/T_Resto_Front_Api_IOperationService.htm Retrieves a list of all available printing device information. ```APIDOC ## GET /api/printing/devices ### Description Retrieves a list of all available printing device information. ### Method GET ### Endpoint /api/printing/devices ### Parameters #### Query Parameters - **None** ### Request Example ```json {} ``` ### Response #### Success Response (200) - **printingDeviceInfos** (array) - A list of printing device information objects. #### Response Example ```json { "printingDeviceInfos": [ { "id": "printer1", "name": "Kitchen Printer", "type": "thermal" }, { "id": "receiptPrinter", "name": "Receipt Printer", "type": "thermal" } ] } ``` ``` -------------------------------- ### StartProductsCooking Method Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v8/html/M_Resto_Front_Api_IOperationService_GetPastOrders.htm Starts the cooking process for a list of products. This method initiates product preparation. ```APIDOC ## POST /api/StartProductsCooking ### Description Starts the cooking process for a list of products. ### Method POST ### Endpoint /api/StartProductsCooking ### Parameters #### Request Body - **productIds** (array) - Required - List of product IDs. ### Request Example { "productIds": [1, 2, 3] } ### Response #### Success Response (200) - **status** (string) - Cooking start status. #### Response Example { "status": "Products cooking started" } ``` -------------------------------- ### Get Cash Register Close Encashment Setup (C#) Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v8/html/P_Resto_Front_Api_Data_Device_ICashRegisterInfo_CloseEncashmentSetup.htm Retrieves the CashRegisterCloseEncashmentSetup object associated with the cash register. This property is read-only and returns the setup configuration for closing encashments. ```csharp CashRegisterCloseEncashmentSetup CloseEncashmentSetup { get; } ``` -------------------------------- ### GetStopListProductsRemainingAmounts Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v8/html/T_Resto_Front_Api_IOperationService.htm Gets the remaining amounts of products and their sizes that are currently in the stop list. ```APIDOC ## GET /api/operations/stoplistproducts/remainingamounts ### Description Gets the remaining amounts of products and their sizes that are currently in the stop list. ### Method GET ### Endpoint /api/operations/stoplistproducts/remainingamounts ### Response #### Success Response (200) - **products** (array) - A list of products in the stop list with their remaining amounts. - **productId** (string) - The ID of the product. - **sizeId** (string) - The ID of the product size. - **remainingAmount** (number) - The remaining amount of the product. ``` -------------------------------- ### StartProductsCooking Method Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v7preview7/html/M_Resto_Front_Api_IOperationService_CheckProductsSellingRestrictions.htm Initiates the cooking process for specified products. ```APIDOC ## POST /api/kitchen/products/start-cooking ### Description Initiates the cooking process for a list of specified products, typically for kitchen display systems. ### Method POST ### Endpoint /api/kitchen/products/start-cooking ### Parameters #### Request Body - **productIds** (array) - Required - A list of product IDs to start cooking. - **productId** (string) - Required - The ID of the product. - **quantity** (integer) - Required - The quantity of the product to cook. ### Response #### Success Response (200) - **status** (string) - The status of the operation (e.g., 'Cooking Initiated'). - **message** (string) - Confirmation message. #### Response Example ```json { "status": "Cooking Initiated", "message": "Cooking process started for specified products." } ``` ``` -------------------------------- ### Get Payment Type by ID (C#) Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v7preview7/html/M_Resto_Front_Api_IOperationService_TryGetPaymentTypeById.htm This C# method attempts to retrieve an IPaymentType object using its GUID. It returns the payment type if found, otherwise it returns null. The method requires a valid Guid as input. ```csharp IPaymentType TryGetPaymentTypeById( Guid id ) ``` -------------------------------- ### StartProductsCooking Method Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v7preview7/html/M_Resto_Front_Api_IOperationService_TryGetDeliveryCancelCauseById.htm Starts the cooking process for a list of products. This is also relevant for KDS management. ```APIDOC ## POST /api/kitchen/products/start-cooking ### Description Initiates the cooking process for a specified list of products. This endpoint is designed for managing food preparation stages within a kitchen environment, often integrated with KDS. ### Method POST ### Endpoint /api/kitchen/products/start-cooking ### Parameters #### Request Body - **productIds** (array) - Required - A list of unique identifiers for the products to start cooking. - **productId** (string) - Required - The identifier of the product. - **orderId** (string) - Required - The identifier of the order associated with these products. ### Request Example ```json { "productIds": ["prod-101", "prod-102"], "orderId": "order-123" } ``` ### Response #### Success Response (200) - **status** (string) - The status update for the products (e.g., "Cooking"). - **message** (string) - A confirmation message. #### Response Example ```json { "status": "Cooking", "message": "Cooking initiated for specified products." } ``` ``` -------------------------------- ### Get User By ID (C#) Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v7preview7/html/M_Resto_Front_Api_IOperationService_GetUserById.htm Retrieves a user object from the API using its unique GUID. This method is part of the IOperationService interface and requires a valid Guid as input. It returns an IUser object representing the found user. ```csharp IUser GetUserById( Guid id ) ``` -------------------------------- ### GET /api/products/{productId}/parent Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v8/html/T_Resto_Front_Api_IOperationService.htm Retrieves the parent of a specified product, or null if the product does not exist. ```APIDOC ## GET /api/products/{productId}/parent ### Description Returns parent of the specified product or null if product doesn't exist. ### Method GET ### Endpoint /api/products/{productId}/parent ### Parameters #### Path Parameters - **productId** (string) - Required - The ID of the product. ### Response #### Success Response (200) - **parentProduct** (object) - The parent product object. - **null** - Returned if the product does not exist. #### Response Example ```json { "id": "parentProduct123", "name": "Parent Product" } ``` ``` -------------------------------- ### IDevice.Setup Method Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v8/html/M_Resto_Front_Api_Devices_IDevice_Setup.htm The Setup method is used to perform a new configuration operation for a device. It takes DeviceSettings as a parameter and may throw a DeviceException if the operation is unsuccessful. ```APIDOC ## POST /api/devices/{deviceId}/setup ### Description Performs a new configuration operation for a device using the provided settings. ### Method POST ### Endpoint `/api/devices/{deviceId}/setup` ### Parameters #### Path Parameters - **deviceId** (string) - Required - The unique identifier of the device to set up. #### Query Parameters None #### Request Body - **settings** (DeviceSettings) - Required - The new device configuration settings. - **Example**: `{ "someSetting": "value", "anotherSetting": 123 }` ### Request Example ```json { "settings": { "connectionString": "Server=myServer;Database=myDb;", "timeoutSeconds": 60 } } ``` ### Response #### Success Response (200 OK) Indicates that the device setup operation was successful. The response body may be empty or contain a success message. #### Response Example ```json { "message": "Device setup successful" } ``` #### Error Response (400 Bad Request) - **error** (string) - Description of the error if the request parameters are invalid. #### Error Response (500 Internal Server Error) - **error** (string) - Description of the error if the device action was not successful. ### Exceptions - **DeviceException**: Thrown when the device action is not successful. ``` -------------------------------- ### Get Terminal By ID (C#) Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v7preview7/html/M_Resto_Front_Api_IOperationService_GetTerminalById.htm Retrieves an ITerminal object using its unique Guid identifier. This method is part of the IOperationService interface and requires a valid Guid as input. It returns an ITerminal object representing the specified terminal. ```csharp ITerminal GetTerminalById( Guid id ) ``` -------------------------------- ### Get Product Category by ID - C# Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v7preview7/html/M_Resto_Front_Api_IOperationService_GetProductCategoryById.htm Retrieves a specific product category by its unique GUID identifier. This method is part of the IOperationService interface and requires a valid Guid as input. It returns an object implementing the IProductCategory interface. ```csharp IProductCategory GetProductCategoryById( Guid id ); AddLanguageTabSet("ID0EACA"); ``` -------------------------------- ### SetupDevice Source: https://github.com/alex34422/front.api.sdk/blob/master/docs/v8/html/Methods_T_Resto_Front_Api_Devices_ICashRegister.htm Performs the operation to set up a new configuration for the cash register device. ```APIDOC ## POST /api/device/setup ### Description Perform setup new configuration operation. ### Method POST ### Endpoint /api/device/setup ### Parameters #### Query Parameters None #### Request Body - **configuration** (object) - Required - The new configuration settings for the device. ### Request Example { "configuration": { "ipAddress": "192.168.1.100", "port": 8080 } } ### Response #### Success Response (200) - **message** (string) - Confirmation message that the setup operation was successful. #### Response Example { "message": "Device setup completed successfully." } ```