Функциональная карта Перевозчика

Авторизация

Для того, чтобы начать работу на платформе необходимо получить токен, авторизоваться и обновлять токен.

1. Получить токен - используйте метод </auth/token POST>. 

Пример просмотра ссылки на метод (обращение к боевой API)

Создание ресурсов

Ниже представлен сокращённый перечень методов, необходимых для подготовки ресурсов на выполнение перевозок.

Ограничения: 

• грузовладельцы самостоятельно определяют порядок проверки ресурсов;
• прикрепление документов в карточку ресурса возможно только после того, как ресурс создан;
• файлы, которые крепятся к ресурсам загружаются в контейнер, который называется документ;
• для каждого типа ресурса определён свой перечень документов;
• для того чтобы прикрепить файл в карточку ресурса требуется создать документ;
• для обновления файлов, прикреплённых к карточке ресурса, требуется удалять файлы в документе карточки ресурса и загружать новые файлы.

Рассмотрим последовательность действий и то, какие методы должны быть использованы:

• создать карточку ресурса – используйте метод:
  • карточка водителя: </resources/{company_id}/drivers POST>:
    • company_id – uuid компании Перевозчика.
  • карточка ТС: </resources/{company_id}/cars POST>: 
    • company_id – uuid компании Перевозчика.
  • карточка прицепа: </resources/{company_id}/trailers POST>:
    
    • company_id – uuid компании Перевозчика.
• получение перечня документов для карточки ресурса- используйте метод:
  • для водителя: </resources/{company_id}/drivers/{driver_id}/document_types GET>:
    • company_id – uuid компании перевозчика;
    • driver_id – uuid водителя.
  • для ТС: </resources/{company_id}/cars/{car_id}/document_types GET>:
    • company_id – uuid компании перевозчика;
    • car_id – uuid ТС.
  • для прицепа: </resources/{company_id}/trailers/{trailer_id}/document_types GET>:
    • company_id – uuid компании перевозчика;
    • trailer_id – uuid прицепа.
• создание документа в карточке ресурса (для последующего прикрепления файла) – используйте метод:
  
  • для водителя: </resources/{company_id}/drivers/{driver_id}/documents POST>:
    • company_id – uuid компании перевозчика;
    • driver_id – uuid водителя.
  • для ТС: </resources/{company_id}/cars/{car_id}/documents POST>:
    • company_id – uuid компании перевозчика;
    • car_id – uuid ТС.
  • для прицепа: </resources/{company_id}/trailers/{trailer_id}/documents POST>;
    • company_id – uuid компании перевозчика;
    • trailer_id – uuid прицепа.
• загрузка файла в документ, по карточке ресурса (для последующего прикрепления файла) – используйте метод:
  
  • для водителя: </resources/{company_id}/drivers/{driver_id}/documents/{document_id}/file POST>:
    • company_id – uuid компании перевозчика;
    • driver_id – uuid водителя;
    • document_id – uuid документа по которому загружается файл.
  • для ТС: </resources/{company_id}/cars/{car_id}/documents/{document_id}/file POST>:
    • company_id – uuid компании перевозчика;
    • car_id – uuid ТС;
    • document_id – uuid документа по которому загружается файл.
  • для прицепа: </resources/{company_id}/trailers/{trailer_id}/documents/{document_id}/file POST>.
    • company_id – uuid компании перевозчика;
    • trailer_id – uuid прицепа;
    • document_id – uuid документа по которому загружается файл.
• получить перечень ресурсов – используйте метод:
  • список водителей: </resources/{company_id}/drivers GET>:
    • company_id – uuid компании перевозчика.
  • список ТС: </resources/{company_id}/cars GET>: 
    • company_id – uuid компании перевозчика.
  • список прицепов: </resources/{company_id}/trailers GET>:
    
    • company_id – uuid компании перевозчика;
• получить данные конкретного ресурса – используйте метод:
  • получить водителя: </resources/{company_id}/drivers/{driver_id} GET>:
    • company_id – uuid компании перевозчика;
    • driver_id – uuid водителя.
  • получить ТС: </resources/{company_id}/cars/{car_id} GET>:
    • company_id – uuid компании перевозчика;
    • car_id – uuid ТС.
  • получить Прицеп: </resources/{company_id}/trailers/{trailer_id} GET>:
    • company_id – uuid компании перевозчика;
    • trailer_id – uuid прицепа.
• внести изменения в карточку ресурса – используйте метод:
  
  • получить водителя: </resources/{company_id}/drivers/{driver_id} PUT>:
    • company_id – uuid компании перевозчика;
    • driver_id – uuid водителя.
  • получить ТС: </resources/{company_id}/cars/{car_id} PUT>:
    • company_id – uuid компании перевозчика;
    • car_id – uuid ТС.
  • получить Прицеп: </resources/{company_id}/trailers/{trailer_id} PUT>:
    • company_id – uuid компании перевозчика;
    • trailer_id – uuid прицепа.

Участие в торгах

Ниже представлен сокращённый перечень методов, необходимых для участия в торгах.

Ограничения: 

• доступные типы торга – «Кто быстрее», «Аукцион»;
• объект торга – «Разовая заявка».

Рассмотрим последовательность действий и то, какие методы должны быть использованы:

• получить перечень разовых заявок в торге – используйте метод </request_view GET>. 
  
  • если в ответ получен непустой список, то по каждой заявке требуется принятия решения:
    • бронировать заявку с типом торга «Кто быстрее» – используйте метод </shipping_requests/{shipping_request_id}/reserve POST>;
    • принять участие в торге по заявке с типом торга «Аукцион» (используйте метод </shipping_requests/{shipping_request_id}/bids POST>;
      • получить перечень торгов, с активной ставкой – используйте метод </shipping_requests/{shipping_request_id}/bids GET>;
        
        • отменить ставку – используйте метод </shipping_requests/{shipping_request_id}/bids/{bid_id}/archive PUT>;
        • изменить ставку – используйте метод </shipping_requests/{shipping_request_id}/bids POST>;
• получить перечень заявок, по которым торг завершён успешно – используйте метод </shippings GET>;
• получить заявку по ID  – используйте метод </request_view/{id} GET>

Назначение ресурсов

Ниже представлен сокращённый перечень методов, необходимых для участия в торгах. Рассмотрим последовательность действий и то, какие методы должны быть использованы:

• получить перечень заявок в статусе На оформлении используйте метод </shippings GET> status = "resources_waiting":
  • если в ответ получен непустой список, то по каждой заявке требуется принятия решения - какие ресурсы назначить.
• получить ресурсы для назначения:
  • получить перечень подходящих Водителей – используйте метод </resources/drivers&suitable_for_shipping=UUID GET>;
  • получить перечень подходящих ТС – используйте метод </resources/cars&suitable_for_shipping=UUID GET>;
  • получить перечень подходящих Прицепов – используйте метод </resources/trailers&suitable_for_shipping=UUID GET>.
• назначить ресурсы на заявку – используйте метод </shippings/{shipping_id}/assign_resources POST>.

Функциональная карта Грузовладельца

Авторизация

Для того, чтобы начать работу на платформе необходимо получить токен, авторизоваться и обновлять токен.

• получить токен – используйте метод </auth/token POST>. 

Пример просмотра ссылки на метод (обращение к боевой API):

Работа с партнёрами

Ниже представлен сокращённый перечень методов по работе с партнёрами.

Ограничения: 

• отправка запросов и отзыв запросов – в ЛК;
• настройка групп (создание, редактирование, удаление) – в ЛК;
• управление ЧС – в ЛК.

Рассмотрим последовательность действий и то, какие методы должны быть использованы:

• получить список партнёров – используйте метод <partnerships GET>.  
  • если в ответ получен непустой список, то по каждому партнёру можно отдельно получить всю информацию:
    • получить информацию по конкретному партнёру – используйте метод <partnerships GET>, в параметре q указать Человекочитаемый ID партнёра, название компании партнёра или ИНН партнёра.
• получить список групп партнёров – используйте метод <partnerships/groups GET>: 
  • в ответ получен непустой список, то по каждой группе партнёров можно отдельно получить всю информацию:
    • получить информацию по конкретной группе партнёров - используйте метод <partnerships/groups GET>, в параметре q: указать Человекочитаемый ID группы.

Создание Заказа

Ниже представлен сокращённый перечень методов, необходимых для публикации заявки в торгах.

Ограничения: 

• доступные типы торга – «Кто быстрее», «Аукцион» (3 типа);
• объект торга – «Разовая заявка»;
• создание черновиков – доступно.

Рассмотрим последовательность действий и то, какие методы должны быть использованы:

• создать Заказ – используйте метод <shipping_orders GET>.  

  • настройка этапов торга:

    • в параметре "auction_stages" требуется передать массив из этапов торгов.

  • настройка типа торга:

    • тип торга Кто быстрее – в параметре "auction_stages", в переданном значении этапа торга указать в параметре "auction_type" значение "instant_reservation";

    • тип торга Аукцион (Открытый) – в параметре "auction_stages", в переданном значении этапа торга указать в параметре "auction_type" значение "auction";

    • тип торга Аукцион (Закрытый) – в параметре "auction_stages", в переданном значении этапа торга указать в параметре "auction_type" значение "blind_auction";

    • тип торга Аукцион (На понижение) – в параметре "auction_stages", в переданном значении этапа торга указать в параметре "auction_type" значение "descending_price_auction";

    • Для аукционов - в параметре "auction_stages", в переданном значении этапа торга указать в параметре "winner_selection_type" значение "automatically" (значение по умолчанию).

  • настройка получателей

    • используйте ОПФ из списка:

      ОПФ

      {"id":1,"code":"12300","name":"ООО"},
      {"id":2,"code":"12267","name":"ЗАО"},
      {"id":3,"code":"12247","name":"ПАО"},
      {"id":4,"code":"50102","name":"ИП"},
      {"id":5,"code":"12200","name":"АО"}

    • публикация Все исполнители – в параметре "auction_stages", в переданном значении этапа торга указать в параметре "visibility" значение "all";

    • публикация Все партнёры – в параметре "auction_stages", в переданном значении этапа торга указать в параметре "visibility" значение "partners";

    • публикация Выбранные партнёры – в параметре "auction_stages", в переданном значении этапа торга указать в параметре "visibility" значение "exclusive":

      • перечисление партнёров: в параметре "companies_ids" в массиве передать список из ID компаний, среди которых будет виден заказ;

      • перечисление групп партнёров: в параметре "groups_ids" в массиве передать список из ID групп, среди которых будет виден заказ.

  • заполнение данных Отправителя / Получателя в точке маршрута:
    • ЮЛ (в т. ч. ИП), в блоке "route_points" (массив точек маршрута), для каждой точки требуется:
      • передать значение параметра "contact_company_title";
      • передать значение параметра "contact_inn";
      • передать значение параметра "contact_kpp";
      • передать значение параметра "contact_opf_code";
      • передать значение параметра "contact_opf_name".
      • в параметре "contacts" требуется передать массив контактных лиц:
        • значение параметра "full_name;
        • значение параметра "phone".
    • ФЛ, в блоке "route_points" (массив точек маршрута), для каждой точки требуется:
      • в параметре "contacts" требуется передать массив контактных лиц:
        • значение параметра "full_name";
        • значение параметра "phone";
        • значение параметра "passport_number";
        • значение параметра "passport_issued_at";
        • значение параметра "passport_who_issued".

Работа с Заказом

Ниже представлен сокращённый перечень методов, необходимых для работы с заявкой после торга. Рассмотрим последовательность действий и то, какие методы должны быть использованы:

• получить перечень Заказов в статусе В торге – используйте метод <shipping_orders GET> в параметре "status" передать значение "in_auction"
  • если в ответ получен непустой список, то по каждой заявке требуется принятия решения:
    • получить информацию по конкретной заявке – используйте метод <shipping_orders/{shipping_order_id} GET> в запросе необходимо передавать параметр "shipping_order_id" – uuid Заказа;
• получить перечень заявок в статусе На исполнении используйте метод <shipping_orders GET> в параметре "status" передать значение "in_trip" (в Пути) или "trip_waiting" (Предстоящая перевозка):
  • если в ответ получен непустой список, то по каждой заявке требуется принятия решения:
    • получить информацию по конкретной заявке – используйте метод <shipping_orders/{shipping_order_id} GET> в запросе необходимо передавать параметр "shipping_order_id" – uuid Заказа;
• утверждение заявки – используйте метод </shipping_orders/{shipping_order_id}/accept_shipping POST>
  • на данном этапе требуется указать данные, которые были не обязательными для торга, но обязательны для выполнения заявки:
    • точные адреса по точкам, в блоке "route_points" (массив точек маршрута);
    • данные о грузоотправителе / грузополучателе (данные о компании и контактное лицо):
      • ЮЛ (в т. ч. ИП), в блоке "route_points" (массив точек маршрута), для каждой точки требуется:
        • передать значение параметра "contact_company_title";
        • передать значение параметра "contact_inn";
        • передать значение параметра "contact_kpp";
        • передать значение параметра "contact_opf_code";
        • передать значение параметра "contact_opf_name";
        • в параметре "contacts" требуется передать массив контактных лиц:
          • значение параметра "full_name";
          • значение параметра "phone".
      • ФЛ, в блоке "route_points" (массив точек маршрута), для каждой точки требуется:
        • в параметре "contacts" требуется передать массив контактных лиц:
          • значение параметра "full_name";
          • значение параметра "phone";
          • значение параметра "passport_number";
          • значение параметра "passport_issued_at";
          • значение параметра "passport_who_issued".
• подписание заявки ПЭП – происходит автоматически при утверждении заявки;
• подтверждение выполнения – используйте метод <shippings/{shipping_id}/done POST>:
  • в запросе необходимо передавать параметр "shipping_order_id" – uuid Заказа.
• отмена заявки – используйте метод <cancel POST>;
• получить перечень заявок в статусе В архиве – используйте метод <shipping_orders GET> в параметре "status" передать значение ['completed', 'canceled_by_cargo_owning_company','canceled_by_transport_company']:
  • если в ответ получен непустой список, то по каждой заявке требуется принятия решения:
    • получить информацию по конкретной заявке - используйте метод <shipping_orders/{shipping_order_id} GET> в запросе необходимо передавать параметр "shipping_order_id" – uuid Заказа.