RO App Public API

https://roapp.readme.io/
Admin
The RO App Public API provides a secure and reliable RESTful interface to programmatically interact...
Tokens:136,145
Snippets:380
Trust Score:9.9
Update:8 months ago
Show doc for...
Tokens:
Raw
### RO App Public API - Getting Started

Source: https://roapp.readme.io/index

Information on the base URL, rate limits, pagination, and authentication for the RO App Public API.

```APIDOC
## RO App Public API Overview

### Description
This section covers the fundamental aspects of using the RO App Public API, including the base URL, request limitations, data retrieval methods, and authentication procedures.

### Base URL
`https://api.roapp.io`

### Rate Limits
- **Requests per second**: 3
- **Error on exceed**: `429 Too Many Requests`

### Pagination
- **Parameter**: `page=N` (where N is the page number)
- **Entries per page**: Up to 50
- **Total values indicator**: `count` parameter

### Authentication
- **Method**: Bearer Token
- **Header**: `Authorization: Bearer YOUR_API_KEY`
- **API Key Location**: RO App account under "Settings > API"
- **Error on invalid token**: `401 Unauthorized`
```

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

### GET /tasks

Source: https://roapp.readme.io/index

Retrieve a list of tasks from your RO App account.

```APIDOC
## GET /tasks

### Description
This endpoint allows you to retrieve a list of all tasks associated with your RO App account. Pagination is supported.

### Method
`GET`

### Endpoint
`/tasks`

### Query Parameters
- **page** (integer) - Optional - The page number to retrieve. Defaults to the first page if not specified.

### Request Example
```http
GET /tasks HTTP/1.1
Host: api.roapp.io
Authorization: Bearer YOUR_API_KEY
```

### Response
#### Success Response (200)
- **tasks** (array) - A list of task objects.
  - **id** (string) - The unique identifier for the task.
  - **title** (string) - The title of the task.
  - **status** (string) - The current status of the task (e.g., 'open', 'completed').
  - **createdAt** (string) - The timestamp when the task was created.
  - **updatedAt** (string) - The timestamp when the task was last updated.

#### Response Example
```json
{
  "tasks": [
    {
      "id": "task_123",
      "title": "Complete project proposal",
      "status": "open",
      "createdAt": "2023-10-27T10:00:00Z",
      "updatedAt": "2023-10-27T10:00:00Z"
    }
  ],
  "count": 1
}
```

#### Error Response (401)
- **message** (string) - "Unauthorized: Invalid API Key."
```

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

### RO App Public API - Get Tasks Example

Source: https://roapp.readme.io/reference/getting-started-with-api

This section demonstrates how to retrieve a list of tasks using the RO App API. It includes examples for HTTP requests and client-side implementations in Python, PHP, Kotlin, and Java.

```APIDOC
## GET /tasks

### Description
Retrieves a list of tasks associated with the RO App account.

### Method
GET

### Endpoint
https://api.roapp.io/tasks

### Parameters

#### Query Parameters
- **page** (integer) - Optional - The page number for pagination. Defaults to 1.

### Request Example
```http
GET /tasks HTTP/1.1
Host: api.roapp.io
Authorization: Bearer YOUR_API_KEY
```

### Response
#### Success Response (200)
- **tasks** (array) - A list of task objects.
  - **taskId** (string) - The unique identifier for the task.
  - **title** (string) - The title of the task.
  - **status** (string) - The current status of the task.
  - **dueDate** (string) - The due date of the task (ISO 8601 format).

#### Response Example
```json
{
  "tasks": [
    {
      "taskId": "task_123",
      "title": "Complete Report",
      "status": "In Progress",
      "dueDate": "2023-10-27T10:00:00Z"
    }
  ],
  "pagination": {
    "currentPage": 1,
    "totalPages": 5,
    "totalCount": 250
  }
}
```

### Error Handling
- **401 Unauthorized**: If the API key is missing or invalid.
- **429 Too Many Requests**: If the rate limit is exceeded.
```

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

### Retrieve Tasks using RO App API (HTTP, Python, PHP, Kotlin, Java)

Source: https://roapp.readme.io/index

Demonstrates how to retrieve a list of tasks from the RO App API using various programming languages. It includes setting up the request with the correct headers and handling the response. Ensure you have a valid API key and the necessary libraries installed for each language.

```http
GET /tasks HTTP/1.1
Host: api.roapp.io
Authorization: Bearer 946389976c464478beb0cf7a7b5b01bb

```

```python
import requests

API_KEY = "946389976c464478beb0cf7a7b5b01bb"
url = "https://api.roapp.io/tasks"
headers = {
    "Authorization": f"Bearer {API_KEY}"
}

response = requests.get(url, headers=headers)
print(response.status_code)
print(response.json())

```

```php
<?php
$apiKey = "946389976c464478beb0cf7a7b5b01bb";

$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => "https://api.roapp.io/tasks",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer $apiKey"
    ]
]);

$response = curl_exec($curl);
$httpCode = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

echo "HTTP Status: $httpCode\n";
echo "Response: $response\n";
?>

```

```kotlin
import okhttp3.OkHttpClient
import okhttp3.Request

const val API_KEY = "946389976c464478beb0cf7a7b5b01bb"

fun main() {
    val client = OkHttpClient()

    val request = Request.Builder()
        .url("https://api.roapp.io/tasks")
        .addHeader("Authorization", "Bearer $API_KEY")
        .build()

    val response = client.newCall(request).execute()
    println("HTTP Status: ${response.code}")
    println("Response: ${response.body?.string()}")
}

```

```java
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;

public class Main {
    private static final String API_KEY = "946389976c464478beb0cf7a7b5b01bb";

    public static void main(String[] args) throws Exception {
        URL url = new URL("https://api.roapp.io/tasks");
        HttpURLConnection conn = (HttpURLConnection) url.openConnection();
        conn.setRequestMethod("GET");
        conn.setRequestProperty("Authorization", "Bearer " + API_KEY);

        int status = conn.getResponseCode();
        BufferedReader in = new BufferedReader(new InputStreamReader(conn.getInputStream()));
        String inputLine;
        StringBuilder content = new StringBuilder();

        while ((inputLine = in.readLine()) != null) {
            content.append(inputLine);
        }

        in.close();
        conn.disconnect();

        System.out.println("HTTP Status: " + status);
        System.out.println("Response: " + content.toString());
    }
}

```

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

### RO App API Reference v1.3

Source: https://roapp.readme.io/reference

This section outlines the RO App Public API, including its base URL, authentication methods, rate limits, and pagination details. It also provides an example of how to retrieve a list of tasks.

```APIDOC
## RO App Public API Overview

### Description
This API allows you to programmatically interact with your RO App account to manage data such as tasks, clients, orders, inventory, and more. It provides a secure and reliable RESTful interface for integration and automation.

### Base URL
```
https://api.roapp.io
```

### Rate Limits
- **Requests per second**: 3
- **Error on exceed**: `429 Too Many Requests`

### Pagination
- **Parameter**: `page=N` (where N is the page number)
- **Entries per page**: Up to 50
- **Total values**: `count` parameter

### Authentication
- **Method**: Bearer Token
- **Header**: `Authorization: Bearer YOUR_API_KEY`
- **API Key Location**: RO App account under "Settings > API"

### Error Handling
- **Unauthorized Access**: `401 Unauthorized` for requests without a valid token.
- **Compromised Token**: Regenerate token on "Settings > API" page.
```

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

### Get People API Request Examples

Source: https://roapp.readme.io/reference/contacts

Examples of how to make a GET request to the 'Get People' endpoint using various programming languages. These snippets demonstrate how to construct the request URL and include necessary headers.

```shell
curl --request GET \
     --url https://api.roapp.io/contacts/people \
     --header 'accept: application/json'
```

```node
const axios = require('axios');

const options = {
  method: 'GET',
  url: 'https://api.roapp.io/contacts/people',
  headers: {
    'accept': 'application/json'
  }
};

axios.request(options).then(function (response) {
  console.log(response.data);
}).catch(function (error) {
  console.error(error);
});
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.roapp.io/contacts/people")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"

response = http.request(request)
puts response.read_body
```

```php
<?php

$curl = curl_init();

curl_setopt($curl, CURLOPT_URL, 'https://api.roapp.io/contacts/people');
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');

$headers = [
  'accept: application/json'
];

curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($curl);
$err = curl_error($curl);

cost = curl_errno($curl);
curl_close($curl);

if ($err) {
  echo "cURL Error #" . $err;
} else {
  echo $response;
}

?>
```

```python
import requests

url = "https://api.roapp.io/contacts/people"

headers = {
    "accept": "application/json"
}

response = requests.get(url, headers=headers)

print(response.text)
```

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

### Get Bookings with Ruby

Source: https://roapp.readme.io/reference/bookings

Example of how to fetch bookings using Ruby. This snippet shows how to make an HTTP GET request to the Roapp bookings API using the Net::HTTP library.

```ruby
# Example for Ruby
require 'net/http'
require 'uri'
require 'json'

uri = URI.parse('https://api.roapp.io/bookings')

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true # Use SSL

request = Net::HTTP::Get.new(uri.request_uri)
request['accept'] = 'application/json'
# Add authorization headers if required, e.g., request['Authorization'] = 'Bearer YOUR_ACCESS_TOKEN'

response = http.request(request)

if response.code == '200'
  bookings = JSON.parse(response.body)
  puts bookings
else
  puts "Error: #{response.code} - #{response.message}"
end
```

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

### Get Products API Request (Node.js)

Source: https://roapp.readme.io/reference/products

Example of how to retrieve product information using Node.js. This code snippet would typically involve an HTTP client library to make the GET request.

```javascript
// Node.js example would go here, likely using 'axios' or 'node-fetch'
// Example: 
// const axios = require('axios');
// axios.get('https://api.roapp.io/products/', { headers: { 'accept': 'application/json' } })
//   .then(response => console.log(response.data))
//   .catch(error => console.error(error));
```

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

### Get Bookings with Node.js

Source: https://roapp.readme.io/reference/bookings

Example of how to fetch bookings using Node.js. This snippet demonstrates making a GET request to the Roapp bookings API and handling the JSON response.

```javascript
// Example for Node.js (using fetch API or a library like axios)
// const fetch = require('node-fetch'); // if using node-fetch

async function getBookings() {
  const url = 'https://api.roapp.io/bookings';
  const headers = {
    'accept': 'application/json',
    // Add authorization headers if required, e.g., 'Authorization': 'Bearer YOUR_ACCESS_TOKEN'
  };

  try {
    const response = await fetch(url, {
      method: 'GET',
      headers: headers
    });

    if (!response.ok) {
      throw new Error(`HTTP error! status: ${response.status}`);
    }

    const data = await response.json();
    console.log(data);
    return data;
  } catch (error) {
    console.error('Error fetching bookings:', error);
  }
}

getBookings();
```

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

### Product with Image and Custom Fields Example

Source: https://roapp.readme.io/reference/get-stock

This example demonstrates a product entry that includes an 'image' field containing URLs and a 'custom_fields' object for additional attributes. It also shows a 'residue' (stock) value and warranty information.

```json
{
      "id": 38526459,
      "code": "",
      "title": "Apple iPhone 12 mini",
      "uom": {
        "id": 1,
        "description": "Pieces",
        "title": "pcs"
      },
      "image": [
        "https://storage.remonline.app/media/company-assets/115231/warehouse-product/44c618784d1d41088f3a23d3b7c1137a_hd.jpg",
        "https://storage.remonline.app/media/company-assets/115231/warehouse-product/f47fb4af23804ef592f8211b3e48e48f_hd.jpg",
        "https://storage.remonline.app/media/company-assets/115231/warehouse-product/978f8bc7d4e34d298d87e0b3c1481b2e_hd.jpg",
        "https://storage.remonline.app/media/company-assets/115231/warehouse-product/6843928151d64bdf82a9b2d47848a740_hd.jpg"
      ],
      "price": {
        "306643": 600,
        "306644": 450,
        "386118": 0,
        "386993": 600,
        "386994": 345,
        "387005": 420,
        "387006": 450,
        "391817": 480
      },
      "article": "MW121212",
      "residue": 31,
      "category": {
        "id": 910696,
        "title": "Phones",
        "parent_id": 910695
      },
      "description": "Apple iPhone 12 mini",
      "custom_fields": {
        "f7747626": ""
      },
      "barcodes": [
        {
          "code": "2100000001743",
          "type": "ean13"
        }
      ],
      "is_serial": true,
      "warranty": 12,
      "warranty_period": 1
    }
```

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

### Get Assets API Request (Node.js)

Source: https://roapp.readme.io/reference/assets

Example Node.js code to make a GET request to the roapp.io 'Get Assets' API. This snippet demonstrates how to construct the request and handle the response, assuming necessary libraries are installed.

```javascript
const axios = require('axios');

const options = {
  method: 'GET',
  url: 'https://api.roapp.io/warehouse/assets',
  headers: {
    'accept': 'application/json'
  }
};

axios.request(options).then(function (response) {
  console.log(response.data);
}).catch(function (error) {
  console.error(error);
});
```

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

### POST /bookings

Source: https://roapp.readme.io/reference/create-booking

Creates a new booking with the specified details. Requires branch, assignee, client, and scheduled times.

```APIDOC
## POST /bookings

### Description
Create a new booking.

### Method
POST

### Endpoint
https://api.roapp.io/bookings

### Parameters
#### Request Body
- **branch_id** (integer) - Required - Location ID
- **assignee_id** (integer) - Required - Assigned Employee ID
- **client_id** (integer) - Required - Client (Person / Organization) ID
- **scheduled_for** (string) - Required - "Scheduled From" date and time (ISO 8601)
- **scheduled_to** (string) - Required - "Scheduled To" date and time (ISO 8601)
- **resource_id** (integer) - Optional - Resource ID
- **comment** (string) - Optional - Comment text

### Request Example
```json
{
  "branch_id": 1,
  "assignee_id": 10,
  "client_id": 100,
  "scheduled_for": "2024-01-01T10:00:00Z",
  "scheduled_to": "2024-01-01T11:00:00Z",
  "resource_id": 5,
  "comment": "Please prepare the room."
}
```

### Response
#### Success Response (200)
- **(empty object)** - Description is empty in the OpenAPI spec.

#### Response Example
```json
{
  "booking_id": 12345
}
```
```

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

### POST /lead/

Source: https://roapp.readme.io/reference/create-lead

Creates a new inquiry. Requires either `client_id` or a combination of `contact_phone` and `contact_name`. Also requires `leadtype_id`.

```APIDOC
## POST /lead/

### Description
Creates a new inquiry. Requires either `client_id` or a combination of `contact_phone` and `contact_name`. Also requires `leadtype_id`.

### Method
POST

### Endpoint
https://api.roapp.io/lead/

### Parameters
#### Request Body
- **client_id** (integer) - Optional - Client ID
- **contact_phone** (string) - Optional - Inquiry contact number must be set with `contact_name` if `client_id` is absent
- **contact_name** (string) - Optional - Inquiry contact name
- **leadtype_id** (integer) - Required - Inquiry type ID
- **is_juridical** (boolean) - Optional - Does a inquiry contact is a legal entity
- **branch_id** (integer) - Optional - Location ID
- **manager_id** (integer) - Optional - Responsible manager ID
- **description** (string) - Optional - Inquiry description
- **ad_campaign_id** (integer) - Optional - Advertising campaign ID
- **is_urgent** (boolean) - Optional - If this Inquiry is urgent
- **custom_fields** (string) - Optional - pairs id: value (format: json)

### Request Example
```json
{
  "client_id": 123,
  "leadtype_id": 1,
  "description": "New potential client inquiry"
}
```

### Response
#### Success Response (200)
- **data** (object) - Contains the ID of the created inquiry.
  - **id** (integer) - The ID of the newly created inquiry.
- **success** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "data": {
    "id": 75
  },
  "success": true
}
```
```

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

### Get Customer Reviews API Request (Python)

Source: https://roapp.readme.io/reference/marketing

This snippet shows how to get customer reviews using Python's 'requests' library. It makes a GET request to the API endpoint and prints the JSON response. You'll need to install the 'requests' library (`pip install requests`).

```python
import requests

url = 'https://api.roapp.io/marketing/reviews'
headers = {
    'accept': 'application/json'
}

response = requests.get(url, headers=headers)

if response.status_code == 200:
    print(response.json())
else:
    print(f"Error: {response.status_code}")
```

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

### Product Data Structure Example (JSON)

Source: https://roapp.readme.io/reference/get-postings

This JSON snippet illustrates the structure of product data as returned by the Roapp API. It includes details like product ID, title, unit of measure, amount, and price. Note that 'code' and 'article' fields are often empty.

```json
{
  "id": 13543062,
  "title": "Spark Plug",
  "uom": {
    "id": 1,
    "description": "Pieces",
    "title": "pcs"
  },
  "code": "",
  "article": "",
  "amount": 10,
  "price": 6,
  "is_serial": false,
  "sernums": []
}
```

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

### Get Customer Reviews API Request (Node.js)

Source: https://roapp.readme.io/reference/marketing

This snippet shows how to fetch customer reviews using Node.js. It utilizes the 'node-fetch' library to make a GET request to the API endpoint. Ensure you have 'node-fetch' installed (`npm install node-fetch`).

```javascript
import fetch from 'node-fetch';

const url = 'https://api.roapp.io/marketing/reviews';

fetch(url, {
  method: 'GET',
  headers: {
    'accept': 'application/json'
  }
})
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error));
```

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

### Product Data Structure Example (JSON)

Source: https://roapp.readme.io/reference/get-products

This snippet illustrates the structure of product data as returned by the Roapp API. It includes details such as product ID, code, title, barcode information, category, pricing, and physical dimensions. The structure is designed to be comprehensive for inventory and sales management.

```json
{
  "id": 38526438,
  "code": "",
  "title": "3/4\" GF 15/26 Iron Pump Flange Pair (NPT)",
  "is_serial": false,
  "article": "519601",
  "description": "Grundfos",
  "is_enable_expiration_tracking": false,
  "barcodes": [
    {
      "id": 77969548,
      "code": "2100000001187",
      "type": "ean13"
    }
  ],
  "category": {
    "id": 817091,
    "title": "Spare parts"
  },
  "images": [],
  "uom": {
    "id": 21,
    "description": "Acre",
    "title": "ac"
  },
  "warranty": 3,
  "warranty_period": 1,
  "custom_fields": {
    "f7747626": ""
  },
  "prices": {
    "306643": 10,
    "306644": 10,
    "386118": 0,
    "386993": 20,
    "386994": 12,
    "387006": 15,
    "391817": 16
  },
  "length_mm": null,
  "width_mm": null,
  "height_mm": null,
  "gross_weight_g": null,
  "dimensions_unit": null,
  "weight_unit": null,
  "is_dimensions_weight_enabled": false
}
```

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

### GET /websites/roapp_readme_io/products

Source: https://roapp.readme.io/reference/get-warehouses

Retrieves a list of products associated with the roapp_readme_io website. The response includes product details, total count, and a success status.

```APIDOC
## GET /websites/roapp_readme_io/products

### Description
Retrieves a list of products associated with the roapp_readme_io website. The response includes product details, total count, and a success status.

### Method
GET

### Endpoint
/websites/roapp_readme_io/products

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of products to return.
- **offset** (integer) - Optional - The number of products to skip before starting to collect the result set.

### Request Example
```json
{
  "limit": 10,
  "offset": 0
}
```

### Response
#### Success Response (200)
- **data** (array) - An array of product objects.
  - **id** (integer) - The unique identifier for the product.
  - **title** (string) - The name of the product.
  - **is_global** (boolean) - Indicates if the product is globally available.
  - **type** (string) - The type of the product (e.g., 'product').
- **count** (integer) - The total number of products returned.
- **success** (boolean) - Indicates if the request was successful.

#### Response Example
```json
{
  "data": [
    {
      "id": 87310,
      "title": "1111",
      "is_global": false,
      "type": "product"
    },
    {
      "id": 4790,
      "title": "MOY",
      "is_global": false,
      "type": "product"
    },
    {
      "id": 3097757,
      "title": "In facilis tempora v",
      "is_global": true,
      "type": "product"
    }
  ],
  "count": 38,
  "success": true
}
```

#### Error Response (400)
- **description**: Bad Request
- **content**: `{}`
```

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

### Get Warehouses API Request (Node.js)

Source: https://roapp.readme.io/reference/inventory

Example of making a GET request to the roapp.io 'Get Warehouses' API endpoint using Node.js. This snippet utilizes the 'axios' library for HTTP requests and expects a JSON response.

```javascript
const axios = require('axios');

const getWarehouses = async () => {
  try {
    const response = await axios.get('https://api.roapp.io/warehouse/', {
      headers: {
        'accept': 'application/json'
      }
    });
    return response.data;
  } catch (error) {
    console.error('Error fetching warehouses:', error);
    throw error;
  }
};

getWarehouses().then(data => console.log(data)).catch(err => console.error(err));
```

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

### Get Assets API Request (Ruby)

Source: https://roapp.readme.io/reference/assets

Example Ruby code for making a GET request to the roapp.io 'Get Assets' API. This snippet shows how to use the 'httparty' gem (or similar) to send the request and process the JSON response.

```ruby
require 'httparty'

response = HTTParty.get('https://api.roapp.io/warehouse/assets', headers: { 'accept' => 'application/json' })

if response.success?
  puts response.parsed_response
else
  puts "Error: #{response.code}"
end
```

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

### GET /websites/roapp_readme_io/products

Source: https://roapp.readme.io/reference/get-order-items

Retrieves a list of products associated with the roapp_readme_io project. This endpoint allows fetching product details, including their IDs, creation timestamps, quantities, prices, costs, and associated entity information.

```APIDOC
## GET /websites/roapp_readme_io/products

### Description
Retrieves a list of products associated with the roapp_readme_io project. This endpoint allows fetching product details, including their IDs, creation timestamps, quantities, prices, costs, and associated entity information.

### Method
GET

### Endpoint
/websites/roapp_readme_io/products

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of products to return.
- **offset** (integer) - Optional - The number of products to skip before starting to collect the result set.

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier for the product.
- **created_at** (string) - The timestamp when the product was created.
- **assignee_id** (integer) - The ID of the assignee associated with the product.
- **quantity** (string) - The available quantity of the product.
- **price** (string) - The selling price of the product.
- **cost** (string) - The cost price of the product.
- **entity** (object) - Detailed information about the product entity.
  - **id** (integer) - The entity ID.
  - **type** (string) - The type of entity (e.g., 'product').
  - **title** (string) - The title or name of the product.
  - **uom** (object) - Unit of measurement details.
    - **id** (integer) - The UOM ID.
    - **title** (string) - The title of the UOM (e.g., 'pcs').
  - **is_hidden** (boolean) - Indicates if the product is hidden.
- **taxes** (array) - An array of tax objects applied to the product.
  - **id** (integer) - The tax ID.
  - **name** (string) - The name of the tax.
  - **rate** (integer) - The tax rate.

#### Response Example
```json
{
  "example": [
    {
      "id": 78870627,
      "created_at": "2025-05-09T12:52:32Z",
      "assignee_id": 206039,
      "quantity": "1.000",
      "price": "20.00",
      "cost": "13.00000",
      "margin_id": 387005,
      "is_deduction_required": false,
      "entity": {
        "id": 52110296,
        "type": "product",
        "code": "",
        "sku": "",
        "sn_accounting": false,
        "title": "original Acer display-cover",
        "image": "",
        "thumbnail": "",
        "uom": {
          "id": 1,
          "title": "pcs",
          "description": "Pieces"
        },
        "is_hidden": false
      },
      "comment": "",
      "write_offs": [
        {
          "cost": 46,
          "cellId": 3679564,
          "goodId": 137183963,
          "quantity": 1,
          "sernum_id": null,
          "sernum_code": null,
          "warehouseId": 3649247,
          "repairOrderProductId": 78870630
        }
      ],
      "is_refunded": false,
      "discount": {
        "type": "value",
        "percentage": 0,
        "amount": "0.00",
        "sponsor": "staff"
      },
      "warranty": {
        "period": 0,
        "period_units": "days"
      },
      "taxes": [
        {
          "id": 5628,
          "name": "State taxes",
          "rate": 10
        }
      ],
      "expiration_date": null
    }
  ]
}
```
```

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

### Product Data Structure Example (JSON)

Source: https://roapp.readme.io/reference/get-warehouses

This snippet illustrates the JSON structure for a list of products returned by the ROapp API. It includes an array of product objects, each with an ID, title, global status, and type. The overall response also contains a count of items and a success indicator.

```json
{
  "products": [
    {
      "id": 4790,
      "title": "MOY",
      "is_global": false,
      "type": "product"
    },
    {
      "id": 3097757,
      "title": "In facilis tempora v",
      "is_global": true,
      "type": "product"
    },
    {
      "id": 1098798,
      "title": "test1",
      "is_global": true,
      "type": "product"
    },
    {
      "id": 3700615,
      "title": "Склад товаров",
      "is_global": false,
      "type": "product"
    },
    {
      "id": 3716304,
      "title": "Склад товаров",
      "is_global": false,
      "type": "product"
    },
    {
      "id": 3723813,
      "title": "Склад товаров",
      "is_global": false,
      "type": "product"
    },
    {
      "id": 387604,
      "title": "123",
      "is_global": false,
      "type": "product"
    },
    {
      "id": 1079726,
      "title": "test2",
      "is_global": true,
      "type": "product"
    },
    {
      "id": 35850,
      "title": "Основные средства",
      "is_global": true,
      "type": "product"
    }
  ],
  "count": 38,
  "success": true
}
```

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

### Get People API Request (Node.js)

Source: https://roapp.readme.io/reference/people

Example of making a GET request to the 'Get People' endpoint using Node.js. This code utilizes the 'node-fetch' library to send the request and handle the JSON response. It shows how to set the 'accept' header.

```javascript
import fetch from 'node-fetch';

const url = 'https://api.roapp.io/contacts/people';

fetch(url, {
  method: 'GET',
  headers: {
    'accept': 'application/json'
  }
})
  .then(response => {
    if (!response.ok) {
      throw new Error(`HTTP error! status: ${response.status}`);
    }
    return response.json();
  })
  .then(data => {
    console.log(data);
  })
  .catch(error => {
    console.error('Error fetching people:', error);
  });

```

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

### GET /websites/roapp_readme_io

Source: https://roapp.readme.io/reference/get-postings

Retrieves a list of documents, each containing product information. This endpoint is useful for fetching inventory data, product details, and associated metadata.

```APIDOC
## GET /websites/roapp_readme_io

### Description
Retrieves a list of documents, each containing product information. This endpoint is useful for fetching inventory data, product details, and associated metadata.

### Method
GET

### Endpoint
/websites/roapp_readme_io

### Parameters
#### Query Parameters
- **page** (integer) - Optional - The page number for pagination.
- **count** (integer) - Optional - The number of items per page.

### Request Example
```json
{
  "example": "GET /websites/roapp_readme_io?page=1&count=10"
}
```

### Response
#### Success Response (200)
- **data** (array) - An array of document objects.
  - **id** (integer) - The unique identifier for the document.
  - **id_label** (string) - A human-readable label for the document.
  - **created_at** (integer) - Timestamp of when the document was created.
  - **created_by_id** (integer) - The ID of the user who created the document.
  - **supplier_id** (integer) - The ID of the supplier associated with the document.
  - **warehouse_id** (integer) - The ID of the warehouse where the items are stored.
  - **products** (array) - An array of product objects within the document.
    - **id** (integer) - The unique identifier for the product.
    - **title** (string) - The name of the product.
    - **uom** (object) - Unit of measure details for the product.
      - **id** (integer) - The unique identifier for the unit of measure.
      - **description** (string) - A description of the unit of measure.
      - **title** (string) - A short title for the unit of measure.
    - **code** (string) - A product code, if available.
    - **article** (string) - An article number, if available.
    - **amount** (integer) - The quantity of the product.
    - **price** (integer) - The price of the product.
    - **is_serial** (boolean) - Indicates if the product is serialized.
    - **sernums** (array) - A list of serial numbers, if applicable.
  - **description** (string) - A description for the document, if any.
  - **document_number** (string) - The official document number, if applicable.
- **page** (integer) - The current page number.
- **count** (integer) - The total number of documents available.
- **success** (boolean) - Indicates if the request was successful.

#### Response Example
```json
{
  "data": [
    {
      "id": 3329731,
      "id_label": "A007",
      "created_at": 1644238592000,
      "created_by_id": 112125,
      "supplier_id": 13746109,
      "warehouse_id": 105810,
      "products": [
        {
          "id": 13543062,
          "title": "Spark Plug",
          "uom": {
            "id": 1,
            "description": "Pieces",
            "title": "pcs"
          },
          "code": "",
          "article": "",
          "amount": 10,
          "price": 6,
          "is_serial": false,
          "sernums": []
        }
      ],
      "description": "",
      "document_number": ""
    }
  ],
  "page": 1,
  "count": 7,
  "success": true
}
```
```

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

### Get Contact Tags API Request (Python)

Source: https://roapp.readme.io/reference/tags

This Python snippet shows how to retrieve contact tags using the 'requests' library. It sends a GET request to the Roapp API endpoint and prints the JSON response. Ensure the 'requests' library is installed (`pip install requests`).

```python
import requests

url = 'https://api.roapp.io/contacts/tags'
headers = {
    'accept': 'application/json'
}

try:
    response = requests.get(url, headers=headers)
    response.raise_for_status()  # Raise an exception for bad status codes
    data = response.json()
    print(data)
except requests.exceptions.RequestException as e:
    print(f"Error fetching contact tags: {e}")

```

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

### GET /marketing/reviews

Source: https://roapp.readme.io/reference/get-customer-reviews

Retrieves a list of customer reviews. Supports sorting by various fields and filtering by creation date.

```APIDOC
## GET /marketing/reviews

### Description
Retrieves a list of customer reviews. Supports sorting by various fields and filtering by creation date.

### Method
GET

### Endpoint
https://api.roapp.io/marketing/reviews

### Parameters
#### Query Parameters
- **ordering** (string) - Optional - Defines the sorting order of returned results. Use a field name to sort ascending or prefix it with a minus sign (-) to sort descending. Allowed values: `id`, `-id`.
- **created_at** (array of strings) - Optional - Filter by creation date. Accepts an array with one or two ISO 8601 date-time values. If one value is provided, it represents the start (left) boundary. If two values are provided, they define a date range (start and end). Examples: `["2025-05-01T00:00:00Z"]` — filter from May 1, 2025 onward. `["2025-05-01T00:00:00Z", "2025-05-02T00:00:00Z"]` — filter between May 1 and May 2, 2025.

### Request Example
```json
{
  "example": "GET /marketing/reviews?ordering=id&created_at=[\"2025-05-01T00:00:00Z\"]"
}
```

### Response
#### Success Response (200)
- **(object)** - Description of the response body structure is not provided in the OpenAPI definition.

#### Response Example
```json
{
  "example": "{}"
}
```

#### Error Response (400)
- **(object)** - Description of the error response body structure is not provided in the OpenAPI definition.

#### Response Example
```json
{
  "example": "{}"
}
```
```

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

### Get People API Request (cURL)

Source: https://roapp.readme.io/reference/people

This snippet demonstrates how to make a GET request to the 'Get People' endpoint using cURL. It includes the base URL and the 'accept' header for JSON responses. No specific query parameters are shown in this basic example.

```shell
curl --request GET \
     --url https://api.roapp.io/contacts/people \
     --header 'accept: application/json'
```

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

### Get Warehouses API Request (PHP)

Source: https://roapp.readme.io/reference/inventory

A PHP example for retrieving warehouse information from the roapp.io API. This snippet uses cURL to send a GET request and includes the necessary 'accept' header for JSON.

```php
<?php

$url = 'https://api.roapp.io/warehouse/';
$headers = [
    'accept: application/json'
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);

if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
} else {
    $warehouses = json_decode($response, true);
    print_r($warehouses);
}

certify_close($ch);
?>
```

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

### Product with Different Category Example

Source: https://roapp.readme.io/reference/get-stock

This snippet shows a product entry for an accessory, categorized under 'Cases' instead of 'Phones'. It includes a warranty period and a specific article number.

```json
{
      "id": 38526458,
      "code": "",
      "title": "Apple iPhone 11 Silicone Case (Pink Sand)",
      "uom": {
        "id": 1,
        "description": "Pieces",
        "title": "pcs"
      },
      "image": [],
      "price": {
        "306643": 0,
        "306644": 0,
        "386118": 0,
        "386993": 0,
        "386994": 0,
        "387005": 0,
        "387006": 0,
        "391817": 0
      },
      "article": "MTF82ZM/A",
      "residue": 0,
      "category": {
        "id": 910714,
        "title": "Cases",
        "parent_id": 910703
      },
      "description": "",
      "custom_fields": {},
      "barcodes": [
        {
          "code": "2100000000128",
          "type": "ean13"
        }
      ],
      "is_serial": false,
      "warranty": 14,
      "warranty_period": 0
    }
```

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

### Get Assets API Request (Python)

Source: https://roapp.readme.io/reference/assets

Example Python code to retrieve assets from roapp.io. This snippet uses the 'requests' library to send a GET request to the API endpoint and print the JSON response.

```python
import requests

url = "https://api.roapp.io/warehouse/assets"
headers = {
    "accept": "application/json"
}

response = requests.get(url, headers=headers)

if response.status_code == 200:
    print(response.json())
else:
    print(f"Error: {response.status_code}")
```

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

### Get Assets API Request (PHP)

Source: https://roapp.readme.io/reference/assets

Example PHP code to fetch assets using the roapp.io API. This snippet utilizes cURL functions to perform the GET request and retrieve the JSON response.

```php
<?php

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://api.roapp.io/warehouse/assets');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, array('accept: application/json'));

$response = curl_exec($ch);

if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
} else {
    echo $response;
}

curl_close($ch);
?>
```

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

### GET /websites/roapp_readme_io

Source: https://roapp.readme.io/reference/get-estimates

Retrieves a list of websites with filtering and sorting options. Supports filtering by scheduled date and time, and ordering by ID or modification date.

```APIDOC
## GET /websites/roapp_readme_io

### Description
Retrieves a list of websites with filtering and sorting options. Supports filtering by scheduled date and time, and ordering by ID or modification date.

### Method
GET

### Endpoint
/websites/roapp_readme_io

### Parameters
#### Query Parameters
- **scheduled_for** (array[string]) - Optional - Filter by "Scheduled from" date and time. Accepts an array with one or two ISO 8601 date-time values. If one value is provided, it represents the start (left) boundary. If two values are provided, they define a date range (start and end). Examples: ["2025-05-01T00:00:00Z"] — filter from May 1, 2025 onward. ["2025-05-01T00:00:00Z", "2025-05-02T00:00:00Z"] — filter between May 1 and May 2, 2025.
- **ordering** (string) - Optional - Defines the sorting order of returned results. Use a field name to sort ascending or prefix it with a minus sign (-) to sort descending. Enum: ["id", "-id", "modified_at", "-modified_at"]

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **example** (object) - Example response structure.

#### Response Example
```json
{
  "example": "{}"
}
```

#### Error Response (400)
- **example** (object) - Example error response structure.

#### Response Example
```json
{
  "example": "{}"
}
```
```

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

### Get Assets API Request (cURL)

Source: https://roapp.readme.io/reference/assets

Example cURL request to fetch a list of assets from the roapp.io warehouse. It specifies the GET method, the API endpoint URL, and the 'accept' header for JSON response.

```shell
curl --request GET \
     --url https://api.roapp.io/warehouse/assets \
     --header 'accept: application/json'
```
Tokens:
Raw