### Install Dependencies and Run Dev Server

Source: https://dev.joinposter.com/docs/v3/pos/start

Installs project dependencies using npm and starts the development server. Assumes Node.js and npm are installed.

```bash
npm install
npm run dev
```

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

### Poster API Request Examples (JavaScript & PHP)

Source: https://dev.joinposter.com/docs/v3/start/request

Demonstrates how to send POST and GET requests to the Poster API. Includes a JavaScript example for updating a product and a PHP function for generic request handling, showcasing GET requests for client groups.

```javascript
https://joinposter.com/api/menu.updateProduct?token=687409:4164553abf6a031302898da7800b59fb  { "id": 142, "product_name": "Пончик", "menu_category_id": 0, "workshop": 1, "weight_flag": 0, "color": "red", "different_spots_prices": 0, "modifications": 0, "cost": 2000, "price": 3000, "visible": 1, "fiscal_code": 1234567890 }
```

```php
<?php function sendRequest($url, $type = 'get', $params = [], $json = true) {     $ch = curl_init();     curl_setopt($ch, CURLOPT_URL, $url);     curl_setopt($ch, CURLOPT_HEADER, false);     curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);     curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);     curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);      if ($type == 'post' || $type == 'put') {         curl_setopt($ch, CURLOPT_POST, true);          if ($json) {             $params = json_encode($params);              curl_setopt($ch, CURLOPT_HTTPHEADER, [                 'Content-Type: application/json',                 'Content-Length: ' . strlen($params)             ]);              curl_setopt($ch, CURLOPT_POSTFIELDS, $params);         } else {             curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($params));         }     }      curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 30);     curl_setopt($ch, CURLOPT_USERAGENT, 'Poster (http://joinposter.com)');      $data = curl_exec($ch);     curl_close($ch);      return $data; }  $url = 'https://joinposter.com/api/clients.getGroup'      . '?format=json'     . '&token=687409:4164553abf6a031302898da7800b59fb'     . '&group_id=1';  $group = sendRequest($url);
```

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

### Get Employees List Request Examples (JavaScript, PHP, Postman)

Source: https://dev.joinposter.com/docs/v3/web/access/getEmployees

Examples of how to make an HTTP GET request to the access.getEmployees endpoint using JavaScript, PHP, and Postman. These examples demonstrate constructing the API URL with a token.

```javascript
const url = 'https://joinposter.com/api/access.getEmployees ?token=687409:4164553abf6a031302898da7800b59fb';
```

```php
<?php
$url = 'https://joinposter.com/api/access.getEmployees'  . '?token=687409:4164553abf6a031302898da7800b59fb';

$data = sendRequest($url);
?>
```

```json
url = https://joinposter.com/api/access.getEmployees  ?token=687409:4164553abf6a031302898da7800b59fb;
```

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

### Device Discovery HTTP GET Request Example

Source: https://dev.joinposter.com/docs/v3/device/start

Illustrates the HTTP GET request format used for device discovery within the local network. The response from the device should adhere to specific status codes (200 or 404 with JSON/tag) for successful integration.

```HTTP
GET _192.168.1.123:2224_
```

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

### Get Application Info - PHP

Source: https://dev.joinposter.com/docs/v3/web/application/getInfo

Example of how to retrieve application information using a GET request in PHP. This snippet demonstrates constructing the URL and sending the request.

```php
<?php
$url = 'https://joinposter.com/api/application.getInfo'  . '?token=687409:4164553abf6a031302898da7800b59fb';

$data = sendRequest($url, 'get', []);
?>
```

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

### Poster API: Get Client Groups Request Examples

Source: https://dev.joinposter.com/docs/v3/web/clients/getGroups

Demonstrates how to construct the API request to fetch client groups using JavaScript and PHP. Both examples include the base URL and a placeholder for the API token.

```javascript
const url = 'https://joinposter.com/api/clients.getGroups ?token=687409:4164553abf6a031302898da7800b59fb'
```

```php
<?php
$url = 'https://joinposter.com/api/clients.getGroups' . '?token=687409:4164553abf6a031302898da7800b59fb';
$data = sendRequest($url);
?>
```

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

### Device Integration Setup

Source: https://dev.joinposter.com/docs/v3/device/start_id=%D0%9D%D0%B0%D1%87%D0%B0%D0%BB%D0%BE-%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D1%8B

Instructions for enabling and setting up device integration within the JoinPoster application settings.

```APIDOC
## Setup Guide

### Enable POS and Device Platforms
To work with devices, enable the **POS platform** and **Device platform** toggles in your application's settings.

### Connect Device at the Register
To test the **Device platform**, you need to open the register on an iOS, Android, or Desktop application.

Device search is performed via Ethernet, so the register and the external device must be on the same local network.

To connect your device, go to **Settings → Devices → Other Hardware → Your Application → Connect Device**.
```

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

### Install Dependencies

Source: https://dev.joinposter.com/docs/v3/pos/start_id=%D0%9D%D0%B0%D1%87%D0%B0%D0%BB%D0%BE-%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D1%8B

Installs all necessary project dependencies using npm. This command is essential after cloning the repository.

```bash
npm install
```

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

### POS Platform Dev/Prod Switcher

Source: https://dev.joinposter.com/docs/v3/start/faq_id=%D0%90%D0%B2%D1%82%D0%BE%D1%80%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F-%D0%B8-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF

Steps to enable the Dev/Prod switcher for the POS platform.

```APIDOC
## POS Platform Dev/Prod Switcher

### Description
To enable the Dev/Prod switcher on your POS cashier:

1.  Activate the **POS platform** toggle in your application's settings.
2.  In your developer account, add the Poster account (where the switcher is missing) to the list of developers.
3.  Connect your integration within the Poster account via the **Poster App Directory**.
```

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

### Get Application Info - JavaScript

Source: https://dev.joinposter.com/docs/v3/web/application/getInfo

Example of how to retrieve application information using a GET request in JavaScript. Requires a valid API token.

```javascript
const url = 'https://joinposter.com/api/application.getInfo ?token=687409:4164553abf6a031302898da7800b59fb';
```

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

### Get Order Sources (PHP)

Source: https://dev.joinposter.com/docs/v3/web/settings/getOrderSources

Example of how to fetch order source properties using PHP by making an HTTP GET request to the Poster API.

```php
<?php
$url = 'https://joinposter.com/api/settings.getOrderSources' 
 . '?token=687409:4164553abf6a031302898da7800b59fb';

$data = sendRequest($url);

```

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

### Device Discovery and Connection

Source: https://dev.joinposter.com/docs/v3/device/start

This section details how to enable and utilize the Device Platform for connecting external hardware. It covers the initial setup in the POS application settings and the network discovery process.

```APIDOC
## Enable Device Platform

### Description
To work with devices, enable the **POS platform** and **Device platform** toggles in your application's settings.

### Method
N/A (Configuration setting)

### Endpoint
N/A (Application Settings)

### How to Connect a Device at the Checkout

### Description
To test the **Device platform**, you need to open the checkout on an iOS, Android, or Desktop application. Device discovery is performed via Ethernet; therefore, the checkout and the external device must be on the same local network.

To connect your device, navigate to **Settings → Devices → Other Hardware → Your Application → Connect Device**.

### Method
N/A (UI Navigation)

### Endpoint
N/A (Application Settings)
```

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

### OAuth Authorization Setup

Source: https://dev.joinposter.com/docs/v3/start/faq_id=_12-%D0%9A%D0%B0%D0%BA-%D0%B8-%D0%B3%D0%B4%D0%B5-%D1%8F-%D0%BC%D0%BE%D0%B3%D1%83-%D0%BF%D_346c1e_D0%B5%D0%BB%D1%8C%D0%BD%D0%BE%D0%B5-%D0%BF%D1%80%D0%B8%D0%BB%D0%BE%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5

Guidance on setting up OAuth authorization for obtaining tokens from multiple clients.

```APIDOC
## OAuth Authorization Setup

### Description
Information on how to set up OAuth authorization for obtaining tokens from various clients. Refer to the provided webinar and detailed textual instructions for guidance.

### Method
N/A (Informational)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
None
```

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

### Get Transactions List (PHP)

Source: https://dev.joinposter.com/docs/v3/web/transactions/getTransactions

Example of making an HTTP GET request to the transactions.getTransactions API endpoint using PHP. It demonstrates how to construct the URL with necessary parameters like token, date range, and pagination settings.

```php
<?php
$url = 'https://joinposter.com/api/transactions.getTransactions'
 . '?token=687409:4164553abf6a031302898da7800b59fb'
 . '&date_from=2017-11-30'
 . '&date_to=2017-11-30'
 . '&per_page=10'
 . '&page=5';

$data = sendRequest($url);

```

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

### OAuth Authorization Setup

Source: https://dev.joinposter.com/docs/v3/start/faq_id=%D0%9C%D0%B0%D1%80%D0%BA%D0%B5%D1%82%D0%BF%D0%BB%D0%B5%D0%B9%D1%81-%D0%B8-%D0%BF%D1%83%D0%B1%D0%BB%D0%B8%D0%BA%D0%B0%D1%86%D0%B8%D1%8F

Instructions and resources for setting up OAuth authorization for obtaining tokens from multiple clients.

```APIDOC
## OAuth Authorization Setup

### Description
Guidance on how to configure OAuth authorization for Poster API access, allowing you to obtain tokens from various clients.

### Resources
- **Webinar:** A webinar is available that covers the OAuth authorization process in detail.
- **Textual Instruction:** A detailed text-based guide is also provided for step-by-step instructions.
```

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

### Get Account Categories (JavaScript)

Source: https://dev.joinposter.com/docs/v3/web/finance/getCategories

Example of how to make a GET request to the finance.getCategories API endpoint using JavaScript to fetch account categories. Requires a valid API token.

```javascript
const url = 'https://joinposter.com/api/finance.getCategories?token=687409:4164553abf6a031302898da7800b59fb';
```

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

### OAuth Authorization Setup

Source: https://dev.joinposter.com/docs/v3/start/faq_id=_23-%D0%9F%D0%BE%D1%87%D0%B5%D0%BC%D1%83-%D1%83-%D0%BC%D0%B5%D0%BD%D1%8F-%D0%BD%D0%B0-%D0_52eb9d_%B5%D1%82-%D0%BF%D0%B5%D1%80%D0%B5%D0%BA%D0%BB%D1%8E%D1%87%D0%B0%D1%82%D0%B5%D0%BB%D1%8F-devprod

Instructions and resources for setting up OAuth authorization for API access.

```APIDOC
## How to set up OAuth authorization?
Watch our webinar with the answer to this question. We also have a detailed text-based guide.
```

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

### Get Transaction Writeoffs Request Examples

Source: https://dev.joinposter.com/docs/v3/web/dash/getTransactionWriteOffs_id=dashgettransactionwriteoffs-%D0%9F%D0%BE%D0%BB%D1%83%D1%87%D0%B8%D1%82%D1%8C-%D1%81%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-%D0%BF%D0%BE-%D1%87%D0%B5%D0%BA%D1%83

Examples of how to make a GET request to the dash.getTransactionWriteoffs API endpoint using JavaScript, PHP, and Postman. These examples demonstrate constructing the API URL with necessary parameters like token and transaction_id.

```javascript
const url = 'https://joinposter.com/api/dash.getTransactionWriteoffs?token=687409:4164553abf6a031302898da7800b59fb&transaction_id=388678';
```

```php
<?php
$url = 'https://joinposter.com/api/dash.getTransactionWriteoffs' \
  . '?token=687409:4164553abf6a031302898da7800b59fb' \
  . '&transaction_id=388678';

$data = sendRequest($url);
```

```http
GET https://joinposter.com/api/dash.getTransactionWriteoffs?token=687409:4164553abf6a031302898da7800b59fb&transaction_id=388678
```

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

### Run Development Server

Source: https://dev.joinposter.com/docs/v3/pos/start_id=%D0%9D%D0%B0%D1%87%D0%B0%D0%BB%D0%BE-%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D1%8B

Starts the development server to allow for real-time testing and debugging of the application. This command typically watches for file changes and rebuilds the project.

```bash
npm run dev
```

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

### Get Hall List Example (PHP)

Source: https://dev.joinposter.com/docs/v3/web/spots/getSpotTablesHalls

This PHP code snippet demonstrates how to make an HTTP GET request to the Poster API to retrieve a list of halls. It requires a valid API token.

```php
<?php
$url = 'https://joinposter.com/api/spots.getSpotTablesHalls'
 . '?token=687409:4164553abf6a031302898da7800b59fb';

$data = sendRequest($url);
```

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

### OAuth Authorization Setup

Source: https://dev.joinposter.com/docs/v3/start/faq_id=_13-%D0%9A%D0%B0%D0%BA-%D0%BD%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B8%D1%82%D1%8C-oauth-%D0%B0%D0%B2%D1%82%D0%BE%D1%80%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8E

Information on setting up OAuth authorization for obtaining tokens from multiple clients.

```APIDOC
## OAuth Authorization

### Description
Detailed instructions and webinar available for setting up OAuth authorization to obtain tokens for multiple clients.

### Method
N/A (Refer to external resources)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
None

### Additional Information
Refer to the provided webinar and text instructions for OAuth setup.
```

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

### Get Transactions using JavaScript

Source: https://dev.joinposter.com/docs/v3/web/dash/getTransactions

Example of how to retrieve transaction data from the Poster API using a GET request in JavaScript. It constructs the URL with necessary parameters like token, dateFrom, and dateTo.

```javascript
const url = 'https://joinposter.com/api/dash.getTransactions ?token=687409:4164553abf6a031302898da7800b59fb &dateFrom=20240905 &dateTo=20240908';
```

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

### Get Promotions List - Postman Example

Source: https://dev.joinposter.com/docs/v3/web/clients/getPromotions

This snippet provides the configuration for making a GET request to the clients.getPromotions API endpoint using Postman. It specifies the URL including the necessary token for authentication.

```json
url = https://joinposter.com/api/clients.getPromotions  ?token=687409:4164553abf6a031302898da7800b59fb
```

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

### Device Connection via Integration

Source: https://dev.joinposter.com/docs/v3/device/start_id=%D0%9D%D0%B0%D1%87%D0%B0%D0%BB%D0%BE-%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D1%8B

Details on how devices are discovered and connected through third-party integrations, including port configuration and response formats.

```APIDOC
## Device Connection via Integration

### Port Configuration
Device discovery works on a specific port. To configure this port, contact support at contact@joinposter.com to change it for your application. Any port except 2222 and 2223 can be used, as these are reserved for technical purposes.

### Device Discovery Request
The application discovers devices on the local network by sending an HTTP GET request. For example: `_192.168.1.123:2224_`.

To pass the device's IP address to your integration, the response must meet one of the following criteria:

*   **Status Code 200**
*   **Status Code 404** with a tag
*   **Status Code 404** with any JSON content
```

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

### POS Platform - Dev/Prod Switcher

Source: https://dev.joinposter.com/docs/v3/start/faq_id=_19-%D0%9C%D0%BE%D0%B6%D0%BD%D0%BE-%D0%BF%D0%BE-api-%D0%BF%D0%B5%D1%80%D0%B5%D0%B4%D0%B0%_556b66_0%B0%D1%80%D1%82%D1%8B-%D0%B8%D0%BB%D0%B8-%D0%BA%D0%B0%D1%82%D0%B5%D0%B3%D0%BE%D1%80%D0%B8%D0%B8

Steps to enable the Dev/Prod switcher on the POS platform.

```APIDOC
## POS Platform - Dev/Prod Switcher

### Description
If the Dev/Prod switcher is not visible on your POS, follow these steps:

### Steps
1.  **Enable POS Platform:** In your application settings, enable the **POS platform** toggle.
2.  **Add Poster Account:** In your developer account, add the Poster account (where you don't see the switcher) to the list of developers.
3.  **Connect Integration:** Connect your integration in the Poster account via the **Poster App Catalog**.
```

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

### Get Promotions List - JavaScript Example

Source: https://dev.joinposter.com/docs/v3/web/clients/getPromotions

This JavaScript code snippet demonstrates how to make a GET request to the clients.getPromotions API endpoint to retrieve a list of promotions. It constructs the URL with a token for authentication.

```javascript
const url = 'https://joinposter.com/api/clients.getPromotions ?token=687409:4164553abf6a031302898da7800b59fb'
```

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

### Integrating Websites with Poster

Source: https://dev.joinposter.com/docs/v3/start/faq_id=_20-%D0%9A%D0%B0%D0%BA-%D0%B7%D0%B0%D1%80%D0%B0%D0%BD%D0%B5%D0%B5-%D0%B2%D0%B0%D0%BB%D0%B_1d79a3_0%BD%D0%B5-%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B0%D1%82%D1%8C-%D0%BE%D1%88%D0%B8%D0%B1%D0%BA%D1%83

Information on integrating websites (Tilda, OpenCart, Wix, WordPress, uKit, custom) with Poster for online orders.

```APIDOC
## Integrating Websites with Poster

### Description
Guidance for integrating various website platforms (Tilda, OpenCart, Wix, WordPress, uKit, custom-built) with Poster to receive online orders.

### Integration Options
- **Third-Party Developer:** You can hire a third-party developer for integration. JoinPoster provides documentation for integrating e-commerce stores with Poster.
- **WordPress + WooCommerce:** A pre-built application is available in the Poster App Catalog for integration with WordPress + WooCommerce.
```

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

### Get Own Incoming Order (PHP Example)

Source: https://dev.joinposter.com/docs/v3/web/incomingOrders/getOwnIncomingOrder

This snippet demonstrates how to make an HTTP GET request to the JoinPoster API to retrieve the details of a specific incoming order. It requires a valid API token and the order ID. The response contains detailed information about the order and the client.

```php
<?php
$url = 'https://joinposter.com/api/incomingOrders.getOwnIncomingOrder'
 . '?token=687409:4164553abf6a031302898da7800b59fb'
 . '&incoming_order_id=1';

$data = sendRequest($url);
?>
```

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

### Device Discovery and Connection

Source: https://dev.joinposter.com/docs/v3/device/start_id=%D0%9A%D0%B0%D0%BA-%D0%BF%D0%BE%D0%B4%D0%BA%D0%BB%D1%8E%D1%87%D0%B8%D1%82%D1%8C-%D1%83%D1%81%D1%82%D1%80%D0%BE%D0%B9%D1%81%D1%82%D0%B2%D0%BE-%D0%BD%D0%B0-%D0%BA%D0%B0%D1%81%D1%81%D0%B5

This section details how to enable device platform features and connect devices through the POS application or custom integrations.

```APIDOC
## Getting Started

To work with devices, enable the **POS platform** and **Device platform** toggles in your application settings.

### How to Connect a Device at the Checkout

To test the **Device platform**, you need to open the checkout on an iOS, Android, or Desktop application.

Device discovery is performed via Ethernet, so the checkout and the external device must be on the same local network.

To connect your device, go to **Settings → Devices → Other Hardware → Your Application → Connect Device**.

### Connecting a Device via Integration

Discovery works on a specific port. To specify this port, email us at contact@joinposter.com so we can change it for your application. This can be any port except 2222 and 2223, which are used for our technical needs.

The application checks all devices on the local network by sending an HTTP GET request, for example: _192.168.1.123:2224_. To pass the device's IP address to your integration, the response must match one of the following:
  * Status code 200
  * Status code 404 with a tag
  * Status code 404 with any JSON inside
```

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

### PHP: Get Manual Waste Details

Source: https://dev.joinposter.com/docs/v3/web/storage/getWaste

Example of making an HTTP GET request to the storage.getWaste API endpoint to retrieve detailed information about a specific manual write-off. Requires a valid API token and the waste_id.

```php
<?php
$url = 'https://joinposter.com/api/storage.getWaste'
  . '?token=687409:4164553abf6a031302898da7800b59fb'
  . '&waste_id=1';

$data = sendRequest($url);

```

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

### Get Waste Reasons - PHP Example

Source: https://dev.joinposter.com/docs/v3/web/storage/getWasteReasons

This PHP code snippet demonstrates how to make an HTTP GET request to the storage.getWasteReasons API endpoint to retrieve a list of waste reasons. It requires a valid API token.

```php
<?
$url = 'https://joinposter.com/api/storage.getWasteReasons'
  . '?token=687409:4164553abf6a031302898da7800b59fb';

$data = sendRequest($url);
?>
```

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

### OAuth Authorization Setup

Source: https://dev.joinposter.com/docs/v3/start/faq

Information on setting up OAuth authorization.

```APIDOC
## How to set up OAuth authorization?

Watch our webinar with the answer to this question. We also have a detailed text-based guide.
```

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

### Get Specific Product Information

Source: https://dev.joinposter.com/docs/v3/market/guidelines/e-commerce

Fetches detailed information about a specific product using its ID. This is typically used in conjunction with product webhooks to get updated product details when changes occur in Poster.

```http
GET /api/v1/menu/getProduct?product_id={id}
```

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

### Device Discovery via HTTP GET Request

Source: https://dev.joinposter.com/docs/v3/device/start_id=%D0%9D%D0%B0%D1%87%D0%B0%D0%BB%D0%BE-%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D1%8B

Demonstrates how the JoinPoster application discovers devices on the local network by sending an HTTP GET request to a device's IP address and port. The response from the device must conform to specific status codes (200 or 404 with JSON) for successful integration.

```HTTP
GET 192.168.1.123:2224
```

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

### JSON: Example Response for menu.getProduct (Product)

Source: https://dev.joinposter.com/docs/v3/web/menu/getProduct

An example JSON response structure for the menu.getProduct API call when requesting product properties. It includes details like name, price, category, and spots.

```json
{
  "response":{
    "barcode":"",
    "category_name":"Свежевыжатые соки",
    "unit":"",
    "cost":"1880",
    "cost_netto":"1567",
    "fiscal":"0",
    "hidden":"0",
    "menu_category_id":"16",
    "workshop":"4",
    "nodiscount":"0",
    "photo":"/upload/4/menu/product_1403094607_140.jpg",
    "product_code":"",
    "product_id":"140",
    "product_name":"Апельсиновый",
    "sort_order":"1",
    "tax_id":"0",
    "product_tax_id":"0",
    "type":"3",
    "weight_flag":"0",
    "color":"white",
    "spots":[
      {
        "spot_id":"1",
        "price":"40000",
        "profit":"38120",
        "profit_netto":"31767",
        "visible":"1"
      },
      {
        "spot_id":"2",
        "price":"40000",
        "profit":"38120",
        "profit_netto":"31767",
        "visible":"1"
      }
    ],
    "sources":[
      {
        "id":"1",
        "name":"Easy Eats",
        "price":"18500",
        "visible":"1"
      },
      {
        "id":"2",
        "name":"Sonic Eats",
        "price":"20500",
        "visible":"1"
      }
    ],
    "ingredient_id":"10",
    "cooking_time": "1201",
    "fiscal_code": "1234567890",
    "out":"0"
  }
}

```

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

### POS Platform Integration Setup

Source: https://dev.joinposter.com/docs/v3/start/faq_id=_14-%D0%A1%D0%BA%D0%BE%D0%BB%D1%8C%D0%BA%D0%BE-%D0%B2%D1%80%D0%B5%D0%BC%D0%B5%D0%BD%D0%B8-%D0%B2%D0%B0%D0%BB%D0%B8%D0%B4%D0%B5%D0%BD-%D1%82%D0%BE%D0%BA%D0%B5%D0%BD

Integrate your application into a Poster account via the 'Poster App Catalog' after enabling the POS platform features and whitelisting the account.

```APIDOC
## POS Platform Integration

### Description
Connecting your application to a Poster account for POS platform functionality.

### Integration Method
Connect your integration through the **Poster App Catalog** within the Poster account.
```

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

### Create Employee Request Examples (JavaScript, PHP)

Source: https://dev.joinposter.com/docs/v3/web/access/createEmployee_id=http-post-%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81

Demonstrates how to create a new employee using the access.createEmployee API endpoint in JavaScript and PHP. It includes sample request data and the API endpoint URL with a token.

```javascript
const url = 'https://joinposter.com/api/access.createEmployee ?token=687409:4164553abf6a031302898da7800b59fb';

const employee = {
  name: 'Олена Гончаренко',
  user_type: 2,
  pos_pass: '',
  login: 'heleh.gonchar@test.com',
  pass: 'aZntaeVP9h',
};
```

```php
<?php
$url = 'https://joinposter.com/api/access.createEmployee' \
  . '?token=687409:4164553abf6a031302898da7800b59fb';

$employee = [
    'name'      => 'Елена Гончаренко',
    'user_type' => 2,
    'pos_pass'  => '',
    'login'     => 'heleh.gonchar@test.com',
    'pass'      => 'aZntaeVP9h',
];

$data = sendRequest($url, 'post', $employee);
?>
```

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

### Get Warehouse Properties (PHP)

Source: https://dev.joinposter.com/docs/v3/web/storage/getStorage

Example of how to fetch warehouse properties using the Poster API. It demonstrates constructing the GET request URL with necessary parameters like token and storage_id, and includes a placeholder for sending the request.

```php
<?php
$url = 'https://joinposter.com/api/storage.getStorage'
 . '?token=687409:4164553abf6a031302898da7800b59fb'
 . '&storage_id=1';

$data = sendRequest($url);

```

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

### Деплой приложения с помощью npm

Source: https://dev.joinposter.com/docs/v3/pos/deploy_id=%D0%94%D0%B5%D0%BF%D0%BB%D0%BE%D0%B9-%D0%BF%D1%80%D0%B8%D0%BB%D0%BE%D0%B6%D0%B5%D0%BD%D0%B8%D1%8F

Команда для деплоя приложения на POS платформе. После выполнения команды bundle приложения будет загружен на сервер и станет доступен клиентам.

```bash
npm run deploy
```

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

### Get Account Categories (PHP)

Source: https://dev.joinposter.com/docs/v3/web/finance/getCategories

Example of how to make a GET request to the finance.getCategories API endpoint using PHP to retrieve account categories. It includes a placeholder for a sendRequest function and requires a valid API token.

```php
<?php
$url = 'https://joinposter.com/api/finance.getCategories' . '?token=687409:4164553abf6a031302898da7800b59fb';

$data = sendRequest($url);
?>
```

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

### POS Platform Dev/Prod Switcher

Source: https://dev.joinposter.com/docs/v3/start/faq_id=_12-%D0%9A%D0%B0%D0%BA-%D0%B8-%D0%B3%D0%B4%D0%B5-%D1%8F-%D0%BC%D0%BE%D0%B3%D1%83-%D0%BF%D_346c1e_D0%B5%D0%BB%D1%8C%D0%BD%D0%BE%D0%B5-%D0%BF%D1%80%D0%B8%D0%BB%D0%BE%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5

Troubleshooting steps for when the Dev/Prod switcher is missing on the POS.

```APIDOC
## POS Platform Dev/Prod Switcher

### Description
Steps to resolve the issue where the Dev/Prod switcher is not visible on the POS.

### Troubleshooting Steps:
1.  **Enable POS Platform:** Ensure the **POS Platform** switch is enabled in your application's settings.
2.  **Add Developer Account:** In your developer account, add the Poster account (where the POS is located) to the list of developers who are not seeing the Dev/Prod switcher.
3.  **Connect Integration:** Connect your integration within the Poster account via the **Poster App Marketplace**.

### Method
N/A (Informational)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
None
```

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

### Get All Storages (PHP Example)

Source: https://dev.joinposter.com/docs/v3/web/storage/getStorages_id=storagegetstorages-%D0%9F%D0%BE%D0%BB%D1%83%D1%87%D0%B8%D1%82%D1%8C-%D0%B2%D1%81%D0%B5-%D1%81%D0%BA%D0%BB%D0%B0%D0%B4%D1%8B

Example of how to make an HTTP GET request to the storage.getStorages endpoint using PHP to retrieve all available storage locations. This code demonstrates constructing the URL with an API token and sending the request.

```php
<?php
$url = 'https://joinposter.com/api/storage.getStorages'
 . '?token=687409:4164553abf6a031302898da7800b59fb';

$data = sendRequest($url);

```

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

### Poster Development Mode Setup

Source: https://dev.joinposter.com/docs/v3/pos/debug_id=%D0%9E%D1%82%D0%BB%D0%B0%D0%B4%D0%BA%D0%B0-%D0%BF%D1%80%D0%B8%D0%BB%D0%BE%D0%B6%D0%B5%D0%BD%D0%B8%D1%8F

Enables development mode for an application within the Poster platform, allowing it to load from a local development server. This facilitates faster iteration during development.

```text
1. In your developer account on the **Development** page, add the account you are testing the application on.
2. Go to the **Applications → All Applications** tab in this account. Find your integration in the list and click **Connect**.
3. In the top right corner of the cash register, click on **< />**, this will open the platform settings window.
4. In the platform settings window, switch the application to **Development** mode.
```

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

### JSON: Example Response for menu.getProduct (Recipe/Tech Card)

Source: https://dev.joinposter.com/docs/v3/web/menu/getProduct

An example JSON response for the menu.getProduct API call when requesting recipe or technical card properties. Includes ingredients, cooking times, and cost details.

```json
{
  "response":{
    "barcode":"123456",
    "category_name":"Коктейли",
    "unit":"kg",
    "cost":"444",
    "cost_netto":"370",
    "fiscal":"0",
    "menu_category_id":"39",
    "workshop":"1",
    "nodiscount":"0",
    "photo":"/upload/pos_cdb_4/menu/product_1439375876_175.jpg",
    "product_code":"",
    "product_id":"175",
    "product_name":"Manhattan Jack",
    "sort_order":"999",
    "tax_id":"0",
    "product_tax_id":"0",
    "type":"2",
    "weight_flag":"0",
    "color":"white",
    "spots":[
      {
        "spot_id":"1",
        "price":"60000",
        "profit":"59556",
        "profit_netto":"49630",
        "visible":"1"
      },
      {
        "spot_id":"2",
        "price":"60000",
        "profit":"59556",
        "profit_netto":"49630",
        "visible":"1"
      }
    ],
    "sources":[
      {
        "id":"1",
        "name":"Easy Eats",
        "price":"18500",
        "visible":"1"
      },
      {
        "id":"2",
        "name":"Sonic Eats",
        "price":"20500",
        "visible":"1"
      }
    ],
    "ingredient_id":"0",
    "fiscal_code": "1234567890",
    "out":97,
    "product_production_description":"",
    "ingredients":[
      {
        "structure_id":"52",
        "ingredient_id":"92",
        "pr_in_clear":"0",
        "pr_in_cook":"0",
        "pr_in_fry":"0",
        "pr_in_stew":"0",
        "pr_in_bake":"0",
        "structure_unit":"l",
        "structure_type":"1",
        "structure_brutto":30,
        "structure_netto":30,
        "structure_lock":"1",
        "structure_selfprice":"102",
        "structure_selfprice_netto":"85",
        "ingredient_name":"Красный вермут",
        "ingredient_unit":"l",
        "ingredient_weight":"0",
        "ingredients_losses_clear":"0",
        "ingredients_losses_cook":"0",
        "ingredients_losses_fry":"0",
        "ingredients_losses_stew":"0",
        "ingredients_losses_bake":"0"
      },
      {
        "structure_id":"53",
        "ingredient_id":"91",
        "pr_in_clear":"0",
        "pr_in_cook":"0",
        "pr_in_fry":"0",
        "pr_in_stew":"0",
        "pr_in_bake":"0",
        "structure_unit":"l",
        "structure_type":"1",
        "structure_brutto":60,
        "structure_netto":60,
        "structure_lock":"1",
        "structure_selfprice":"313",
        "structure_selfprice_netto":"261",
        "ingredient_name":"Jack Daniels",
        "ingredient_unit":"l",
        "ingredient_weight":"0",
        "ingredients_losses_clear":"0",
        "ingredients_losses_cook":"0",
        "ingredients_losses_fry":"0",
        "ingredients_losses_stew":"0",
        "ingredients_losses_bake":"0"
      }
    ]
  }
}

```

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

### POS Platform Integration

Source: https://dev.joinposter.com/docs/v3/start/faq_id=_23-%D0%9F%D0%BE%D1%87%D0%B5%D0%BC%D1%83-%D1%83-%D0%BC%D0%B5%D0%BD%D1%8F-%D0%BD%D0%B0-%D0_52eb9d_%B5%D1%82-%D0%BF%D0%B5%D1%80%D0%B5%D0%BA%D0%BB%D1%8E%D1%87%D0%B0%D1%82%D0%B5%D0%BB%D1%8F-devprod

Details on enabling and utilizing the POS platform features, including developer account setup and application integration.

```APIDOC
## Why don't I have a Dev/Prod switch on my cash register?
1. Enable the **POS platform** switch in your application settings.
2. In your developer account, add the Poster account to the list of developers for which you don't see the Dev/Prod switch on the cash register.
3. Connect your integration in the Poster account through the **Poster App Catalog**.
```

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

### POS Platform Dev/Prod Switcher

Source: https://dev.joinposter.com/docs/v3/start/faq_id=_13-%D0%9A%D0%B0%D0%BA-%D0%BD%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B8%D1%82%D1%8C-oauth-%D0%B0%D0%B2%D1%82%D0%BE%D1%80%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8E

Guidance on enabling the Dev/Prod switcher for the POS platform.

```APIDOC
## POS Platform Dev/Prod Switcher

### Description
To enable the Dev/Prod switcher on your POS, follow these steps:
1. Enable the **POS platform** switch in your application's settings.
2. In your developer account, add the Poster account where you are not seeing the Dev/Prod switcher to the list of developers.
3. Connect your integration in the Poster account via the **Poster App Catalog**.

### Method
N/A

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
None
```

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

### Poster API: Get Ingredients Response Example (JSON)

Source: https://dev.joinposter.com/docs/v3/web/menu/getIngredients

Provides an example of the JSON response received when calling the menu.getIngredients API method. It outlines the structure of the ingredient data, including IDs, names, stock levels, and units.

```json
{
  "response":[
    {
      "ingredient_id":"91",
      "ingredient_name":"Jack Daniels",
      "ingredient_barcode": "",
      "category_id":"3",
      "ingredient_left":"443.45000",
      "limit_value":"0",
      "time_notif":"0",
      "ingredient_unit":"l",
      "ingredient_weight":0,
      "ingredients_losses_clear":"0",
      "ingredients_losses_cook":"0",
      "ingredients_losses_fry":"0",
      "ingredients_losses_stew":"0",
      "ingredients_losses_bake":"0",
      "ingredients_type":"1",
      "partial_write_off":"0"
    },
    {
      "ingredient_id":"73",
      "ingredient_name":"Авокадо",
      "ingredient_barcode": "",
      "category_id":"0",
      "ingredient_left":"22.00000",
      "limit_value":"0",
      "time_notif":"0",
      "ingredient_unit":"kg",
      "ingredient_weight":0,
      "ingredients_losses_clear":"11",
      "ingredients_losses_cook":"0",
      "ingredients_losses_fry":"0",
      "ingredients_losses_stew":"0",
      "ingredients_losses_bake":"0",
      "ingredients_type":"1",
      "partial_write_off":"0"
    },
    {
      "ingredient_id":"74",
      "ingredient_name":"Айсберг с-т",
      "ingredient_barcode": "",
      "category_id":"0",
      "ingredient_left":"379.09000",
      "limit_value":"0",
      "time_notif":"0",
      "ingredient_unit":"kg",
      "ingredient_weight":0,
      "ingredients_losses_clear":"10",
      "ingredients_losses_cook":"0",
      "ingredients_losses_fry":"0",
      "ingredients_losses_stew":"0",
      "ingredients_losses_bake":"0",
      "ingredients_type":"1",
      "partial_write_off":"0"
    }
  ]
}
```

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

### OAuth Authorization

Source: https://dev.joinposter.com/docs/v3/start/faq_id=_14-%D0%A1%D0%BA%D0%BE%D0%BB%D1%8C%D0%BA%D0%BE-%D0%B2%D1%80%D0%B5%D0%BC%D0%B5%D0%BD%D0%B8-%D0%B2%D0%B0%D0%BB%D0%B8%D0%B4%D0%B5%D0%BD-%D1%82%D0%BE%D0%BA%D0%B5%D0%BD

Detailed instructions and a webinar are available for setting up OAuth authorization to obtain tokens from multiple clients.

```APIDOC
## OAuth Authorization Setup

### Description
Guide to setting up OAuth authorization for obtaining tokens from multiple clients.

### Method
N/A (Refer to external resources)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

### Additional Information
Refer to the provided webinar and detailed text instructions for setup.
```

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

### Get Clients List (PHP)

Source: https://dev.joinposter.com/docs/v3/web/clients/getClients

Example of how to fetch a list of clients using the Poster API in PHP. It constructs the URL with necessary parameters like token, num, and offset, and uses a sendRequest function to get the data.

```php
<?php
$url = 'https://joinposter.com/api/clients.getClients' \
  . '?token=687409:4164553abf6a031302898da7800b59fb' \
  . '&num=100' \
  . '&offset=0';

$data = sendRequest($url);
```

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

### Poster API Request: Get Supply Details (PHP)

Source: https://dev.joinposter.com/docs/v3/web/storage/getSupply

Example of an HTTP GET request to the Poster API to retrieve the details of a specific supply using the storage.getSupply method. It demonstrates how to construct the URL with the API token and supply ID.

```php
<?php
$url = 'https://joinposter.com/api/storage.getSupply'
 . '?token=687409:4164553abf6a031302898da7800b59fb'
 . '&supply_id=46';

$data = sendRequest($url);

```

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

### Website Integration (Tilda, OpenCart, Wix, WordPress, uKit, Custom)

Source: https://dev.joinposter.com/docs/v3/start/faq_id=_19-%D0%9C%D0%BE%D0%B6%D0%BD%D0%BE-%D0%BF%D0%BE-api-%D0%BF%D0%B5%D1%80%D0%B5%D0%B4%D0%B0%_556b66_0%B0%D1%80%D1%82%D1%8B-%D0%B8%D0%BB%D0%B8-%D0%BA%D0%B0%D1%82%D0%B5%D0%B3%D0%BE%D1%80%D0%B8%D0%B8

Information on integrating websites with Poster, including options for CMS platforms and custom sites.

```APIDOC
## Website Integration

### Description
Integrate your website (built on Tilda, OpenCart, Wix, WordPress, uKit, or custom-built) with Poster to receive online orders directly into your Poster account. You can either hire a third-party developer or use existing solutions.

### Integration Options
- **Third-party Developer:** Seek assistance from a third-party developer. Poster provides documentation for integrating online stores.
- **WordPress + WooCommerce:** A pre-built integration application is available in the Poster App Catalog.
```

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

### Get Order Sources (PHP)

Source: https://dev.joinposter.com/docs/v3/web/settings/getOrderSources_id=http-get-%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81

Example of how to retrieve order source properties using PHP by making an HTTP GET request to the Poster API.

```php
<?php
$url = 'https://joinposter.com/api/settings.getOrderSources' \
 . '?token=687409:4164553abf6a031302898da7800b59fb';

$data = sendRequest($url);

```

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

### OAuth Authorization

Source: https://dev.joinposter.com/docs/v3/start/faq_id=_4-%D0%9C%D0%BE%D0%B6%D0%BD%D0%BE-%D0%BB%D0%B8-%D0%BF%D1%80%D0%B8-%D0%BF%D0%BE%D0%BC%D0%B_20d243_%D0%B2%D0%BE%D0%B9-%D1%84%D1%83%D0%BD%D0%BA%D1%86%D0%B8%D0%BE%D0%BD%D0%B0%D0%BB-%D0%B2-poster-qr

Information on setting up OAuth authorization for obtaining tokens from multiple clients. Refer to the webinar and detailed text instructions for guidance.

```APIDOC
## OAuth Authorization Setup

### Description
Instructions for configuring OAuth authorization to obtain tokens for multiple clients.

### Method
GET

### Endpoint
/api/oauth/authorize

### Parameters
#### Query Parameters
- **client_id** (string) - Required - Your application's client ID.
- **redirect_uri** (string) - Required - The URL to redirect the user to after authorization.
- **response_type** (string) - Required - Should be 'code'.
- **scope** (string) - Optional - The scope of the access request.

### Response
#### Success Response (302)
Redirects the user to the authorization page.

#### Response Example
Redirect to: `https://joinposter.com/oauth/authorize?client_id=YOUR_CLIENT_ID&redirect_uri=YOUR_REDIRECT_URI&response_type=code`
```

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

### POST /menu/createProduct

Source: https://dev.joinposter.com/docs/v3/web/menu/createProduct_id=%D0%9F%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D1%8B-%D0%BE%D1%82%D0%B2%D0%B5_0e2706_ateproduct-%D0%B1%D0%B5%D0%B7-%D0%BC%D0%BE%D0%B4%D0%B8%D1%84%D0%B8%D0%BA%D0%B0%D1%86%D0%B8%D0%B9

Creates a new product. Supports single products or products with modifications, different prices per location, and fiscal codes.

```APIDOC
## POST /menu/createProduct

### Description
Creates a new product in the menu. This endpoint can handle products with or without modifications, and allows for setting different prices and visibility settings for various locations. It also supports product-specific fiscal codes for Ukrainian accounts.

### Method
POST

### Endpoint
/websites/dev_joinposter_v3/menu/createProduct

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **product_name** (string) - Required - Name of the product.
- **menu_category_id** (integer) - Optional - ID of the menu category. If 0, the product will be placed on the 'Main Screen'.
- **workshop** (integer) - Required for 'cafe' accounts - ID of the workshop.
- **weight_flag** (integer) - Required - Flag indicating if the product is sold by piece or by weight: 0 for piece, 1 for weight.
- **color** (string) - Optional - Color of the product card (e.g., 'white', 'red', 'blue'). Defaults to 'white'.
- **different_spots_prices** (integer) - Optional - Flag indicating if the product has different prices in different locations: 0 for same prices, 1 for different prices.
- **modifications** (integer) - Optional - Flag indicating if the product has modifications: 0 for no modifications, 1 for modifications.
- **modificator_name[index]** (string) - Required if `modifications` is 1 - Name of the modifier. Use square brackets for index (e.g., `modificator_name[0]`).
- **barcode** (string) - Optional - Barcode for the product. Recommended 13 digits for piece goods, 7 digits for weighted goods. If modifications exist, use `barcode[index]`.
- **product_code** (string) - Optional - Article number of the product. Used for 'store' accounts. If modifications exist, use `product_code[index]`.
- **cost** (integer) - Optional - Initial cost of the product in kopecks. If modifications exist, use `cost[index]`.
- **price** (integer) - Required - Price of the product in kopecks. If `different_spots_prices` is 1, use nested arrays: `price[index]` for no modifications, `price[modifier_index][location_id]` for modifications.
- **visible** (integer) - Optional - Flag indicating if the product is visible in a location: 0 for not visible, 1 for visible. Used only if `different_spots_prices` is 1. Structure mirrors `price`: `visible[location_id]` or `visible[modifier_index][location_id]`.
- **fiscal_code** (string) - Optional - Fiscal code (UKTZED). Available for Ukrainian accounts with fiscalization enabled.

### Request Example
```json
{
  "product_name": "Burger",
  "menu_category_id": 5,
  "workshop": 10,
  "weight_flag": 0,
  "price": 50000,
  "modifications": 1,
  "modificator_name[0]": "Cheese",
  "price[0]": 55000
}
```

### Response
#### Success Response (200)
- **product_id** (integer) - ID of the created product.
- **modifications_id** (array of integers) - Array of IDs for created modifications (if applicable).

#### Response Example
```json
{
  "product_id": 12345,
  "modifications_id": [54321, 54322]
}
```
```