Public API
  1. Public API
Public API
  • Public API
    • Главная
    • Клиенты
      • Добавить клиента
    • Услуги
      • Добавить услугу
      • Удалить услугу
      • Список услуг
      • Обновить услугу
    • Расчет стоимости
      • Расчет стоимости
    • Заказы
      • Cписок заказов
      • Заказ по ID
      • Разместить заказ
    • Schemas
      • Client
      • Order
      • OrderStatus
      • PriceCalc
      • RoutePoint
      • Service
      • SuccessApiResponse
      • SuccessApiResponseList
      • ErrorApiResponse
  1. Public API

Главная

Авторизация#

Для авторизации запроса необходимо передавать API ключ в заголовке x-apis-key при каждом запросе.

Процесс создания заказа#

Для создания заказа необходимо осуществить ряд действий:

Создать клиента#

Этот шаг является опциональным
Для создания клиента используется метод Добавить клиента. Идентификатор созданного клиента может использоваться в расчете стоимости или при размещении заказа.

Рассчитать стоимость заказа#

Для расчета стоимости необходимо воспользоваться методом Расчет стоимости.
Если при расчете стоимости не передается параметр clientId (идентификатор клиента), тогда необходимо передать параметры clientName и clientPhone. Если в системе есть клиент с логином, который совпадает со зачением clientPhone, тогда к расчету стоимости будет привязан этот клиент, иначе будет создан новый клиент с логином clientPhone.
Метод расчета стоимости вернет массив рассчитанных тарифов для переданной услуги.

Разместить заказ#

Для размещения заказа используется метод Разместить заказ
Если при расчете стоимости не передается параметр clientId (идентификатор клиента), тогда необходимо передать параметры clientName и clientPhone. Если в системе есть клиент с логином, который совпадает со зачением clientPhone, тогда к расчету стоимости будет привязан этот клиент, иначе будет создан новый клиент с логином clientPhone.
Необходимо передать идентификатор рассчитанного тарифа в параметр priceId при создании заказа.

Статусы заказов#

СтатусОписание
createdЗаказ размещен
scheduledЗаказ запланирован на выполнение на определенную дату и время
scheduledAcceptedЗапланированный заказ назначен на исполнителя
assignedЗаказ назначен на исполнителя
manualSearchРучной поиск исполнителя. Необходимо назначить исполнителя через личный кабинет или API
pointProcessingИсполнитель прибыл в точку заказа
pointCompletedИсполнитель завершил работы в точке заказа
completedЗаказ завершен
closedЗаказ закрыт
cancelledЗаказ отменен клиентом
notAcceptedЗаказ не принят по причине отсутствия исполнителей
(*) зеленым выделены финальные статусы
Modified at 2025-10-13 16:26:06
Next
Добавить клиента
Built with