Введение в API

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

Заказ — это первоначальный объект, который создается в нашей системе. Заказ включает в себя список товаров/грузов которые необходимо доставить. Заказ состоит из накладных на каждый груз и нужен, чтобы клиент смог собрать все необходимые накладные для перевозки. В рамках одного заказа может быть несколько накладных.

Накладная — это объект, который сопровождает груз и содержит информацию о товаре. В системе она используется для отслеживания статусов доставки и может содержать данные о грузе, его характеристиках, отправителе и получателе, маршруте и услугах, предоставленных в процессе транспортировки.

Накладные представлены вам в виде электронного документа PDF. После создания заказа, вы должны распечатать каждую накладную этого заказа и передать курьеру Spark вместе с товаром.

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

Дополнительные услуги — это услуги, которые могут быть добавлены к основному заказу и накладной по желанию. Дополнительные услуги могут быть при заборе и при доставке. Эти услуги включают:

• Мягкую упаковку
• Обрешетку
• Манипулятор
• Кран
• Рохлю
• Грузчиков

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

Обрешетка: Конструкция, состоящая из деревянных элементов, используемая для создания каркаса под крышу, стены или пол. Обрешетка служит для распределения нагрузки и обеспечения прочности конструкции.

Манипулятор: Механизм для управления грузом и перемещения в транспорт.

Кран: Строительная техника, предназначенная для подъема и перемещения тяжелых предметов.

Рохля: Ручная тележка для перемещения товаров.

Грузчики: Работники, занимающиеся погрузкой и разгрузкой товаров и грузов.