Оплаты

IMSHOP Retail Protocol (IRP) является объектом интеллектуальной собственности ООО «АЙ ЭМ СОЛЮШНЗ» (IMSHOP) и защищён как объект авторского права. Свидетельство о депонировании произведения № 023-014461 от 16 января 2023 г. подтверждает исключительные права ООО «АЙ ЭМ СОЛЮШНЗ» на данные технологии.

IMSHOP Retail Protocol создан по заказу ООО «АЙ ЭМ СОЛЮШНЗ». Использование IMSHOP Retail Protocol допустимо только при взаимодействии с ООО "АЙ ЭМ СОЛЮШНЗ" и наличии действующего лицензионного договора. Более подробно можно ознакомиться здесь.

Выбор способа оплаты (слева — пошаговое оформление заказа, справа — на одной странице)

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

Пример

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

{
    "externalUserId": "XXXXXX",
    "country": "RU",
    "hasPreorderItems": true,
    "city": "Москва",
    "promocode": null,
    "deliveryId": "14",
    "pickupLocationId": "100",
    "bonusesSpent": 250,
    "legalEntityMode": true,
    "items": [
        {
            "name": "Тестовый товар 1",
            "id": "00a03026-412a-54fe-a9df-dcf9325f8618",
            "privateId": "3464",
            "configurationId": "3464",
            "quantity": 1
        },
        {
            "name": "Тестовый товар 2",
            "id": "605e0108-dc95-5dab-95a2-7f459da6aade",
            "privateId": "29117",
            "configurationId": "29117",
            "quantity": 1
        }
    ]
}

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

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

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

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

• city — стандартизированное имя города из системы ФИАС (или UUID ФИАС, в зависимости от настроек)

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

• deliveryId — идентификатор выбранного способа доставки, см. «Доставки»

• pickupLocationId — выбранный пункт получения заказа, см. «Доставки» (null, если доставка или не подразумевает выбора ПВЗ)

• bonusesSpent — кол-во бонусов которые пользователь планирует потратить

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

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

  • id — идентификатор товара в IMSHOP.IO

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

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

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

Маркетинговые акции, активированные в корзине

Ритейлер имеет возможность предложить альтернативные условия: отключение рассрочки из-за примененной скидки, оплата только онлайн из-за лимитированности подарков и т.д.

Доп. поле promoGroup передаётся в запрос списка оплат. Описание формата приведено в разделе Список "Маркетинговые акции"

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

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

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

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

Ответ

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

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

• payments — список доступных способов оплаты

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

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

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

  • deliveryDiscount— процент скидки на выбранную доставку (если для оплаты доставка бесплатна, то 100), число 0-100

  • ❗type — тип из перечисленных (обязательное поле):

    • cash - оплата наличными

    • card_on_delivery - картой курьеру или при получении

    • card - картой в приложении

    • iOS - Apple Pay

    • android - Google Pay

  • autoVerification — включить автопроверку платежа для данного способа оплаты, boolean

Пример

{
    "payments": [
        {
            "id": "13",
            "title": "Оплата наличными при получении",
            "description": "Оплата наличными курьеру при получении заказа",
            "type": "cash"
            "autoVerification": true
        },
        {
            "id": "001",
            "title": "Картой в приложении",
            "description": "Оплата картой visa или mastercard в приложении",
            "type": "card",
            "deliveryDiscount": 30,
            "autoVerification": false
        }
    ]
}

Виджет рассрочки в списке оплат

widget - виджет в котором детально описывается правило рассрочки для пользователя

description - описание рассрочки

paymentGraphic - детализация графика платежей

periodDescription - описание конкретного периода оплаты, как правило пишется дата

periodPrice - цена конкретного периода оплаты

progress - процентное разделение платежа

{
    "payments":
    [
        {
            "description": "В рассрочку",
            "icon": "https://imshop.io/icons/1.png",
            "iconSize": 32,
            "id": "split",
            "title": "Сплит – частями",
            "widget":
            {
                "description": "Без переплат. Доступно на 4 месяца."
                "paymentsGraphic":
                [
                    {
                        "periodDescription": "Сегодня",
                        "periodPrice": 1000000,
                        "progress": 25
                    },
                    {
                        "periodDescription": "12 ноя.",
                        "periodPrice": "1 000 000 руб.",
                        "progress": 25
                    },
                    {
                        "periodDescription": "12 дек.",
                        "periodPrice": "1 000 000 руб.",
                        "progress": 25
                    },
                    {
                        "periodDescription": "12 янв,",
                        "periodPrice": "1 000 000 руб.",
                        "progress": 25
                    }
                ]
            }
        }
    ]
}