### Get All Supplies Request Example Source: https://github.com/joinposter/docs/blob/master/ru/web/storage/getSupplies.md Example of how to make an API request to retrieve all supplies using a PHP script. It shows the URL construction with a token. ```php ``` -------------------------------- ### Get Waiters Sales Request Example Source: https://github.com/joinposter/docs/blob/master/ru/web/dash/getWaitersSales.md Example of how to make a GET request to the `dash.getWaitersSales` endpoint with a token and a start date. ```php ``` -------------------------------- ### Project Setup and Development Source: https://github.com/joinposter/docs/blob/master/en/pos/start.md Steps to set up a new JoinPoster project using the provided boilerplate, including installing dependencies and running the development server. ```bash git clone cd npm install npm run dev ``` -------------------------------- ### Accessing the Web Version Source: https://github.com/joinposter/docs/blob/master/en/pos/start.md Instructions on how to access the web version of the JoinPoster cash solution after setting up the development environment. ```bash {account}.joinposter.com/pos ``` -------------------------------- ### Get Transactions Example Source: https://github.com/joinposter/docs/blob/master/ru/web/dash/getTransactions.md Example of how to make a GET request to the `dash.getTransactions` endpoint to retrieve a list of transactions within a specified date range. ```php ``` -------------------------------- ### Create Workshop Request Example Source: https://github.com/joinposter/docs/blob/master/en/web/menu/createWorkshop.md Provides a PHP example of how to make a POST request to the menu.createWorkshop API endpoint to create a new station. ```php 'Мангал', ]; $data = sendRequest($url, 'post', $workshop); ?> ``` -------------------------------- ### Starting Webpack Dev Server Source: https://github.com/joinposter/docs/blob/master/en/pos/debug.md This command demonstrates how to start the webpack-dev-server, which is crucial for the development workflow described in the documentation. It serves the bundled JavaScript file from http://127.0.0.1:8080. ```bash npx webpack-dev-server --mode development --open --hot ``` -------------------------------- ### Get Supply Ingredients Request Example Source: https://github.com/joinposter/docs/blob/master/en/web/storage/getSupplyIngredients.md Example of how to make a GET request to the `storage.getSupplyIngredients` endpoint using PHP. It demonstrates constructing the URL with the necessary token and `supply_id`. ```php ``` -------------------------------- ### Poster.settings Object Example Source: https://github.com/joinposter/docs/blob/master/ru/pos/settings.md Provides an example of the Poster.settings object, showcasing the structure and typical values for account and workshop configurations. This object is globally accessible and contains various settings related to the POS account. ```json { "accountUrl":"dev-example", "country":"RU", "currencyCodeIso":"RUB", "currency":"руб.", "currencySymbol":"", "lang":"ru", "spotId":1, "spotTabletId":1, "subnetMask":"192.168.1", "timezone":"Europe/Berlin", "usesTables":true, "workshops":{ "0":{ "id":1, "name":"Bar", "printTickets":1 }, "1":{ "id":2, "name":"Kitchen", "printTickets":1 } }, "applicationId":"110", "applicationName":"uds", "extras":{ "token":"123aksldk0123kdadk1i31kd12kdas" }, "spotExtras":{ "groupId":"3" }, "spotTabletExtras":{ "tabletIp":"on" } } ``` -------------------------------- ### Get Pack Request Example Source: https://github.com/joinposter/docs/blob/master/en/web/storage/getPack.md Example of how to make an HTTP GET request to the storage.getPack API endpoint with necessary parameters. ```php $url = 'https://joinposter.com/api/storage.getPack' . '?format=json' . '&token=687409:4164553abf6a031302898da7800b59fb' . '&pack_id=4'; $data = sendRequest($url); ``` -------------------------------- ### Create Workshop Request Example Source: https://github.com/joinposter/docs/blob/master/ru/web/menu/createWorkshop.md Example of how to create a workshop using the menu.createWorkshop API endpoint. It shows the URL, token, and POST data required for the request. ```php 'Мангал', ]; $data = sendRequest($url, 'post', $workshop); ?> ``` -------------------------------- ### Get Cash Shifts Request Example Source: https://github.com/joinposter/docs/blob/master/en/web/finance/getCashShifts.md Example of how to make a GET request to the `finance.getCashShifts` endpoint with specified parameters like token, date range, and timezone. ```php ``` -------------------------------- ### Create Account Response Example Source: https://github.com/joinposter/docs/blob/master/ru/web/finance/createAccount.md Example of the JSON response received after successfully creating an account using the finance.createAccount API. ```json { "response":4 } ``` -------------------------------- ### Get Transaction Products Request Example Source: https://github.com/joinposter/docs/blob/master/en/web/dash/getTransactionProducts.md Example of how to make a GET request to the `dash.getTransactionProducts` endpoint using PHP. It demonstrates constructing the URL with the necessary token and transaction ID. ```php ``` -------------------------------- ### clients.create API Documentation Source: https://github.com/joinposter/docs/blob/master/en/pos/clients/clients-create.md API documentation for the clients.create method. Details the request object structure, including mandatory and optional client properties, and the Promise-based response containing the created client object. ```APIDOC clients.create: Create a Customer on the Register Arguments: request object: An object with the `client` property containing customer data. client property: client_name: Mandatory. Full name of the customer. client_groups_id_client: Mandatory. The customer group ID. client_sex: Optional. Customer gender (1 for male, 2 for female). country_phone_code: Optional. Customer country code (e.g., 380 for Ukraine). phone: Optional. Customer phone number. email: Optional. Customer email address. card_number: Optional. Customer card number. city: Optional. Customer city. address: Optional. Customer address. country: Optional. Customer country. comment: Optional. A comment on the customer. birthday: Optional. Customer birthday in dd-MM-YYYY format. Response: Promise: Returns a Promise that resolves with an object containing the `client` property. client property: A Client-type object representing the newly created customer. ``` -------------------------------- ### Get Products Sales Request Example Source: https://github.com/joinposter/docs/blob/master/ru/web/dash/getProductsSales.md Example of how to make a GET request to the dash.getProductsSales endpoint using PHP to retrieve product sales data. It shows the URL construction with a token. ```php ``` -------------------------------- ### Platform Device Example Source: https://github.com/joinposter/docs/blob/master/ru/pos/types/device.md Example JSON object representing a platform device, including its ID, name, IP address, application version, status, and connection type. ```json { "id": "9fcb54d1f4a932d7", "name": "Kitchen Kit", "ip": "192.168.5.131", "appVersion": "2.0.2", "applicationId": 3, "status": 1, "icon": "https://dev.joinposter.com", "iconDevice": "https://dev.joinposter.com/public/apps/kitchen/icon-device.jpg", "connectionType": "lan" } ``` -------------------------------- ### PHP Request Example Source: https://github.com/joinposter/docs/blob/master/en/web/finance/getReport.md Example of how to make a GET request to the finance.getReport API endpoint using PHP. ```php ``` -------------------------------- ### Get Non-Manual Wastes Request Example Source: https://github.com/joinposter/docs/blob/master/en/web/storage/getIngredientWriteOff.md Example of how to make an HTTP GET request to the storage.getIngredientWriteOff endpoint using PHP. It demonstrates constructing the URL with a token and sending the request. ```php ``` -------------------------------- ### JoinPoster API Request Example Source: https://github.com/joinposter/docs/blob/master/en/template.md Demonstrates a typical POST request to the JoinPoster API, including setting up the URL, parameters, and sending the request using a hypothetical PosterAPI::sendRequest method. It also shows a sample JSON response. ```php ' . '?token=687409:4164553abf6a031302898da7800b59fb'; $group = [ ]; $data = PosterAPI::sendRequest($url, 'post', $group); ?> ``` ```json { "response":6 } ``` -------------------------------- ### Create Client Response Example Source: https://github.com/joinposter/docs/blob/master/ru/pos/clients/clients-create.md Example of a successful response when creating a new client. It returns a client object with properties like ID, name, and loyalty information. ```json { "client":{ "address":"0", "bonus":0, "discount":10, "firstname":"Владимир", "groupId":1, "id":33, "lastname":"Иванченко", "loyaltyType":1, "phone":"", "totalPayedSum":0 } } ``` -------------------------------- ### Get Supplies Response Example Source: https://github.com/joinposter/docs/blob/master/ru/web/storage/getSupplies.md Example JSON response from the storage.getSupplies API endpoint, showing the structure of the returned supply data. ```json { "response":[ { "supply_id":"48", "storage_id":"1", "supplier_id":"1", "date":"2017-11-17 08:09:33", "supply_sum":"1800", "supply_sum_netto":"1500", "supply_comment":"", "storage_name":"Склад Кухня", "supplier_name":"Закупщик", "delete":"1", "account_id":null }, { "supply_id":"47", "storage_id":"1", "supplier_id":"1", "date":"2017-05-18 09:11:00", "supply_sum":"300000", "supply_sum_netto":"250000", "supply_comment":"", "storage_name":"Склад Кухня", "supplier_name":"Закупщик", "delete":"0", "account_id":null }, { "supply_id":"46", "storage_id":"1", "supplier_id":"1", "date":"2017-05-18 09:07:00", "supply_sum":"669882890", "supply_sum_netto":"558235742", "supply_comment":"", "storage_name":"Склад Кухня", "supplier_name":"Закупщик", "delete":"0", "account_id":null } ] } ``` -------------------------------- ### Create Account Request Example Source: https://github.com/joinposter/docs/blob/master/ru/web/finance/createAccount.md Example of how to make a POST request to the finance.createAccount API endpoint to create a new account. It includes the URL, request method, and the account details payload. ```php 'Сейф', 'currency_id' => 3, 'type' => 1, 'balance_start' => 0, ]; $data = sendRequest($url, 'post', $account); ?> ``` -------------------------------- ### Get Manufacture Wastes Request Example Source: https://github.com/joinposter/docs/blob/master/en/web/storage/getManufacturesWriteOffs.md Example of how to make an HTTP GET request to the storage.getManufacturesWriteOffs endpoint to retrieve manufacture waste data. Includes parameters for token, date range, and pagination. ```php ``` -------------------------------- ### Product Object Example Source: https://github.com/joinposter/docs/blob/master/ru/pos/types/product.md An example JSON object representing a product in the JoinPoster system. It includes various attributes such as ID, pricing, fiscal status, and associated metadata. ```json { "id":162, "delete":0, "hidden":0, "fiscal":0, "fiscalProgram":0, "nodiscount":0, "parent":0, "sortOrder":0, "weightFlag":0, "workshop":2, "price":10.5, "cookingTime":0, "barcode":"", "picture":"", "color":"white", "taxType":0, "taxValue":0, "taxId":0, "taxName":"", "extras":{ } } ``` -------------------------------- ### Get Transaction History Request Example Source: https://github.com/joinposter/docs/blob/master/ru/web/dash/getTransactionHistory.md Example of how to make a GET request to the dash.getTransactionHistory API endpoint to retrieve the history of a specific transaction. ```php ``` -------------------------------- ### Create Workshop Response Example Source: https://github.com/joinposter/docs/blob/master/ru/web/menu/createWorkshop.md Example of the JSON response received after successfully creating a workshop using the menu.createWorkshop API. ```json { "response":5 } ``` -------------------------------- ### Get Own Incoming Order Request Example Source: https://github.com/joinposter/docs/blob/master/en/web/incomingOrders/getOwnIncomingOrder.md Example of how to make an HTTP GET request to the incomingOrders.getOwnIncomingOrder endpoint to retrieve details of a specific online order. ```php ``` -------------------------------- ### Get All Transactions Request Example Source: https://github.com/joinposter/docs/blob/master/en/web/finance/getTransactions.md Example of how to make a GET request to the finance.getTransactions API endpoint to retrieve all transactions within a specified date range. ```php ``` -------------------------------- ### User Object Example Source: https://github.com/joinposter/docs/blob/master/en/pos/types/user.md Provides an example of the User object structure, illustrating the fields and their typical values. ```json { "id":9, "posPass":"1234", "name":"Vladimir", "deleted":0, "admin":true, "inn":"", "extras":{ } } ``` -------------------------------- ### PHP Request Example Source: https://github.com/joinposter/docs/blob/master/en/web/menu/getProducts.md Example of how to make a request to the JoinPoster API using PHP to fetch product data. ```php ``` -------------------------------- ### PHP Example for Get Tax Properties Source: https://github.com/joinposter/docs/blob/master/ru/web/finance/getTax.md Example of how to make an HTTP GET request to the finance.getTax API endpoint using PHP to retrieve tax properties. ```php ``` -------------------------------- ### Деплой приложения Source: https://github.com/joinposter/docs/blob/master/ru/pos/deploy.md Команда для деплоя приложения в Poster Marketplace. Эта команда собирает бандл приложения и отправляет его на платформу. ```bash npm run deploy ``` -------------------------------- ### Get Waiters Sales Response Example Source: https://github.com/joinposter/docs/blob/master/ru/web/dash/getWaitersSales.md Example of the JSON response structure for the `dash.getWaitersSales` endpoint, showing sales data for multiple waiters. ```json { "response":[ { "user_id":"1", "name":"Demo", "profit":"153707331", "profit_netto":"128089443", "revenue":"186224294", "clients":"1414", "middle_time":49364.020916667, "middle_invoice":1317.0034936351 }, { "user_id":"2", "name":"Максим", "profit":"147406757", "profit_netto":"122838964", "revenue":"179108697", "clients":"1314", "middle_time":58078.986483333, "middle_invoice":1363.0798858447 }, { "user_id":"6", "name":"Антон", "profit":"155127873", "profit_netto":"129273228", "revenue":"188413623", "clients":"1424", "middle_time":1.8170166666667, "middle_invoice":1323.129375 } ] } ``` -------------------------------- ### PHP Example for spots.getSpot Source: https://github.com/joinposter/docs/blob/master/ru/web/spots/getSpot.md Demonstrates how to make a GET request to the spots.getSpot API endpoint using PHP to retrieve establishment details. ```php ```