> For the complete documentation index, see [llms.txt](https://help.roolz.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.roolz.net/sistema.md).

# Система

{% content-ref url="/pages/vzfl4hFMeG1FMcIPFexH" %}
[Какие есть статусы оферты?](https://help.roolz.net/birzha-i-oferty-rynok-gruzov-i-transporta/oferty-redaktirovanie-operacii-i-statusy/kakie-est-statusy-oferty.md)
{% endcontent-ref %}

## GET /system/offers/statuses

> Получение списка поддерживаемых системой статусов оферт

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"servers":[{"url":"https://api.test.roolz.tech/public-api/v1","description":"Тестовая среда для разработки"}],"security":[{"getKey":[]},{"headerKey":[]}],"components":{"securitySchemes":{"getKey":{"type":"apiKey","description":"API-ключ для авторизации запросов в GET параметрах","name":"apikey","in":"query"},"headerKey":{"type":"apiKey","description":"API-ключ для авторизации запросов в header","name":"X-Api-Key","in":"header"}},"parameters":{"ContentTypeHeader":{"in":"header","name":"Content-Type","required":true,"description":"","schema":{"type":"string","default":"application/json","enum":["application/json"]}},"AcceptEncodingHeader":{"in":"header","name":"Accept-Encoding","required":true,"description":"","schema":{"type":"string","default":"gzip","enum":["gzip"]}}},"schemas":{"ErrorObject":{"required":["state","message","internal"],"properties":{"state":{"type":"string","description":"Статус выполнения запроса","enum":["error"]},"message":{"type":"string","description":"Дополнительная информация"},"validations":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"path":{"type":"string"},"reason":{"type":"string"}}}},"internal":{"type":"object","description":"Внутренняя информация системы Roolz для анализа проблемы при выполнении запроса","required":["roolz_debug_id"],"properties":{"roolz_debug_id":{"type":"string"}}}}}}},"paths":{"/system/offers/statuses":{"get":{"tags":["system"],"operationId":"getSupportedExchangeOffersStatuses","summary":"Получение списка поддерживаемых системой статусов оферт","parameters":[{"$ref":"#/components/parameters/ContentTypeHeader"},{"$ref":"#/components/parameters/AcceptEncodingHeader"}],"responses":{"200":{"description":"Успешное выполнение запроса","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Ошибка во входящих данных","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorObject"}}}},"401":{"description":"Запрос не авторизован. Возможно отсутствует API-ключ"},"403":{"description":"Данная операция не разрешена"}}}}}}
```

## GET /system/offers/types

> Получение списка поддерживаемых системой типов оферт

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"servers":[{"url":"https://api.test.roolz.tech/public-api/v1","description":"Тестовая среда для разработки"}],"security":[{"getKey":[]},{"headerKey":[]}],"components":{"securitySchemes":{"getKey":{"type":"apiKey","description":"API-ключ для авторизации запросов в GET параметрах","name":"apikey","in":"query"},"headerKey":{"type":"apiKey","description":"API-ключ для авторизации запросов в header","name":"X-Api-Key","in":"header"}},"parameters":{"ContentTypeHeader":{"in":"header","name":"Content-Type","required":true,"description":"","schema":{"type":"string","default":"application/json","enum":["application/json"]}},"AcceptEncodingHeader":{"in":"header","name":"Accept-Encoding","required":true,"description":"","schema":{"type":"string","default":"gzip","enum":["gzip"]}}},"schemas":{"ErrorObject":{"required":["state","message","internal"],"properties":{"state":{"type":"string","description":"Статус выполнения запроса","enum":["error"]},"message":{"type":"string","description":"Дополнительная информация"},"validations":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"path":{"type":"string"},"reason":{"type":"string"}}}},"internal":{"type":"object","description":"Внутренняя информация системы Roolz для анализа проблемы при выполнении запроса","required":["roolz_debug_id"],"properties":{"roolz_debug_id":{"type":"string"}}}}}}},"paths":{"/system/offers/types":{"get":{"tags":["system"],"operationId":"getSupportedExchangeOffersTypes","summary":"Получение списка поддерживаемых системой типов оферт","parameters":[{"$ref":"#/components/parameters/ContentTypeHeader"},{"$ref":"#/components/parameters/AcceptEncodingHeader"}],"responses":{"200":{"description":"Успешное выполнение запроса","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Ошибка во входящих данных","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorObject"}}}},"401":{"description":"Запрос не авторизован. Возможно отсутствует API-ключ"},"403":{"description":"Данная операция не разрешена"}}}}}}
```

## GET /system/geo-search

> Поиск гео объектов

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"servers":[{"url":"https://api.test.roolz.tech/public-api/v1","description":"Тестовая среда для разработки"}],"security":[{"getKey":[]},{"headerKey":[]}],"components":{"securitySchemes":{"getKey":{"type":"apiKey","description":"API-ключ для авторизации запросов в GET параметрах","name":"apikey","in":"query"},"headerKey":{"type":"apiKey","description":"API-ключ для авторизации запросов в header","name":"X-Api-Key","in":"header"}},"parameters":{"ContentTypeHeader":{"in":"header","name":"Content-Type","required":true,"description":"","schema":{"type":"string","default":"application/json","enum":["application/json"]}},"AcceptEncodingHeader":{"in":"header","name":"Accept-Encoding","required":true,"description":"","schema":{"type":"string","default":"gzip","enum":["gzip"]}}},"schemas":{"GeoFeature":{"properties":{"type":{"type":"string"},"center":{"type":"object","properties":{"lat":{"type":"number"},"lon":{"type":"number"}}},"properties":{"type":"object","properties":{"location_id":{"type":"integer"},"location_type":{"type":"string"},"location_attribute_key":{"type":"string"},"location_attribute_value":{"type":"string"},"name":{"type":"string"},"state":{"type":"string"},"country":{"type":"string"},"country_code":{"type":"string"},"county":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true}}}}},"ErrorObject":{"required":["state","message","internal"],"properties":{"state":{"type":"string","description":"Статус выполнения запроса","enum":["error"]},"message":{"type":"string","description":"Дополнительная информация"},"validations":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"path":{"type":"string"},"reason":{"type":"string"}}}},"internal":{"type":"object","description":"Внутренняя информация системы Roolz для анализа проблемы при выполнении запроса","required":["roolz_debug_id"],"properties":{"roolz_debug_id":{"type":"string"}}}}}}},"paths":{"/system/geo-search":{"get":{"tags":["system"],"operationId":"geoSearch","summary":"Поиск гео объектов","parameters":[{"$ref":"#/components/parameters/ContentTypeHeader"},{"$ref":"#/components/parameters/AcceptEncodingHeader"},{"name":"q","in":"query","required":true,"description":"Строка поиска. Допускается поиск по наименованиям, а также по координатам","schema":{"type":"string","minimum":3,"maximum":100}}],"responses":{"200":{"description":"Успешное выполнение запроса","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GeoFeature"}}}}},"400":{"description":"Ошибка во входящих данных","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorObject"}}}},"401":{"description":"Запрос не авторизован. Возможно отсутствует API-ключ"},"403":{"description":"Данная операция не разрешена"}}}}}}
```

## The GeoFeature object

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"components":{"schemas":{"GeoFeature":{"properties":{"type":{"type":"string"},"center":{"type":"object","properties":{"lat":{"type":"number"},"lon":{"type":"number"}}},"properties":{"type":"object","properties":{"location_id":{"type":"integer"},"location_type":{"type":"string"},"location_attribute_key":{"type":"string"},"location_attribute_value":{"type":"string"},"name":{"type":"string"},"state":{"type":"string"},"country":{"type":"string"},"country_code":{"type":"string"},"county":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.roolz.net/sistema.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
