Доступ к API
Базовый URL для API запросов: https://cms.rentix.biz/api
Для авторизации необходим публичный ключ и секретный. Используется базовая аутентификация HTTP (basic). Ключи передаются в такой последовательности: "публичный_ключ:секретный_ключ"
Ответ на запросы приходит в виде JSON.
Получение списка категорий
Возвращает список всех категорий и их данные.
Формат запроса
GET /categories
success - успешно (true) или нет (false)
categories - массив категорий:
id - ID категории
name - наименование категории
icon - иконка категории
sort - порядковый номер для сортировки
is_section - является разделом или нет
parent_id - ID категории родителя (вышестоящей)
inventory_count - количество инвентаря в категории, включая дочерние категори
modified_at - дата последнего изменения категории
can_rating - возможность оценки инвентаря
properties - массив характеристик категории:
id - ID характеристики категории
name - наименование характеристики категории
note - примечание характеристики категории
Получение списка занятого инвентаря
Возвращает список инвентаря который находится в прокате или забронирован. А также заказов, в которых он присутсвует.
Формат запроса
GET /inventories/busy
success - успешно (true) или нет (false)
busy - массив занятого инвентаря
id - ID инвентаря
orders - массив заказов, в которых присутствует данный инвентарь
id - ID заказа
date_start - дата и время начала заказа
date_finish - дата и время окончания заказа
type - тип заказа (rental - в прокате, booking - бронь)
Получение списка инвентаря для продажи
Возвращает список инвентаря у которого установлен флаг (галочка) "На продажу"
Формат запроса
GET /inventories/forsale
success - успешно (true) или нет (false)
forsale - массив инвентаря для продажи
id - ID инвентаря
name - наименование инвентаря
code - код
part_number - артикул
condition - состояние инвентаря
image - URL изображения
image_full - URL изображения в оригинальном размере
properties - массив характеристик инвентаря
id - ID характеристики
name - наименование характеристики
value - значение характеристики
allow_rent - флаг "Доступен для проката"
category - категория
id - ID категории
name - наименование категории
parentCategory - родительская категория
id - ID категории
name - наименование категории
priceSale - стоимость продажи
note - примечание
Получение списка инвентаря в категории
Возвращает список инвентаря в указанной категории
Формат запроса
GET /category/{ID}/inventories
{ID} - ID категории (можно узнать в настройках категорий)
success - успешно (true) или нет (false)
category - информация о категории:
id - ID категории
name - наименование категории
icon - иконка категории
sort - порядковый номер для сортировки
is_section - является разделом да или нет
parent_id - ID категории родителя (вышестоящей)
inventory_count - количество инвентаря в категории, включая дочерние категори
modified_at - дата последнего изменения категории
properties - массив характеристик категории:
id - ID характеристики категории
name - наименование характеристики категории
note - примечание характеристики категории
inventories - массив инвентаря:
id - ID инвентаря
name - наименование инвентаря
code - код
part_number - артикул
condition - состояние инвентаря
image - URL изображения
image_full - URL изображения в оригинальном размере
properties - массив характеристик инвентаря
id - ID характеристики
name - наименование характеристики
value - значение характеристики
allow_rent - флаг "Доступен для проката"
Информация об инвентаре
Возвращает подробную информацию об инвентаре
Формат запроса
GET /inventory/{ID}
{ID} - ID инвентаря
GET /inventory/code/{CODE}
{CODE} - код инвентаря
success - успешно (true) или нет (false)
inventory - информация об инвентаре:
id - ID инвентаря
name - наименование инвентаря
code - код инвентаря
part_number - артикул
has_quantity - количественный инвентарь Да/Нет
category - категория:
id - ID категории
name - наименование категории
rent_point - точка проката:
id - ID точки
name - название
current_rental_order_id - ID текущего заказа проката
condition - состояние инвентаря (износ)
genders - массив муж/жен инвентарь
statuses - массив статуса инвентаря (Доступен для проката, Для продажи и т.д.)
currentStatuses - массив текущего статуса (В прокате, Бронь и т.д.)
image - ссылка на изображение
image_full - ссылка на полное изображение
allow_rent - доступен ли для проката
properties - массив свойств инвентаря
id - ID
name - название
value - значение
note - примечание
is_main - является ли основной характеристикой
finances - финансы
price_buy - стоимость закупки инвентаря
price_contract - стоимость в договоре
price_sale - цена продажи
price_day - стоимость проката за сутки
price_day_enable - включена ли ст-ть проката за сутки
note - примечание
stats - статистика
date_add - дата добавления
sale_at - дата продажи
discarded_at - дата списания
ratings_count - оценок всего
rating_avg - средний балл оценок
given_count - выдавался
total_days - всего дней
total_sum - сумма проката
Информация о клиенте
Возвращает данные о клиенте. Поиск осуществляется по ID или по телефону
Формат запроса
GET /client/{ID}
{ID} - ID клиента
GET /phone/client/array[phone => {PHONE}]
{PHONE} - телефон клиента в формате "79004445599" (String)
success - успешно (true) или нет (false)
client - информация о клиенте:
id - ID клиента
phone - телефон
firstName - имя
lastName - фамилия
middleName - отчество
dateOfBirth - дата рождения
ordersTotal - всего заказов
lastOrder - последний заказ:
totalInventory - всего инвентаря
totalKit - всего комплектов
totalPeople - всего человек
date - дата заказа
Информация о заказе
Возвращает данные о конкретном заказе
Формат запроса
GET /order/{ID}
{ID} - ID заказа
success - успешно (true) или нет (false)
order - информация о заказе:
id - ID заказа
num_id - номер заказа (пользовательский)
rent_point_id - ID точки проката
client_id - ID клиента, на которого оформлялся заказ
client_fio - ФИО клиента, на которого оформлялся заказ
date_begin - дата и время начала заказа
date_end - дата и время окончания заказа
status - статус (в покате, бронь, отменен, закрыт и т.д.)
fullday - кол-во дней
is_full_paid - заказ полностью оплачен
deposit - наименование залога
tariffs - тариф:
id - ID
name - название
resort - курорт
Payment History - массив истории взаиморасчетов:
date - дата и время
type - тип оплаты (предоплата, оплата, доплата и т.д.)
amount - сумма
way - способ оплаты (пользовательское значение с соотв. справочника)
PaymentHistoryTotal - итоговая сумма оплаты
Clients - массив клиентов в заказе:
id - ID клиента
name - ФИО
height - рост
weight - вес
cost - стоимость аренды для данного клиента с учетом скидки (если есть)
cost_old - стоимость аренды для данного клиента без учета скидки
footSize - размер ноги
is_given - инвентарь нахоидтся в прокате
is_collected - инвентарь собран
InventoryTotal: - всего инвентаря в заказе для данного клиента
kits - кол-во комплектов
inventories - кол-во инвентаря без учета того, что в комплектах
Inventory - массив инвентаря для данного клиента:
id - ID инвентаря
code - код инвентаря
part_number - артикул
image - URL изображения
image_full - URL изображения в оригинальном размере
name - наименование инвентаря
size - размер (основная характеристика из настроек категории)
cost - сумма с учетом скидки (если есть)
cost_old - сумма без учета скидки
is_given - инвентарь нахоидтся в прокате
is_collected - инвентарь собран
category - категория инвентаря:
id - ID категории
name - наименование категории
mode: - на чем катается клиент
name - либо стойка foot_stand (для СБ), либо усилие force (лыжи)
value - значение
totals: - итог
inventoriesAll - всего инвентаря, включая в комплектах
kits - всего комплектов
inventories - всего инвентаря без учета того, что в комплектах
cost_per_day - стоимость в сутки с учетом скидки (если есть)
cost_per_day_old - стоимость в сутки без учета скидки
price - стоимость с учетом скидки (если есть)
price_old - стоимость без учета скидки
navigation: - навигация по заказам:
prevOrder - предыдущий заказ
nextOrder - следующий заказ
Информация о заказе на ремонт
Возвращает данные о заказе на ремонт инвентаря
Формат запроса
GET /repair/{ID}
{ID} - ID заказа
success - успешно (true) или нет (false)
repair - данные заказа на ремонт:
id - ID заказа
num_id - номер заказа (пользовательский)
client_id - ID клиента
client_fio - ФИО клиента
date_accept - дата/время принятия заказа
date_return - дата/время возврата
date_done - дата/время готовности
status - статус
is_full_paid - флаг полной оплаты заказа
free_storage_days - бесплатное хранение инвентаря (дней)
Payment History - история взаиморасчетов
date - дата/время проведения операции
type - тип оплаты (предоплата, оплата, доплата и т.д.)
amount - сумма
way - способ оплаты (пользовательское значение с соотв. справочника)
PaymentHistoryTotal - итоговая сумма оплаты
Inventories - массив инвентаря на ремонте:
id - ID (0 - это пользовательский инвентарь)
name - наименование
size - размер
cost - стоимость
is_done - флаг готовности инвентаря
OperationTotal - количество операций
Operation: - массив операций ремонта
id - ID операции
name - наименование операции
cost - стоимость
is_done - флаг готовности операции
totals - итого:
inventoriesAll - всего инвентаря в заказе
operationsAll - всего операций в заказе
price - общая стоимость заказа
navigation - навигация по заказам:
prevRepair - ссылка на предыдущий ремонт
nextRepair - ссылка на следующий ремонт
Список заказов
В соответствии с условиями запроса возвращает список заказов
Формат запроса
GET /rent/orders['rent' => {rentId}, limit => {limit}, last_days => {last_days}, full_paid => {isFullPaid}]
{rentId} - ID точки проката (nullable|integer)
{limit} - ограничение на кол-во записей (nullable|integer)
{last_days} - заказы за последние N дней (nullable|integer)
{isFullPaid} - только полностью оплаченные (nullable|boolean)
success - успешно (true) или нет (false)
orders - массив заказов:
id - ID заказа
rent_point_id - ID точки проката
date - дата и время заказа
status - статус
Список заказов по номеру телефона
Возвращает список заказов клиента по номеру телефона
Формат запроса
GET /phone/orders['phone' => {phone}]
phone - телефон клиента в формате 79004445588 (string)
success - успешно (true) или нет (false)
client - данные клиента и его заказы
id - ID клиента
phone - телефон
Orders - массив заказов:
id - ID заказа
totalInventory - кол-во инвентаря без учета того, что в комплектах
totalKit - кол-во комплектов
totalPeople - всего человек
date - дата/время оформления заказа
status - статус заказа
date_begin - дата/время начала заказа
date_end - дата/время окончания заказа
Повтор заказа
Повтор заказа по существующему ранее заказу.
Формат запроса
POST /order/{ID}/repeat['date_begin' => {dateTimeBegin}, 'date_end' => {dateTimeBegin}, 'note' => {note}]
{ID} - ID существующего заказа (integer)
{dateTimeBegin} - дата и время начала брони в формате Y-m-d H:i:s (пример: 2024-02-19 16:30:00) (DateTime)
{dateTimeEnd} - дата и время начала брони в формате Y-m-d H:i:s (DateTime)
{note} - примечание (String)
Формат ответа
В ответе приходит информация о заказе. Формат ответа такой же, как и для метода
/order/{ID}