Параметры запроса
Параметр | Тип | Обязательность | Описание |
page | число | нет | Номер страницы |
limit | число | нет | Количество записей на странице |
sort | строка | нет | Используется при get запросе. Сортировка по столбцу. Допустимые значения: id, -id, name, -name, created_at, -created_at, inn, -inn, alternative_inn, -alternative_inn, oksm_number, -oksm_number |
Данный метод вернет сведения о всех заведенных контрагентах.
Код ответа | Описание |
200 ОК | Статус успешного запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
Пример запроса:
curl -X ‘GET’ \
‘https://api.ord-a.ru/api/v2/organizations’ \
-H ‘accept: application/json’ \
-H ‘Authorization: Bearer TOKEN’ \
-H ‘X-CSRF-TOKEN: ‘
Пример успешного ответа:
{
“data”: [
{
“id”: 14166,
“name”: “Первое имя”,
“is_partner”: false,
“membership_id”: 1,
“has_cid_contracts”: false,
“type”: “ul”,
“is_ors”: true,
“is_rr”: false,
“is_rd”: false,
“inn”: “7613946079”,
“mobile_phone”: null,
“epay_number”: null,
“reg_number”: null,
“alternative_inn”: null,
“oksm_number”: null,
“kpp”: null,
“rs_url”: “https://my-dev.ord-a.ru”,
“is_agent”: false,
“platforms”: [
326009
],
“owned_platforms”: [
326009
],
“created_at”: “2024-02-19T13:33:31+03:00”,
“deleted_at”: null,
“external_id”: null,
“legal_address”: “123456, г. Москва, ул. Арбат, д. 1, офис 10”
},
{
“id”: 14165,
“name”: “Имя второе”,
“is_partner”: false,
“membership_id”: 1,
“has_cid_contracts”: false,
“type”: “fl”,
“is_ors”: true,
“is_rr”: false,
“is_rd”: false,
“inn”: “277332520750”,
“mobile_phone”: null,
“epay_number”: null,
“reg_number”: null,
“alternative_inn”: null,
“oksm_number”: null,
“kpp”: null,
“rs_url”: “https://my-dev.ord-a.ru”,
“is_agent”: false,
“platforms”: [
326008
],
“owned_platforms”: [],
“created_at”: “2024-02-19T10:41:40+03:00”,
“deleted_at”: null,
“external_id”: null,
“legal_address”: null
}
],
“links”: {
“first”: “http://api.ord-a.ru/api/v2/organizations?page=1”,
“last”: “http://aapi.ord-a.ru/api/v2/organizations?page=16”,
“prev”: null,
“next”: “http://api.ord-a.ru/api/v2/organizations?page=2”
},
“meta”: {
“current_page”: 1,
“from”: 1,
“last_page”: 1,
“links”: [
{
“url”: null,
“label”: “« Вперед”,
“active”: false
},
{
“url”: “http://api.ord-a.ru/api/v2/organizations?page=1”,
“label”: “1”,
“active”: true
},
{
“url”: “http://api.ord-a.ru/api/v2/organizations?page=2”,
“label”: “2”,
“active”: false
},
],
“path”: “http://api.ord-a.ru/api/v2/organizations”,
“per_page”: 2,
“to”: 1,
“total”: 2
}
}
Была ли эта статья полезной?