API для работы с Заказами

Используемые термины

ТС - транспортное средство, которое осуществляет перевозку груза по Заказу.

Водитель - водитель, который осуществляет перевозку груза по Заказу.

Реквизиты - юридическая информация о перевозчике, который перевозит груз по Заказу.

Заказ - перевозка, которая оформляется через сайт ATI.SU. Помимо сведений о грузе, сущность Заказа содержит информацию о ТС, водителе, реквизитах, статусе заказа, статусе перевозки и прочем.

Взятие груза - предоставление перевозчиком информации о ТС, водителе и реквизитах. Если на момент взятия груза заказ еще не был создан, то он создается.

После создания Заказа, груз уходит в архив, а при отмене Заказа - возвращается в публикующиеся.

Завершение Заказа - статус Заказа меняется на «завершён». Грузовладелец и перевозчик завершают Заказ независимо друг от друга, то есть один и тот же Заказ может быть завершённым для перевозчика, но ещё не завершённым для грузовладельца.

Отмена Заказа - статус Заказа меняется на «отменён». Грузовладелец и перевозчик могут отменить Заказ до его завершения.

Статус Заказа - текущее состояние Заказа: груз зарезервирован перевозчиком, грузовладелец отправил документ-заявку перевозчику и прочее. Полный список статусов содержится в описании метода API на получение информации по Заказу

Статус перевозки - состояние водителя и ТС: ожидает загрузки, едет на выгрузку, поломка и т.д. Полный список статусов содержится в описании метода API на смену статуса перевозки.

Приложение АТИ Водитель - приложение ATI.SU для мониторинга грузов и транспорта

GPS Устройство - любой источник географических данных

Возможности API

API Заказов позволяет работать с Заказами.

С помощью API и грузовладелец, и перевозчик могут:

Грузовладелец может:

Перевозчик может:

Создание и выполнение Заказа

order_flow

Для начала работы с заказом через API требуется груз. Заказ может быть создан несколькими способами.

При взятии перевозчиком груза на Площадке

Грузовладелец размещает груз на Площадке. Перевозчик, который состоит на этой Площадке, видит груз и берёт его. Заказ создан.

Автоматически для победителя Торгов

Грузовладелец проводит Торги. Участники соревнуются за груз, и один из них побеждает. Для победителя автоматически создаётся Заказ.

Заказ создаётся с незаполненной информацией о ТС, водителе и реквизитах. Для дальнейшей работы с заказом перевозчик должен взять груз.

При отправке персонального приглашения

Грузовладелец размещает груз и высылает персональное приглашение конкретному перевозчику. После того, как перевозчик взял груз, создаётся Заказ.

Важно!

В момент взятия груза создаётся его копия, а сам груз при этом переходит в архив. Заказ будет содержать в себе именно копию, а не сам груз. Это нужно, чтобы зафиксировать состояние груза на тот момент, когда его взяли.

Копия груза будет содержать ссылку на оригинальный груз, поэтому всегда будет возможность его получить

Заказ для грузовладельца

Одобрение заявки без создания документов на перевозку

После того, как перевозчик взял груз, грузовладелец может одобрить заявку без создания документов.

В этом случае Заказ сразу будет отправлен перевозчику в работу, и он может приступить к выполнению.

Создание документов на перевозку

После того, как перевозчик взял груз, грузовладелец может создать документ на перевозку.

Если перевозчик изменит свое предложение после отправки документа, его нужно будет создать заново.

Одобрение, возврат на доработку, и отмена Заказа производятся через API АТИ-Доков

Заказ в работе

Перевозчик подтверждает документ (если Заказ был создан с документами на перевозку) и приступает к выполнению Заказа. После начала выполнения Заказа грузовладелец может изменять ставку, статус перевозки, а также создать счет или акт по Заказу.

Заказ завершен

Заказ завершен и перенесен в архив перевозчиком или грузовладельцем

Внимание!

Заказ можно отменить на этапе согласования или после того, как он взят в работу. При отмене Заказа (созданного с документами в АТИ-Доках) в работе вам потребуется создать уведомление о расторжении. Дальнейшее оформление происходит в АТИ-Доках.

Заказ для перевозчика

Взятие груза

Для дальнейшей работы с Заказом перевозчик должен взять груз.

Для взятия груза понадобятся ТС, водитель и реквизиты. Водителя и ТС можно получить с помощью API Справочников пользователя, а реквизиты - через API Фирм.

Одобрение документов

После создания заказа перевозчик ждёт от грузовладельца документы на перевозку или подтверждения заявки без создания документов на перевозку. Если грузовладелец создал Заказ с документами на перевозку, перевозчик может одобрить документы и начать выполнение заказа.

Одобрение, возврат на доработку, и отмена Заказа производятся через API АТИ-Доков.

Заказ в работе

После начала выполнения Заказа, перевозчик может изменять статус перевозки, а также создать счет или акт по Заказу.

Завершение Заказа

После выполнения Заказа перевозчик может завершить Заказ.

Внимание!