CRM Sales
Backend API Docs
  • Stage
  • Production
Backend API Docs
  • Stage
  • Production
ТЗ
  1. Requests
  • Enum реестры
    • Источники лидов - Назначение
      GET
    • Типы почты
      GET
    • Типы сообщения
      GET
    • Способы оплаты
      GET
    • Варианты оплаты
      GET
    • Типы получателей
      GET
    • Темы дел
      GET
    • Статусы лидов
      GET
    • Статусы товарных позиций в запросах
      GET
    • Статусы запросов
      GET
    • Статусы платежа
      GET
    • Статусы грузов
      GET
    • Статусы заявок на оплату
      GET
    • Типы Российских Договоров
      GET
    • Способы отправки
      GET
    • Типы счетчиков
      GET
  • Login
    • Авторизация
      POST
    • Верификация
      POST
    • Сброс пароля пользователя
      GET
  • Users
    • UserGroups
      • Получение заголовков раздела "Группы пользователей"
      • Получение списка записей раздела "Группы пользователей"
      • Добавление новой Группы пользователя
      • Удаление списка записей раздела "Группы пользователей"
      • Получение Группы пользователя по ID
      • Редактирование Группы пользователя
    • UserPositions
      • Получение заголовков раздела "Должности"
      • Получение списка записей раздела "Должности"
      • Добавление новой Должности
      • Удаление списка записей раздела "Должности"
      • Получение Должности по ID
      • Редактирование Должности
    • UserCodes
      • Получение списка записей раздела "Коды пользователей"
      • Добавление нового Кода пользователя
      • Удаление списка записей раздела "Коды пользователей"
      • Получение Кода пользователя
      • Редактирование Кода пользователя
    • Получение заголовков раздела "Сотрудники"
    • Получение списка сотрудников
    • Создание нового сотрудника
    • Удаление списка записей раздела "Сотрудники"
    • Информация об авторизованном пользователе
    • Список доступных авторизованному пользователю секций
    • Получение списка подчиненных пользователей
    • Получение сотрудника по ID
    • Изменение данных сотрудника
    • Генерация токена для пользователя
    • Получение токенов пользователя
  • Roles
    • Sections
      • Получение списка разделов с правами доступа по roleId
      • Редактирование прав доступа раздела по roleId и sectionId
      • Получение списка полей с правами доступа по roleId и sectionId
      • Редактирование прав доступа полей по roleId, sectionId и fieldId
    • Получение заголовков раздела "Роли"
    • Получение списка ролей
    • Создание роли
    • Удаление списка записей раздела "Роли"
    • Получить роль по ID
    • Редактирование роли
  • Services
    • Получение заголовков раздела "Услуги"
    • Получение списка записей раздела "Услуги"
    • Добавление новой услуги
    • Удаление списка записей раздела "Услуги"
    • Получение услуги по ID
    • Редактирование услуги
  • DepartmentCodes
    • Получение заголовков раздела "Коды подразделений"
    • Получение списка "Коды подразделений"
    • Создание кода подразделения
    • Удаление кода подразделения
    • Получение кода подразделения по ID
    • Редактирование кода подразделения
  • TechDealStatuses
    • Получение заголовков раздела "Статусы сделок"
    • Получение списка записей раздела "Статусы сделок"
    • Создание нового статуса сделок
    • Удаление списка записей раздела "Статусы сделки"
    • Получение статуса сделки
    • Редактирование статуса сделки
  • TechDealTypes
    • Получение заголовков раздела "Типы сделок"
    • Получение списка Типов сделок
    • Создание нового Типа сделок
    • Удаление Типа сделки
    • Получение Типы сделок по ID
    • Изменение данных Типы сделок
  • CauseFailures
    • Получение заголовков раздела "Причины отказов"
    • Получение списка записей раздела "Причины отказов"
    • Создание новой причины отказов
    • Удаление списка записей раздела "Причины отказов"
    • Получение причины отказа
    • Редактирование причины отказа
  • PaymentOptions
    • Получение заголовков раздела "Формы оплаты"
    • Получение списка записей раздела "Формы оплаты"
    • Создание нового Форм оплаты
    • Удаление Форм оплаты
    • Получение Форм оплаты по ID
    • Изменение данных Форм оплаты по ID
  • Materials
    • Получение заголовков раздела "Типы материалов"
    • Получение списка записей раздела "Типы материалов"
    • Создание нового Материала
    • Удаление Материала
    • Получение Материала по ID
    • Изменение данных Материала по ID
  • UnitOfMeasures
    • Получение заголовков раздела "Единицы измерения"
    • Получение списка записей раздела "Единицы измерения"
    • Создание нового Единицы измерения
    • Удаление Единиц измерения
    • Получение Единиц измерения по ID
    • Изменение данных Единиц измерения по ID
  • PackingTypes
    • Получение заголовков раздела "Виды упаковок"
    • Получение списка записей раздела "Виды упаковок"
    • Создание нового Вида упаковки
    • Удаление Вида упаковки
    • Получение Вида упаковки по ID
    • Изменение данных Вида упаковки
  • PackingContents
    • Получение заголовков раздела "Состав и тариф упаковки"
    • Получение списка записей раздела "Состав и тариф упаковки"
    • Создание нового Состава и тарифа упаковки
    • Удаление Состава и тарифа упаковки
    • Получение Состава и тарифа упаковки по ID
    • Изменение данных Состава и тарифа упаковки
  • Agents
    • Получение заголовков раздела "Агенты"
    • Получение списка записей раздела "Агенты"
    • Получение Агента
  • RuCompanies
    • Получение заголовков раздела "Компании РФ"
    • Получение списка записей раздела "Компании РФ"
    • Получение компании РФ
  • Currencies
    • Получение заголовков раздела "Валюты"
    • Получение списка записей раздела "Валюты"
    • Добавление новой валюты
    • Удаление списка записей раздела "Валюты"
    • Получение валюты
    • Редактирование валюты
  • Contracts
    • Получение заголовков раздела "Контракты"
    • Получение списка записей раздела "Контракты"
    • Получение контракта
  • Countries
    • Получение заголовков раздела "Страны"
    • Получение списка записей раздела "Страны"
    • Добавление новой страны
    • Удаление списка записей раздела "Страны"
    • Получение страны
    • Редактирование страны
  • Cities
    • Получение заголовков раздела "Города"
    • Получение списка записей раздела "Города"
    • Добавление нового города
    • Удаление списка записей раздела "Города"
    • Получение города
    • Редактирование города
  • UtmMarks
    • Получение заголовков раздела "UTM метки"
    • Получение списка записей раздела "UTM метки"
    • Добавление новой UTM метки
    • Удаление списка записей раздела "UTM метки"
    • Получение UTM метки по ID
    • Редактирование UTM метки
  • RuContracts
    • Получение заголовков раздела "Договора"
    • Получение списка записей раздела "Договора"
    • Получение Договора по ID
  • Accounts
    • Получение заголовков раздела "Счета"
    • Редактирование Счета
    • Скачать Расчетку
    • Получение списка записей раздела "Счета"
    • Получение Счета по ID
  • Payers
    • Получение заголовков раздела "Плательщики"
    • Получение списка записей раздела "Плательщики"
    • Добавление нового Плательщика
    • Удаление списка записей раздела "Плательщики"
    • Получение Плательщика по ID
    • Редактирование Плательщика
  • Recipients
    • Получение заголовков раздела "Получатели"
    • Получение списка записей раздела "Получатели"
    • Добавление нового Получателя
    • Удаление списка записей раздела "Получатели"
    • Получение Получателя по ID
    • Редактирование Получателя
  • IssuanceMethods
    • Получение заголовков раздела "Способы выдачи груза"
    • Получение списка записей раздела "Способы выдачи груза"
    • Создание Способа выдачи груза
    • Удаление списка записей раздела "Способы выдачи груза"
    • Получить Способ выдачи груза по ID
    • Редактирование Способа выдачи груза
  • ProductItems
    • Получение заголовков раздела "Товарные позиции"
    • Получение списка записей раздела "Товарные позиции"
    • Добавление новой Товарной позиции
    • Удаление списка записей раздела "Товарные позиции"
    • Получение Товарной позиции по ID
    • Редактирование Товарной позиции
  • Requests
    • RequestItems
      • Получение списка записей раздела "Товарные позиции в запросах на расчет ТС"
      • Добавление новой Товарной позиции в запросах на расчет ТС
      • Удаление списка записей раздела "Товарные позиции в запросах на расчет ТС"
      • Получение Товарной позиции в запросах на расчет ТС по ID
      • Редактирование Товарной позиции в запросах на расчет ТС
      • Загрузка товарных позиций
      • Проставить признак Поиск разрешительных документов по нескольким товарным позициям запросов
    • Получение заголовков раздела "Запросы на расчет ТС"
      GET
    • Получение списка записей раздела "Запросы на расчет ТС"
      GET
    • Добавление нового Запроса на расчет ТС
      POST
    • Удаление списка записей раздела "Запросы на расчет ТС"
      DELETE
    • Получение Запроса на расчет ТС по ID
      GET
    • Редактирование Запроса на расчет ТС
      PATCH
    • Загрузка товарных позиций
      POST
  • Customers
    • CustomerEmails
      • Получение заголовков раздела "Реестр контактных Email"
      • Получение списка записей раздела "Реестр контактных Email"
      • Добавление нового Контактного Email
      • Удаление списка записей раздела "Реестр контактных Email"
      • Получение Контактного Email по ID
      • Редактирование Контактного Email
    • CustomerPhones
      • Получение заголовков раздела "Реестр контактных телефонов"
      • Получение списка записей раздела "Реестр контактных телефонов"
      • Добавление нового Контактного телефона
      • Удаление списка записей раздела "Реестр контактных телефонов"
      • Получение Контактного телефона по ID
      • Редактирование Контактного телефона
    • Получение заголовков раздела "Клиенты"
    • Получение списка записей раздела "Клиенты"
    • Добавление нового Клиента
    • Удаление списка записей раздела "Клиенты"
    • Получение Клиента по ID
    • Редактирование Клиента
    • Получение списка звонков по ID Клиента
    • Получение списка писем по ID Клиента
    • Получение списка комментариев по ID Клиента
    • Создание нового комментария по ID Клиента
    • Получение истории по ID Клиента
    • Закрепление элемента истории по ID Клиента
    • Открепление элемента истории по ID Клиента
  • Leads
    • LeadSources
      • Получение заголовков раздела "Источники лидов"
      • Получение списка записей раздела "Источники лидов"
      • Создание нового источника лидов
      • Удаление списка записей раздела "Источники лидов"
      • Получение источника лидов
      • Редактирование источника лидов
    • LeadDistribution
      • Получение списка записей раздела "Распределние Лидов"
      • Создание новой записи распределния лидов
      • Удаление списка записей раздела "Распределние Лидов"
      • Получение записи распределния лидов по ID
      • Редактирование записи распределения лидов по ID
    • Получение заголовков раздела "Лиды"
    • Получение списка записей раздела "Лиды"
    • Добавление нового Лида
    • Удаление списка записей раздела "Лиды"
    • Загрузка Excel файла в раздел "Лиды"
    • Смена статуса списку лидов
    • Получение Лида по ID
    • Редактирование Лида
    • Получение списка звонков по ID Лида
    • Получение списка писем по ID Лида
    • Получение списка комментариев по ID Лида
    • Создание нового комментария по ID Лида
    • Получение истории по ID Лида
    • Закрепление элемента истории по ID Лида
    • Открепление элемента истории по ID Лида
    • Смена менеджера списку лидов
    • Webhook Tilda
    • Webhook Custom Service
  • Factories
    • Получение заголовков раздела "Фабрики"
    • Получение списка записей раздела "Фабрики"
    • Добавление новой фабрики
    • Удаление списка записей раздела "Фабрики"
    • Получение Фабрики по ID
    • Редактирование Фабрики
  • FactoryBanks
    • Получение заголовков раздела "Банки фабрик"
    • Получение списка записей раздела "Банки фабрик"
    • Добавление нового Банка фабрики
    • Удаление списка записей раздела "Банки фабрик"
    • Получение Банка фабрик по ID
    • Редактирование Банка фабрик
  • FactoryAccounts
    • Получение заголовков раздела "Счета фабрик"
    • Получение списка записей раздела "Счета фабрик"
    • Добавление нового счета фабрик
    • Удаление списка записей раздела "Счета фабрик"
    • Получение Счета фабрик по ID
    • Редактирование Счета фабрик
  • PreliminaryCostings
    • PreliminaryCostingItems
      • Получение списка записей раздела "Товарные позиции в Предварительном расчете стоимости"
      • Добавление новой Товарной позиции
      • Удаление списка записей раздела "Товарные позиции в Предварительном расчете стоимости"
      • Получение Товарной позиции по ID
      • Редактирование товарной позиции
    • Получение заголовков раздела "Предварительный расчет стоимости"
    • Получение списка записей раздела "Предварительный расчет стоимости"
    • Добавление нового Предварительного расчета стоимости
    • Удаление списка записей раздела "Предварительный расчет стоимости"
    • Получение Предварительного расчета стоимости по ID
    • Редактирование Предварительного расчета стоимости
  • ToDos
    • Получение заголовков раздела "Дела"
    • Откладывание дела
    • Завершение дела
    • Получение списка записей раздела "Дела"
    • Добавление нового Дела
    • Удаление списка записей раздела "Дела"
    • Получение Дела по ID
    • Редактирование Дела
  • Payments
    • Получение списка записей раздела "Платежи"
    • Добавление нового Платежа
    • Удаление списка записей раздела "Платежи"
    • Получение Платежа по ID
    • Редактирование Платежа
    • Передать в оплату список платежей
    • Одобрить список платежей
    • Отклонить список платежей
    • Загрузка файла "Данные по финансам"
  • PaymentRequests
    • Получение списка записей раздела "Заявки на оплату"
    • Добавление новой Заявки на оплату
    • Удаление списка записей раздела "Заявки на оплату"
    • Получение Заявки на оплату по ID
    • Редактирование Заявки на оплату
    • Завершить список заявок на оплату
  • Warehouses
    • Sectors
      • Получение заголовков раздела "Сектора"
      • Получение списка записей раздела "Сектора"
      • Добавление нового Сектора
      • Удаление списка записей раздела "Сектора"
      • Получение Сектора по ID
      • Редактирование Сектора
    • Получение заголовков раздела "Склады"
    • Получение списка записей раздела "Склады"
    • Добавление нового Склада
    • Удаление списка записей раздела "Склады"
    • Получение Склада по ID
    • Редактирование Склада
  • Cargos
    • CargoItems
      • Получение списка записей раздела "Товарные позиции в Грузе для клиента"
      • Добавление новой товарной позиции в Грузе для клиента
      • Удаление списка записей раздела "Товарные позиции в грузе для клиента"
      • Загрузка товарных позиций в Грузе для клиента
      • Редактирование товарной позиции в Грузе для клиента
      • Получение товарной позиции в Грузе для клиента по ID
    • Tracks
      • Получение списка записей раздела "Треки"
      • Получение Трека по ID
      • Редактирование Трека
      • Объединить треки в Груз для клиента
      • Получение общих данных о Треках
    • Places
      • Получение списка записей раздела "Места"
      • Получение Места по ID
      • Редактирование Места
    • Specifications
      • Получение списка записей раздела "Спецификации"
    • Batches
      • Получение списка записей раздела "Партии"
    • SpecificationTypes
      • Получение списка записей раздела "Типы спецификаций"
    • Получение списка записей раздела "Груз для клиента"
    • Добавление нового Груза для клиента
    • Удаление списка записей раздела "Груз для клиента"
    • Редактирование Груза для клиента
    • Получение Груза для клиента по ID
    • Перемещение треков в груз
    • Сформировать Счет за транспорт
    • Снятие запрета на выдачу по заданному массиву грузов
    • Применение запрета на выдачу по заданному массиву грузов
    • Скачивание ставок по товарным позициям груза
    • Загрузка ставок по товарным позициям груза
    • Получение общих данных о Грузах
    • Скачать Расчетку
    • Передать в бухгалтерию
    • Выставить запрет на отправку
  • CommercialOffers
    • Создание КП
    • Получение списка записей раздела "КП"
  • CargoDirections
    • Получение списка записей раздела "Направления движения грузов"
    • Добавление нового Направления движения грузов
    • Удаление списка записей раздела "Направления движения грузов"
    • Калькуляция направлений движения грузов
  • HistoryChanges
    • Получение истории изменений
  • Reports
    • Debts
      • Создание отчета по долгам
      • Получение отчета по долгам
      • Получение отчета по долгам по ID
    • SalesDepartments
      • Создание отчета по тоннажу, коммерции, выручке
      • Получение списка отчетов по тоннажу, коммерции, выручке
      • Получение отчета по тоннажу
      • Получение отчета по коммерции (Rub)
      • Получение отчета по коммерции (Usd)
      • Получение отчета по выручке
      • Получение отчета по аналитике подразделения
    • SalesCustomers
      • Создание отчета "Продажам по клиентам"
      • Получение списка отчетов "Продажам по клиентам"
    • Sales
      • Получение списка отчетов по продажам
      • Получение отчета по продажам (месяц)
      • Получение отчета по продажам (недели)
      • Получение планов
      • Получение плана по ID
      • Загрузить план на месяц
      • Создать отчет по продажам
      • Внести ожидаемые
    • Managers
      • Получение списка отчетов
      • Получение отчета менеджера
      • Создать отчет менеджера
      • Удалить список отчетов
  • Files
    • Получение списка файлов
    • Загрузка Файла
    • Удаление Файлов
    • Получить превью документа в формате PDF
    • Получение файла
  • Images
    • Получение списка Изображений
    • Загрузка Изображения
    • Удаление изображений
    • Получение Изображения
    • Получение Миниатюры изображения (large)
    • Получение Миниатюры изображения (medium)
    • Получение Миниатюры изображения (normal)
    • Получение Миниатюры изображения (small)
  • Notifications
    • Получение списка Уведомлений
    • Получение Уведомления по ID
    • Удаление Уведомлений
    • Отметить все Уведомления текущего пользователя как прочитанные
    • Отметить Уведомление как прочитанное
    • Удалить все Уведомления текущего пользователя
  • WishesTypes
    • Получение заголовков раздела "Типы пожеланий"
    • Получение списка Типов пожеланий
    • Создание нового Типа Пожеланий
    • Удаление Типа Пожелания
    • Получение типа пожеланий по ID
    • Изменение данных Типы Пожеланий
  • Checkpoints
    • Получение Контрольного пункта
    • Получение списка записей раздела "Контрольные пункты"
  • DeliveryBasis
    • Получение списка записей раздела "Базисы поставки"
    • Создание Базиса поставки
    • Получить Базис поставки по ID
    • Удаление списка записей раздела "Базисы поставки"
    • Редактирование Базиса поставки
  • Contacts
    • Получение списка контактов
    • Добавление нового контакта
    • Редактирование контакта
    • Получение Контакта по id
    • Удаление списка контактов
  • Exceptions
    • Exceptions
  • Курсы
    GET
  • Поиск лидов и клиентов
    GET
  • Счетчики по разделам
    GET
  • Untitled Endpoint
    POST
  1. Requests

Добавление нового Запроса на расчет ТС

Cloud Mock
https://mock.apidog.com/m1/463678-0-default
Cloud Mock
https://mock.apidog.com/m1/463678-0-default
POST
https://mock.apidog.com/m1/463678-0-default
/requests
Requests
Last modified:2024-03-04 06:13:47
Добавление нового Запроса на расчет ТС

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params application/json
Раздел должен поддерживать два варианта добавления записей: 1. Форма создания нового запроса - Сотрудник заполняет все поля формы и добавляет в запись товарные позиции. 1. Excel-файл - Сотрудник загружает файл в формате Excel по шаблону представленному в данном файле Запрос на расчет ТС - файл загрузки
techDealTypes
array[string <iri-reference>]
required
Идентификаторы типа сделок (Все выбранные менеджером типы сделок для запроса на расчет ТС декларанту)
service
string <iri-reference>
required
Услуга (по умолчанию “сборная логистика”)
Example:
/services/1
customer
string <iri-reference>
optional
Идентификатор клиента (Имя, фамилия и компания)
Обязательно, если не выбран Лид
Example:
/customers/1
manager
string <iri-reference>
required
Менеджер (Имя и фамилия)
Example:
/users/1
requestItems
array[string <iri-reference>]
required
Товарные позиции (Выбранные товарные позиции в запросе)
lead
string <iri-reference>
optional
Номер лида
Обязательно, если не выбран Клиент
Example:
/leads/1
isTechnicalRequest
boolean 
optional
Технический запрос
Default:
false
Example
{
    "techDealTypes": [
        "/tech-deal-types/1"
    ],
    "service": "/services/1",
    "customer": "/customers/1",
    "manager": "/users/1",
    "requestItems": [
        "/request-items/1"
    ],
    "lead": "/leads/1",
    "isTechnicalRequest": false
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://mock.apidog.com/m1/463678-0-default/requests' \
--header 'Content-Type: application/json' \
--data-raw '{
    "techDealTypes": [
        "/tech-deal-types/1"
    ],
    "service": "/services/1",
    "customer": "/customers/1",
    "manager": "/users/1",
    "requestItems": [
        "/request-items/1"
    ],
    "lead": "/leads/1",
    "isTechnicalRequest": false
}'

Responses

🟢201Created
application/json
Body
allOf {2} 
optional
Раздел должен поддерживать два варианта добавления записей:
1.
Форма создания нового запроса - Сотрудник заполняет все поля формы и добавляет в запись товарные позиции.
2.
Excel-файл - Сотрудник загружает файл в формате Excel по шаблону представленному в данном файле Запрос на расчет ТС - файл загрузки
В колонке “Разрешительные документы” должна быть ссылка на раздел “поиск разрешительных документов”
object (BaseFieldsModel) 
optional
deletedAt
string <date-time> | null 
required
id
integer 
required
ID
>= 1
object 
optional
techDealTypes
array[object (Типы сделок) {5}] 
required
Идентификаторы типа сделок (Все выбранные менеджером типы сделок для запроса на расчет ТС декларанту)
>= 1 items
service
object (Услуги) 
required
Услуга (по умолчанию “сборная логистика”)
marking
object (Маркировка) 
optional
Маркировка (Уникальный код, включающий в себя Код подразделения, Код менеджера, Код клиента)
Обязательно, если был выбран Клиент
customer
allOf {2} 
optional
Идентификатор клиента (Имя, фамилия и компания)
Обязательно, если не выбран Лид
manager
object (Пользователи (base)) 
required
Менеджер (Имя и фамилия активной учетной записи)
declarant
object (Пользователи (base)) 
optional
Декларант (Имя и фамилия)
status
object (Enum) 
optional
Название статуса
requestItems
array[object (ТП в запросах на расчет ТС) {38}] 
required
Товарные позиции (Выбранные товарные позиции в запросе)
>= 1 items
lead
object (Лиды) 
optional
Номер лида
Обязательно, если не выбран Клиент
isTechnicalRequest
boolean 
optional
Технический запрос
Default:
false
Example
🟠400Ошибки 4XX
🔴500Ошибки 5XX
Previous
Получение списка записей раздела "Запросы на расчет ТС"
Next
Удаление списка записей раздела "Запросы на расчет ТС"
Built with