Доставки

Мы работаем только через POST-запросы

Обратите внимание, что цены в webhook доставки не передаются. При необходимости подсчетов ориентируйтесь на ваши идентификаторы товара.

Для подключения вебхука доставок обратитесь к вашему менеджеру в IMSHOP.IO

IMSHOP.IO передаёт состав корзины, город (и страну), а также промокод и идентификатор пользователя, если они есть; в ответ IMSHOP.IO ожидает список доступных способов доставки.

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

Формат запроса и пример

Пример

POSThttps://api-imshop.store.ru/v1/deliveries

{
    "externalUserId": "XXXXXX",
    "country": "RU",
    "hasPreorderItems": true,
    "promocode": null,
    "bonusesSpent": 123,
    "position": "checkout",
    "legalEntityMode": true,
    "addressData": {
        "apt": null,
        "area": null,
        "areaFias": null,
        "areaKladr": null,
        "building": null,
        "city": "Омск",
        "cityFias": "140e31da-27bf-4519-9ea0-6185d681d44e",
        "cityKladr": "5500000100000",
        "city_kladr": "5500000100000",
        "fias": "140e31da-27bf-4519-9ea0-6185d681d44e",
        "fiasCode": "55000001000000000000000",
        "fias_code": "55000001000000000000000",
        "fias_id": "140e31da-27bf-4519-9ea0-6185d681d44e",
        "house": null,
        "houseFias": null,
        "houseKladr": null,
        "kladr": "5500000100000",
        "lat": "54.98",
        "lon": "73.36",
        "region": "Омская",
        "regionFias": "05426864-466d-41a3-82c4-11e61cdc98ce",
        "regionKladr": "5500000000000",
        "settlement": null,
        "settlementFias": null,
        "settlementKladr": null,
        "settlementWithType": null,
        "street": null,
        "streetFias": null,
        "streetKladr": null,
        "value": "г Омск",
        "zip": "644000"
    },
    "items": [
        {
            "name": "Тестовый товар 1",
            "id": "3677482",
            "privateId": "3677483",
            "configurationId": "3677483",
            "quantity": 1
        },
        {
            "name": "Тестовый товар 2",
            "id": "6237828",
            "privateId": "6237830",
            "configurationId": "6237830",
            "quantity": 1
        }
    ]
}

Описание формата

  • externalUserId — идентификатор покупателя на стороне клиента, если тот авторизован в мобильном приложении, null по умолчанию

  • country — ISO код страны, RU

  • bonusesSpent - списанные бонусы

  • hasPreorderItems — в случае если в запросе товары с предзаказом

  • promocode — прикрепленный промокод, null по умолчанию

  • position — источник вызова хука, (checkout, deliveryWidget), можно использовать для определения где вызван хук и передавать в карточку товара уменьшенную выборку или отсортировав по другому

  • skipPickupLocations — если этот параметр передан, и он равен true, то в ответе достаточно передать только способ самовывоза, и не передавать все доступные точки получения заказа

  • legalEntityMode – передается и имеет значение true, если при оформлении заказа выбрано юридическое лицо

  • items - список товаров в корзине

    • id — идентификатор товара в системе клиента (group_id из фида)

    • configurationId — идентификатор товарного предложения в системе клиента (идентификатор id из фида)

    • privateId — идентификатор товарного предложения в системе клиента (идентификатор id из фида)

    • quantity — количество

  • addressData — полная информация о адресе, прошедшая валидацию DaData

Для маркетплейсов.

В полях запроса для каждого товара могут быть переданы идентификаторы магазина/ООО (в разработке).

  • warehouseId — (опционально) идентификатор склада/магазина/аутлета/ООО из фида наличия для маркетплейсов.

{    
    ...
    "items": [
        {
            ...
            "warehouseId": "AF-1416"
            ....
        }
    ]
    ...
}

В запросе может приходить гораздо больше информации. Например, для товаров могут приходить названия.

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

Формат ответа и пример

Если в ответе не будут отданы ВСЕ ❗обязательные поля - в приложении не отобразятся доставки

Описание формата

  • deliveries — список доступных способов доставки, массив

    • ❗id — идентификатор, строка (обязательное поле)

    • ❗title — название, строка (обязательное поле)

    • description — описание, строка

    • ❗type — тип (delivery, pickup — доставка или самовывоз) (обязательное поле)

    • ❗hasPickupLocations — способ доставки требует выбора пункта самовывоза (особенно важно при ответе на запросы со skipPickupLocations = true) (обязательное поле)

    • ❗price — минимальная цена, цифра (обязательное поле)

    • priceLabel — цена в свободной форме; строка; приоритетнее поля price

    • ❗min — минимальный срок доставки (0 - сегодня, 1 - завтра, 2-послезавтра, 3- от 3 дней) (обязательное поле)

    • max — максимальный срок доставки (0 - сегодня, 1 - завтра итд)

    • timeLabel — время доставки в виде текста (отображается на экране выбора способа доставки)

    • locations — список ПВЗ (если type = pickup и требуется выбор пункта самовывоза, и в запросе не передан skipPickupLocations = true)

      • ❗id — идентификатор самовывоза, строка (обязательное поле)

      • ❗title — название, строка (обязательное поле)

      • ❗address — адрес, строка (обязательное поле)

      • ❗city — город, строка (обязательное поле)

      • time — расписание / время работы, строка

      • subway — ближайшая станция метро, строка

      • mall — название ТЦ, если не указывается в поле title

      • ❗lat — широта для отображения на карте, строка (обязательное поле)

      • ❗lon — долгота для отображения на карте, строка (обязательное поле)

      • ❗price — цена доставки в этот ПВЗ, цифра (обязательное поле)

      • ❗min — ожидаемое время доставки (0 - сегодня), цифра (обязательное поле)

      • timeLabel — время доставки в виде текста (отображается на экране выбора пункта получения заказа и на экране описания пункта самовывоза), строка

      • notice - (в разработке) опционально, выделенный текстовый блок, например, чтобы уведомить покупателя, что не все товары доступны в данном ПВЗ

      • tags — список тэгов у ПВЗ. Можно использовать тип пункта (пункт выдачи, постомат и т.д.), так и наименования (СДЭК, Boxberry, 5post)

      • mapIcon — кастомная иконка пункта выдачи

      • infoTags — информационные теги, например: "Только по паспорту" и т.п.

        • ❗title — название тега

        • modal — (опционально) активируется возможность нажать на тег чтобы открыть модалку с пояснением.

          • ❗title — заголовок

          • ❗description — описание/пояснение

    • groupName — (опционально) идентификатор для группировки, строка (способы доставки, у которых значение группы совпадает, схлопываются в один пункт; после его выбора, пользователь увидит все пункты, входящие в эту группу)

Пример

{
    "deliveries": [
        {
            "id": "regular",
            "title": "Доставка курьером",
            "hasPickupLocations": false,
            "description": "Доставка курьерской службой по города на следующий день",
            "type": "delivery",
            "price": 350,
            "min": 1,
            "timeLabel": "На следующий день"
        },
        {
            "id": "pickup",
            "title": "Самовывоз из магазина",
            "hasPickupLocations": true,            
            "description": "Самовывоз заказа из магазина в день заказа",
            "type": "pickup",
            "price": 0,
            "min": 0,
            "timeLabel": "В день заказа",
            "locations": [
              {
                "id": "a0001",
                "title": "Гидропроект",
                "address": "Волоколамское шоссе 2",
                "city": "Москва",
                "time": "Каждый день с 10 до 22",
                "subway": "Сокол",
                "mall": "",
                "lat": "55.8078034",
                "lon": "37.5054127",
                "price": 0,
                "min": 0,
                "timeLabel": "Сегодня после 14:00",
                "infoTags": [
                  {
                    title: "Вручение только по паспорту",
                    modal: {
                      title: "Заголовок",
                      description: "Описание/пояснение"
                    }
                  }
                ]
            }
          ]
        }
    ]
}

Кастомное сообщение если доставка недоступна

message - (опционально) текст который вы хотите отобразить юзеру если доставка недоступна 

{
"deliveries":[],
"message": "Заказ недоступен в этом регионе"
}

Интервалы доставки

Могут быть добавлены в любой из элементов списка доставок, имеющих тип delivery

  • dateIntervals — список доступных интервалов, привязанных к датам.

    • id — идентификатор в вашей системе, число или строка.

    • title — название (конкретная дата), строка.

      subTitle — пояснение (день недели), строка.

    • timeIntervals — список доступных интервалов, привязанных ко времени.

      • id — идентификатор в вашей системе, число или строка.

      • title — название (отрезок времени), строка.

      • price — (опционально) цена доставки в определенный интервал, число; используется в случае, когда таймслоты варьируются по стоимости (напр. вечерняя доставка - дороже).

Фильтрация точек получения

Для отображения фильтров, у каждого пункта выдачи (в списке locations) необходимо передать список тэгов (tags)

tags — список тэгов у ПВЗ. Можно использовать тип пункта (пункт выдачи, постомат и т.д.), так и наименования (СДЭК, Boxberry, 5post)

Пример:

{
    "deliveries": [
        {
            "id": "pickup",
            "title": "Самовывоз из магазина",
            "hasPickupLocations": true,            
            "description": "Самовывоз заказа из магазина в день заказа",
            "type": "pickup",
            "price": 0,
            "min": 0,
            "timeLabel": "В день заказа",
            "locations": [
              {
                "id": "a0001",
                "title": "Гидропроект",
                "address": "Волоколамское шоссе 2",
                "city": "Москва",
                "time": "Каждый день с 10 до 22",
                "subway": "Сокол",
                "mall": "",
                "lat": "55.8078034",
                "lon": "37.5054127",
                "price": 0,
                "min": 0,
                "timeLabel": "Сегодня после 14:00",
                "tags": ["ПВЗ", "СДЭК"]
            }
          ]
        }
    ]
}
PreviousОформление заказаNextОплаты

Last updated