Мой постамат - первая в мире сеть постаматов, работающая по модели совместного использования


  • «Тапочковая» доступность постаматов для жителей города
  • Выдача заказов любых маркетплейсов, подключенных к проекту
  • Бесконтактная доставка и дополнительная идентификация курьеров

    • Схема

    Документация предназначена для осуществления доставки заказов в сети "Мой постамат". Сервис работает по протоколу HTTP и организован по принципу REST API. Передача данных осуществляется в формате JSON.

    Принцип взаимодействия ​

    Схема взаимодействия

    Получение списка постаматов ​

    Метод /auth/postamat/available предназначен для получения информации по доступным постаматам внешней системе.

    В ответе метода содержатся данные с информацией по каждому постамату, а именно:

    • Описание постамата postamats
    • Описание расположения location find
    • Изображения постамата photos
    • График работы workTime workTimeProfile
    • Виды и размеры доступных ячеек cellSizes
    • Наличие дополнительного оборудования machineEquipment
    • Даты, в которые постамат недоступен для закладки новых заказов dayOffs

    Рекомендуемый временной интервал обновления списка постаматов для внешней системы равен 15 минутам

    Схема взаимодействия
    Получение списка постаматов

    Операции с заказами ​

    Методы предназначены для создания и управления заказами, доставляемыми в сети "Мой постамат".

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

    Метод /order/create для создания заказа на платформе "Мой постамат". Генерация штрих-кодов, номера заказа осуществляется на стороне внешней системы.

    В части передачи идентификаторов заказа и товарных позиций внешняя система должна сгенерировать и передать уникальные значения в полях:

    • идентификатор заказа во внешней системе externalId
    • номер заказа во внешней системе number
    • идентификатор посылки barcode

    Заказ невозможно заложить в постамат если дата фактической доставки раньше даты доставки указанной в заказе dateDelivery. Если доставка заказа переносится на следущий день, то необходимо обновить dateDelivery. Обновление заказа осуществляется методом /order/update.

    Для минимизации случаев недоставки товара из-за переполности постамата и контроля доступности свободных ячеек постамата необходимо использовать данные dayOffs из метода /auth/postamat/available.

    Схема взаимодействия
    Создание заказа

    Обновление заказа ​

    Метод /order/update позволяет обновить ранее созданный заказ на доставку в системе "Мой постамат".
    При получении запроса от внешней системы, платформа осуществляет поиск ранее созданного заказа по идентификатору заказа externalId для последующего обновления объектов в заказе. Поиск товарной позиции будет произведен по идентификатору посылки barcode.

    Изменения возможно внести по следующим блокам:

    • дата доставки dateDelivery
    • данные клиента notification
    • данные по посылкам parcels
    • данные по позициям заказа clientInvoice

    Схема взаимодействия
    Обновление заказа

    Отмена позиции в заказе ​

    Метод /order/place/cancel позволяет отменить позицию заказа.

    Отмена возможна при следующих статусах заказа:

    • Новый
    • Загружено курьером (заказ переводится в статус ожидает возврата для забора его из постамата курьером)

    Схема взаимодействия
    Отмена заказа

    Получение детальной информации о локации заказа ​

    Метод /order/detail позволяет получить данные по уже созданному заказу. Метод вернет следующие данные:

    • Данные о локации location
    • График доступности локации workTimeProfile
    • Гайд по доступу к локации (код доступа к домофону) pointAccess
    • Идентификатор постамата idPoint

    Схема взаимодействия
    Данные о заказе

    Маршрутизация курьеров ​

    Для осуществления доставки в постамат необходимо создать маршрутный лист курьера. Метод /couriers/courier-with-route позволяет назначить курьера на доставку в постамат.

    В маршрутном листе должны содержаться следующие данные:

    • информация по курьеру courier
    • информация по дате доставке и маршруту курьера (списку постаматов для доставки) route

    Для осуществления доставки товаров в постамат отдельной регистрации курьера не требуется

    В ответе будет содержаться код авторизации курьера на постамате postamatAccessCode.

    Логика при создании маршрутного листа:

    • Платформа при создании маршрутного листа осуществляет маппинг записей курьера по внешнему идентификатору (externalId) и регистрирует курьера, при отсутствии совпадений по идентификатору. В случае, когда курьер в системе найден - платформа обновит его данные.
    • Для одного курьера на выбранную дату доставки, может быть, создано несколько маршрутных листов.
    • Все созданные маршрутные листы действительны не позже указанной даты доставки.

    Создание маршрутного листа

    Получение уведомлений об изменении статуса заказа ​

    Для получения уведомлений об изменении статусов заказа на стороне внешней системы должен быть реализован сервис, который принимает запросы от платформы "Мой постамат" в соответствии со спецификацией.