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

Авторизация

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

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

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

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

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

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

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

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

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

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

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

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

• Доступные типы торга - Кто быстрее, Аукцион
• Объект торга - Разовая заявка

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

1. Получить перечень разовых заявок в торге - используйте метод </request_view GET>. 
   
   1. Если в ответ получен непустой список, то по каждой заявке требуется принятия решения:
      1. Бронировать заявку с типом торга Кто Быстрее - используйте метод </shipping_requests/{shipping_request_id}/reserve POST>.
      2. Принять участие в торге по заявке с типом торга Аукцион (используйте метод </shipping_requests/{shipping_request_id}/bids POST>.
         1. Получить перечень торгов, с активной ставкой - используйте метод </shipping_requests/{shipping_request_id}/bids GET>
            
            1. Отменить ставку - используйте метод </shipping_requests/{shipping_request_id}/bids/{bid_id}/archive PUT>
            2. Изменить ставку - используйте метод </shipping_requests/{shipping_request_id}/bids POST>.
2. Получить перечень заявок, по которым торг завершён успешно - используйте метод </shippings GET>.
3. Получить заявку по ID  - используйте метод </request_view/{id} GET>

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

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

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

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

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

Авторизация

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

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

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

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

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

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

• Отправка запросов и отзыв запросов - в ЛК
• Настройка групп (создание, редактирование, удаление) - в ЛК
• Управление ЧС - в ЛК 

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

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

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

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

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

• Доступные типы торга - Кто быстрее, Аукцион (3 типа)
• Объект торга - Разовая заявка
• Создание черновиков - не доступно

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

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

   1. Настройка этапов торга:

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

   2. Настройка типа торга 

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

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

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

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

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

   3. Настройка получателей -

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

         Подсказка
         title ОПФ
         {"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":"АО"}

         
         

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

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

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

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

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

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

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

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

Остались вопросы?

1. Посмотри раздел 

   UI Button
   color green icon question title Вопросы и ответы url http://wiki.traffic.online/pages/viewpage.action?pageId=327718

2. Позвони 8(800)707-007-1
3. Напиши вопрос на info@traffic.online
4. Сообщи о проблеме на support@traffic.online