Методы веб-сервиса для импорта дисконтных карт и анкет клиентов

Без обратной связи
Метод	getCardsCatalog
URL	http://IP-адрес_сервера:8090/SET-ERPIntegration/SET/WSCardsCatalogImport
WSDL	http://IP-адрес_сервера:8090/SET-ERPIntegration/SET/WSCardsCatalogImport?wsdl

Поле	Тип данных	Описание	Обязательное
Принимаемые параметры
cardsCatalogXML	base64Binary	Справочник карт и анкет клиентов в формате XML, кодированный с помощью base64Binary	Да
Возвращаемые параметры
return	boolean	True в случае успешной обработки пакета

Описание формата данных карт

C обратной связью
Метод	getCardsCatalogWithTi
URL	http://IP-адрес_сервера:8090/SET-ERPIntegration/SET/WSCardsCatalogImport
WSDL	http://IP-адрес_сервера:8090/SET-ERPIntegration/SET/WSCardsCatalogImport?wsdl

Поле	Тип данных	Описание	Обязательное
Принимаемые параметры
cardsCatalogXML	base64Binary	Справочник карт в формате XML кодированный с помощью base64Binary	Да
ti	String	Transaction Id - Номер передаваемого пакета данных, по которому можно будет получить обратную связь.	Нет
Возвращаемые параметры
return	boolean	True в случае успешной обработки пакета

Описание формата данных карт

Важно

Идентификатор пакета ti Transaction Id – является уникальным идентификатором этого пакета в SetRetail10, что накладывает определённые ограничения на повторный импорт пакета и загрузку разных типов данных с одним идентификатором.

Начисление бонусных баллов через веб-сервис

Для начисления бонусных баллов из ERP системы используйте веб-сервис и методы из статьи SetRetail10 ◾️ Ручное начисление бонусов.

Импорт карт <cards-catalog>

Категории внутренних карт <internal-card-type>

Диапазон внутренних карт <card-range>

Экземпляры внутренних карт <internal-card>

Клиенты внутренних карт <client>

Контрагенты внутренних карт (юридические лица) <counterparty>

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

<cards-catalog>
 
    <internal-card card-type-guid="12621262" number="12620001" expiration-date="2049-12-31T00:00:00" status="ACTIVE" attached-to-counterparty="true">
        <counterparty inn="1212121212" kpp="123456789" name="Тестовое юрлицо" full-name="" address="Тестовый адрес" debitor-number="1245648725"/>
		<client guid = "198116" last-name = "Юридический" first-name = "Роман" middle-name = "Аркадьевич" sex = "MALE" birth-date = "1976-05-01"
                email="roman@crystals.ru" send-by-email="true" receipt-feedback="BY_EMAIL"/>
    </internal-card>

  
</cards-catalog>

Привязка дисконтной карты Set10 к контрагенту используется в системе для возможности осуществления продажи юридическим лицам с соблюдением требований законодательства и автоматическим формированием и выдачей соответствующих сопроводительных документов.

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

Привязка контрагента к карте осуществляется за счёт того, что тег <counterparty> вложен внутрь тега <Internal-card>.

Также осуществляется дополнительная проверка на то, что если у самой карты установлен атрибут attached-to-counterparty, то наличие корректного вложенного тега <counterparty> является обязательным условием импорта данной карты.

Пример возможной связки клиентов, карт и контрагентов:

Накопления по карте <purchase-accumulation>

Бонусный баланс <bonus-account>

Особенности импорта данных карт

Обработка данных

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

• Сохранение данных категорий карт, их экземпляров карт и клиентов в базе данных сервера SetRetail10 или SetCentrum.
• Отправка данных на кассы (для SetRetail) и подчиненные магазины (для SetCentrum) через уже реализованные механизмы.

Оба этапа выполняются в одной транзакции для избежания потери данных в случае сбоев в работе.

Обработка категорий карт

• В данных категории карт устанавливается свойства, которые наследуются всеми подчиненными ей картами. Наиболее важным из них является процент скидки по карте.
• Важно понимать, что категории карт ввиду своей немногочисленности могут быть заведены непосредственно в SetRetail10. (Рекомендуется создавать категории карт в SetRetail10).
• В процессе импорта из ERP, при получении данных категорий карт в секции internal-card-type данные в SetRetail10 перезаписываются безусловно. Идентификатором для перезаписи категории является поле guid.
• При импорте недостающие, но необязательные к загрузке поля заполняются значением по умолчанию.
• В случае отсутствия данных в поле work-period-end при импорте новой категории категория карт, их экземпляры становятся бессрочными.
• В случае отсутствия необходимых данных для импорта категорий, категория карт будет отклонена системой.

Обработка диапазонов карт

• Каждый диапазон карт привязан к одной категории карт.
• Диапазоны карт используются в случае, когда нет причин вести карты поштучно (отсутствуют анкеты покупателей, не ведутся накопления и бонусные остатки).
• Важно понимать, что диапазоны карт ввиду своей немногочисленности могут быть заведены непосредственно в SetRetail10.
• В процессе импорта из ERP, при получении данных диапазонов карт в секции card-range, данные в SetRetail10 перезаписываются безусловно. Идентификатором для перезаписи диапазона карт является поле guid.
• В случае отсутствия необходимых данных для импорта, диапазон карт будет отклонен системой.

Обработка экземпляров карт

• Каждая карта привязана к одной категории карт и наследует свойства категории карты (процент скидки, необходимость заполнения анкеты, общий срок действия).
• В процессе импорта из ERP, при получении данных экземпляров карт в секции internal-card, данные в SetRetail перезаписываются безусловно. Идентификатором для перезаписи является поле number.
• При импорте, недостающие, но необязательные к загрузке поля, заполняются значением по умолчанию. Поле createDate заполняется при создании карты датой проведения импорта.
• Привязка экземпляра карты к типу карт осуществляется через атрибут card-type-guid.
• При загрузке из ERP, карты с cardTypeGuid, которых не соответствует ни одному guid из списка уже заведенных в SetRetail10 категорий карт, будут отклонены системой.

Альтернативная схема импорта карт:

• В данной схеме в SetRetail10 должен быть загружен процент скидки по каждой карте, а атрибут card-type-guid должен отсутствовать,
• Карта будет автоматически привязана механизмами SetRetail10, к уже имеющейся, в SetRetail10 категории с соответствующим значением percentage-discount. Такие категории карт, предварительно могут быть заведены в SetRetail10.
  • Если категории с таким discount-percent не существует, или одновременно не указан cardTypeGuid и percentage-discount, карта будет отклонена системой.

Обработка накоплений

• Накопления в SetRetail10 ведутся в разрезе отдельных карт.
• Накопления выгружаются только при первоначальном импорте карт для передачи данных об уже имеющихся накоплениях в SetRetail10 для дальнейшего ведения накопительного дисконта в SetRetail10. Данный функционал требуется для поддержки переноса ведения накопительного дисконта на SetRetail10 от других информационных систем. Данные накоплений загружаются из ERP в составе данных карт в поле amount.

Обработка данных клиентов

• Данные клиентов не являются обязательными данными.
• В случае, если данные не были отправлены, клиент не создается.
• Каждый клиент может являться владельцем нескольких карт, или не иметь ни одной карты вообще.
• При импорте к клиенту привязываются все присланные с ним карты.
• Если с клиентом не отправлено ни одного экземпляра карт, создается клиент, к которому не привязано ни одной карты.
• При получении данных клиентов в секции сlient данные перезаписываются безусловно. Идентификатором для перезаписи клиента является поле guid.
• При импорте недостающие поля заполняются значением по умолчанию. В случае отсутствия необходимых данных для импорта клиентов, такие клиенты отклоняются системой.

В Set10 cуществуют две возможности разделения продажи на кассах для физических и юридических лиц.

1. Привязка Дисконтной карты к контрагенту (к юрлицу). При этом у клиента могут быть как карты юридического лица, так и обычные дисконтные карты.
2. Привязка Клиента – держателя карты к юридическому лицу. При этом все карты этого клиента считаются картами юридического лица.

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

Дисконтные карты юридических лиц

Привязка карт к контрагентам

• Для осуществления привязки импортируемой дисконтной карты к контрагенту необходимо при импорте указать вложенную сущность counterparty с корректно заполненными атрибутами.
• При этом необходимо дополнительно указать в карте, что она должна быть привязана к контрагенту (атрибут карты attached-to-counterparty).
• При импорте произойдёт проверка наличия вложенного тега counterparty и проверка корректности заполнения требуемых полей по контрагенту, таких как ИНН, КПП и т.д.
• Информация по контрагенту привязанному к такой карте, будет отображаться на вкладке Юридическое лицо в окне информации по карте в визуализации сервера SetRetail10.

Привязка клиентов к юридическим лицам

• Для осуществления привязки импортируемого клиента карты к юридическому лицу необходимо при импорте клиента указать его тип в атрибуте сlient-type.
• Возможные значения атрибута:
  • PRIVATE – физическое лицо.
  • JURISTIC_PERSON – юридическое лицо.
• При такой привязке информация о самом юридическом лице указывается в анкетных данных клиента (либо не указывается вообще). 
• Сам клиент становится для системы юридическим лицом.