Интеграция с YCP

Скопировать ссылку на статью

Скопировано

Содержание

1. Интеграция с YCP

2. Подключение сервиса в RetailCRM

   • Активируйте модуль
   • Добавьте аккаунт YCP
   • Укажите данные подключения в YCP

3. Настройки аккаунта

   • Адрес подключения
   • Токен YCP
   • Магазин RetailCRM
   • Активность аккаунта
4. Настройки оплат
5. Настройки доставок
6. Настройки статусов заказа
7. Настройки статусов товарных позиций
8. Склады и самовывоз
9. Проверка корзины и остатков
10. Создание и подтверждение заказа
11. Отмена и завершение заказа
12. Особенности работы

1. Интеграция с YCP

Сервис Yandex Checkout подключает RetailCRM к чекауту по протоколу YCP (Yandex Commercial Protocol).

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

Для этого сервис:

• проверяет товары, цены и остатки в RetailCRM по запросам со стороны чекаута;
• обрабатывает запросы на получение складов и точек самовывоза из RetailCRM;
• создает заказ в RetailCRM при старте оформления в чекауте;
• передает в RetailCRM данные заказа и последующие изменения: доставку, оплату, статусы заказа и товарных позиций согласно настройкам сопоставления.

Важно!

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

2. Подключение сервиса в RetailCRM

Для подключения модуля выполните несколько шагов.

Активируйте модуль

Перейдите в Настройки → Маркетплейс → CMS.

Найдите модуль YCP и нажмите Подключить.

При подключении RetailCRM передает сервису нужные права доступа к API (Application Programming Interface). Отдельно создавать API-ключ в RetailCRM не требуется.

После успешной активации перейдите в Настройки → Заказы. Внизу списка появится пункт меню «YCP». На этой странице добавляются и настраиваются подключения магазинов RetailCRM к чекауту.

Добавьте аккаунт YCP

Откройте страницу «Аккаунты YCP» и нажмите Добавить.

В форме добавления отображаются:

• «Адрес подключения» — базовый адрес YCP API сервиса;
• «Токен YCP» — токен для авторизации запросов от чекаута;
• «Магазин RetailCRM» — магазин, к которому будет привязан аккаунт.

Выберите магазин RetailCRM и нажмите Сохранить.

Важно!

Один аккаунт YCP можно привязать только к одному магазину RetailCRM. Если магазин уже используется в другом аккаунте YCP, он не будет доступен для выбора при добавлении нового аккаунта.

Если нужно подключить несколько магазинов, создайте отдельный аккаунт YCP для каждого магазина.

Укажите данные подключения в YCP

Скопируйте «Адрес подключения» и «Токен YCP» из настроек аккаунта.

В личном кабинете YCP-чекаута укажите:

• адрес подключения, например https://example.com;
• токен YCP.

В блоке «URL для API и токен доступа» нажмите на иконку карандаша, чтобы открыть редактирование URL и токена доступа.

Важно!

Значение Token API YCP в личном кабинете настроек чекаута в данной интеграции не используется, поэтому менять его не нужно.

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

Если после сохранения данных в кабинете чекаута проверочный запрос не проходит, сначала проверьте, что токен и адрес подключения скопированы полностью из настроек аккаунта.

3. Настройки аккаунта

В блоке «Аккаунт» отображаются основные параметры подключения.

Адрес подключения

Адрес подключения формируется сервисом автоматически. Его нужно скопировать и вставить в кабинет чекаута.

В интерфейсе отображается адрес, который нужно передать в YCP без ручного изменения.

Токен YCP

Токен используется для авторизации всех запросов от чекаута.

Если токен нужно заменить, нажмите Перегенерировать, затем сохраните изменения.

Важно!

Новый токен начнет действовать только после сохранения аккаунта. После сохранения старый токен перестанет авторизовывать запросы чекаута.

Магазин RetailCRM

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

Если в RetailCRM несколько магазинов, для каждого магазина нужно создать отдельный аккаунт YCP.

После смены магазина сохраните аккаунт и проверьте сопоставления оплат, доставок и статусов: справочники могут отличаться для разных магазинов и настроек CRM.

Активность аккаунта

На странице списка аккаунтов можно включить или выключить аккаунт.

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

4. Настройки оплат

В блоке «Оплаты» задается сопоставление способов оплаты чекаута с типами оплат RetailCRM.

Доступные способы оплаты, которые могут быть выбраны на стороне чекаута:

• «Оплата при доставке»;
• «Карта»;
• «СБП»;
• «Сплит»;
• «Сплит + СБП».

Для каждого способа оплаты выберите тип оплаты RetailCRM.

Все способы оплаты со стороны чекаута, кроме «Оплата при доставке», подразумевают, что заказ уже оплачен. Для них дополнительно выбирается статус оплаты RetailCRM. Список статусов зависит от выбранного типа оплаты: доступны только статусы, разрешенные для этого типа оплаты в RetailCRM.

Важно!

Для онлайн-заказа сервис создает оплату только после подтверждения заказа. Если для способа онлайн-оплаты не выбран тип оплаты RetailCRM или статус оплаты, подтверждение заказа не будет обработано корректно.

Для «Оплаты при доставке» статус оплаты не применяется.

Пример: если в чекауте был выбран способ оплаты «Карта», ему в настройках сервиса были сопоставлены тип оплаты RetailCRM «Банковская карта» и статус оплаты «Оплачен», то после подтверждения онлайн-заказа сервис создаст в заказе RetailCRM оплату с этими значениями.

5. Настройки доставок

В блоке «Доставки» задается сопоставление типов доставки чекаута с типами доставки RetailCRM.

Доступные варианты доставки:

• «Яндекс Доставка»;
• «CDEK»;
• «ПЭК»;
• «Почта России»;
• «Dalli»;
• «Самовывоз»;
• «Доставка продавца»;
• «YCP».

Для каждого варианта выберите отдельный тип доставки RetailCRM, который должен попасть в заказ.

Один тип доставки RetailCRM нельзя использовать для нескольких типов доставки чекаута.

Если вы не знаете заранее, какие варианты доставки будет передавать чекаут, заполните сопоставление для всех вариантов из списка. Так заказ не остановится из-за отсутствующей настройки.

Если заказ приходит с типом доставки, для которого не задано сопоставление, сервис не сможет создать заказ в RetailCRM.

6. Настройки статусов заказа

В блоке «Статусы заказа» задается сопоставление статусов чекаута со статусами RetailCRM.

Доступные статусы:

• «Создание заказа» — используется при первичном создании заказа в RetailCRM;
• «Оформление заказа» — устанавливается после подтверждения заказа в YCP;
• «Отмена заказа» — устанавливается при отмене оформления или отмене уже созданного заказа;
• «Завершение заказа» — устанавливается после передачи информации о доставленном заказе.

Каждый статус чекаута нужно сопоставить с отдельным статусом RetailCRM.

Например, «Создание заказа» можно сопоставить со статусом RetailCRM «Новый», «Оформление заказа» — со статусом «Оформлен», а «Отмена заказа» — со статусом «Отменен». Конкретные значения зависят от воронки заказов в RetailCRM.

Важно!

Если не заполнить обязательное сопоставление статусов, соответствующий этап обмена не сможет обновить заказ в RetailCRM.

7. Настройки статусов товарных позиций

В блоке «Статусы товарных позиций» задается сопоставление результатов выкупа с товарными статусами RetailCRM.

Доступные значения:

• «Позиция выкуплена полностью»;
• «Позиция выкуплена частично»;
• «Позиция возвращена».

Эти настройки используются, когда чекаут сообщает, какие товары были выкуплены после доставки.

Сервис сравнивает количество выкупленных товаров с количеством в заказе:

• если выкуплено все количество, устанавливается статус «Позиция выкуплена полностью»;
• если выкуплена часть количества, устанавливается статус «Позиция выкуплена частично»;
• если количество выкупа равно нулю, устанавливается статус «Позиция возвращена».

8. Склады и самовывоз

Список складов формируется из складов RetailCRM.

Используются следующие поля:

• код склада;
• название;
• адрес;
• телефон;
• описание;
• настройки самовывоза.

Важно!

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

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

Примечание

Для самовывоза используется часовой пояс +3. Учитывайте это при настройке графика работы складов.

9. Проверка корзины и остатков

Чекаут вызывает проверку корзины при каждом изменении состава корзины.

Сервис проверяет:

• наличие товаров или торговых предложений в RetailCRM;
• актуальные цены;
• остатки по складам;
• изображения, ссылки, характеристики и варианты товаров.

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

10. Создание и подтверждение заказа

При вызове создания заказа сервис:

• повторно проверяет цены и остатки;
• находит или создает покупателя в RetailCRM;
• создает заказ в RetailCRM со статусом, выбранным для «Создание заказа».

После подтверждения заказа на стороне чекаута сервис:

• переводит заказ в статус, выбранный для «Оформление заказа»;
• создает оплату с типом оплаты из блока «Оплаты»;
• для онлайн-оплаты устанавливает выбранный статус оплаты.

Если чекаут передает свой внутренний номер заказа, сервис заменит им существующий в системе номер заказа при обновлении заказа.

11. Отмена и завершение заказа

При отмене оформления или отмене заказа сервис переводит заказ в статус, выбранный для «Отмена заказа».

При завершении заказа сервис:

• переводит заказ в статус, выбранный для «Завершение заказа»;
• обновляет статусы товарных позиций по фактически выкупленному количеству.

12. Особенности работы

• Справочники RetailCRM в настройках модуля кешируются до 10 минут. Если новый тип оплаты, доставки или статус не появился сразу, подождите и обновите страницу настроек позже.
• В настройках оплат, доставок, статусов заказа и статусов товарных позиций одно и то же значение из справочника RetailCRM нельзя использовать для нескольких значений чекаута.
• Если подключение модуля в RetailCRM выключено или заморожено, сервис отклоняет запросы от чекаута.
• Если аккаунт YCP выключен, сервис отклоняет запросы с его токеном.
• Все запросы YCP должны укладываться в ограничения протокола по времени ответа. Если RetailCRM временно недоступна, чекаут может получить ошибку обработки запроса.

После заполнения всех блоков настроек обмен между Yandex Checkout и RetailCRM готов к работе.