Веб-сервисы импорта данных из ERP в SetRetail10

Описание

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

Внимание:

  • Пакет данных, передаваемый в SetRetail10 должен преобразовываться в кодировку BASE64. (Кроме кассиров)
  • Обмен происходит по порту 8090

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

Внимание:

При импорте данных в методах getGoodsCatalogWithTi и getGoodsCatalog пакеты всегда добавляются с приоритетом 0, то есть с самым наименьшим приоритетом.

Без обратной связи

МетодgetGoodsCatalog
URLhttp://IP-адрес_сервера:8090/SET-ERPIntegration/SET/WSGoodsCatalogImport
WSDLhttp://IP-адрес_сервера:8090/SET-ERPIntegration/SET/WSGoodsCatalogImport?wsdl

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

goodsCatalogXML

base64Binary

Товарный справочник в формате XML

Да

Возвращаемые параметры

Return

Boolean

True в случае успешной обработки пакета


C обратной связью

МетодgetGoodsCatalogWithTi
URLhttp://IP-адрес_сервера:8090/SET-ERPIntegration/SET/WSGoodsCatalogImport
WSDLhttp://IP-адрес_сервера:8090/SET-ERPIntegration/SET/WSGoodsCatalogImport?wsdl

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

getGoodsCatalog

base64Binary

Товарный справочник в формате XML

Да

ti

string

Transaction Id - номер передаваемого пакета данных, по которому можно будет получить обратную связь.

Нет

Возвращаемые параметры

return

boolean

True в случае успешной обработки пакета


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

Важно

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

-

C приоритетом обработки пакетов

МетодgetGoodsCatalogWithParams
URLhttp://IP-адрес_сервера:8090/SET-ERPIntegration/SET/WSGoodsCatalogImport
WSDLhttp://IP-адрес_сервера:8090/SET-ERPIntegration/SET/WSGoodsCatalogImport?wsdl
Комментарий

Приоритет является первым полем в сортировке при выборке пакетов на обработку.

Вторым полем в сортировке является дата/время импорта пакета.

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

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

getGoodsCatalog

base64Binary

Товарный справочник в формате XML

Да

ti

string

Transaction Id - номер передаваемого пакета данных, по которому можно будет получить обратную связь.

Нет

priority

int

Приоритет обработки пакета от 0 до 9. 0 самый наименьший. По умолчанию 0. Более высокий приоритет обрабатывается раньше.

Нет

Возвращаемые параметры

return

boolean

True в случае успешной обработки пакета


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

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

C обратной связью

МетодimportGoodsProducers
URLhttp://IP-адрес_сервера:8090/SET-Producer/WSGoodsProducersImport
WSDLhttp://IP-адрес_сервера:8090/SET-Producer/WSGoodsProducersImport?wsdl

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

producersXML

base64Binary

Данные о производителе и набор альтернативных свойств товара в формате XML

Да

ti

string

Transaction Id - Номер передаваемого пакета данных, по которому можно будет получить обратную связь.

Нет

Возвращаемые параметры 

return

boolean

True в случае успешной обработки пакета


Формат данных о производителе и наборов альтернативных свойств товаров

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

Внимание:

  • При импорте кассиров не нужно преобразовывать данные в base64.
  • Блок кассиров должен быть представлен в виде well formed XML в блоке CDATA.

Без обратной связи

МетодimportCashiers
URLhttp://IP-адрес_сервера:8090/SET-ERPIntegration/CashiersImport
WSDLhttp://IP-адрес_сервера:8090/SET-ERPIntegration/CashiersImport?wsdl

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

xml

XML (CDATA)

Справочник кассиров в формате XML

Да

Возвращаемые параметры

return

boolean

True в случае успешной обработки пакета


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


C обратной связью

МетодimportCashiersWithTi
URLhttp://IP-адрес_сервера:8090/SET-ERPIntegration/CashiersImport
WSDLhttp://IP-адрес_сервера:8090/SET-ERPIntegration/CashiersImport?wsdl

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

xml

XML (CDATA)

Справочник кассиров в формате XML

Да

ti

string

Transaction Id - номер передаваемого пакета данных, по которому можно будет получить обратную связь.

Нет

Возвращаемые параметры 

return

boolean

True в случае успешной обработки пакета


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

Важно

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

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

C обратной связью

МетодimportSellers
URLhttp://IP-адрес_сервера:8090/SET-ERPIntegration/SellersImportWS
WSDLhttp://IP-адрес_сервера:8090/SET-ERPIntegration/SellersImportWS?wsdl

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

xml

base64Binary

Справочник продавцов в формате XML, кодированный с помощью base64Binary

Да

ti

String

Transaction Id - Номер передаваемого пакета данных, по которому можно будет получить обратную связь.

Нет

Возвращаемые параметры

return

boolean

True в случае успешной обработки пакета


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

Важно

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

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

Без обратной связи

МетодgetCardsCatalog
URLhttp://IP-адрес_сервера:8090/SET-ERPIntegration/SET/WSCardsCatalogImport
WSDLhttp://IP-адрес_сервера:8090/SET-ERPIntegration/SET/WSCardsCatalogImport?wsdl

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры




cardsCatalogXML

base64Binary

Справочник карт и анкет клиентов в формате XML, кодированный с помощью base64Binary

Да

Возвращаемые параметры

return

boolean

True в случае успешной обработки пакета


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


C обратной связью

МетодgetCardsCatalogWithTi
URLhttp://IP-адрес_сервера:8090/SET-ERPIntegration/SET/WSCardsCatalogImport
WSDLhttp://IP-адрес_сервера:8090/SET-ERPIntegration/SET/WSCardsCatalogImport?wsdl

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

cardsCatalogXML

base64Binary

Справочник карт в формате XML кодированный с помощью base64Binary

Да

ti

String

Transaction Id - Номер передаваемого пакета данных, по которому можно будет получить обратную связь.

Нет

Возвращаемые параметры

return

boolean

True в случае успешной обработки пакета


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

Важно

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

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

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

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

Без обратной связи

МетодimportActions
URLhttp://IP-адрес_сервера:8090/SET-ERPIntegration/AdvertisingActionsImport
WSDLhttp://IP-адрес_сервера:8090/SET-ERPIntegration/AdvertisingActionsImport?wsdl

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры  

xmlData

base64Binary

Рекламные акции в формате XML

Да

Возвращаемые параметры

return

boolean

Ответ об успешном прохождении валидации пакета данных и принятии его в обработку


Описание формата рекламных акций


С обратной связью

МетодimportActionsWithTi
URLhttp://IP-адрес_сервера:8090/SET-ERPIntegration/AdvertisingActionsImport
WSDLhttp://IP-адрес_сервера:8090/SET-ERPIntegration/AdvertisingActionsImport?wsdl

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

xmlData

base64Binary

XML в формате данных Рекламных акций, кодированный с помощью base64Binary

Да

ti

String

Transaction Id - номер передаваемого пакета данных, по которому можно будет получить обратную связь.

Нет

Возвращаемые параметры

return

boolean

True в случае успешной обработки пакета


Описание формата рекламных акций

Важно

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

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

Без обратной связи

Методadd
URLhttp://IP-адрес_сервера:8090/SET-ERPIntegration/SegmentsImport
WSDLhttp://IP-адрес_сервера:8090/SET-ERPIntegration/SegmentsImport?wsdl

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

xmlData

base64Binary

XML в формате данных сегментов, кодированный с помощью base64Binary

Да

Возвращаемые параметры

return

boolean

True в случае успешной обработки пакета


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


С обратной связью

МетодaddWithTI
URLhttp://IP-адрес_сервера:8090/SET-ERPIntegration/SegmentsImport
WSDLhttp://IP-адрес_сервера:8090/SET-ERPIntegration/SegmentsImport?wsdl

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

xmlData

base64Binary

XML в формате данных сегментов, кодированный с помощью base64Binary

Да

TI

string

Transaction Id - номер передаваемого пакета данных, по которому можно будет получить обратную связь.

Нет

Возвращаемые параметры

return

boolean

True в случае успешной обработки пакета


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

Важно

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

Удаление участников сегментов

Без обратной связи

Методdelete
URLhttp://IP-адрес_сервера:8090/SET-ERPIntegration/SegmentsImport
WSDLhttp://IP-адрес_сервера:8090/SET-ERPIntegration/SegmentsImport?wsdl

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры  

xmlData

base64Binary

XML в формате данных сегментов, кодированный с помощью base64Binary

Да

Возвращаемые параметры

return

boolean

True в случае успешной обработки пакета


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


С обратной связью

МетодdeleteWithTI
URLhttp://IP-адрес_сервера:8090/SET-ERPIntegration/SegmentsImport
WSDLhttp://IP-адрес_сервера:8090/SET-ERPIntegration/SegmentsImport?wsdl

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

xmlData

base64Binary

XML в формате данных сегментов, кодированный с помощью base64Binary

Да

TI

string

Transaction Id - номер передаваемого пакета данных, по которому можно будет получить обратную связь.

Нет

Возвращаемые параметры 

return

boolean

True в случае успешной обработки пакета


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

Важно

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

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

Активация подарочной карты

МетодactivatePresentCard
URLhttp://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager
WSDLhttp://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager?wsdl
КомментарийИнформация по подарочным картам, в качестве входных параметров принимает фильтр, по которому и будут отобраны карты.

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

cardNumber

String

Номер карты

Да
purchaseUidCollectionНабор полей чекаНет

cashNumLongНомер кассыНет
checkNumLongНомер чека к которому будет привязана активация подарочной картыНет
createDatedateTime

Дата регистрации чека

Формат 

Нет
shiftNumLongНомер сменыНет
shopNumLongНомер магазинаНет
amountLongНоминалНет
userNameStringИмя пользователяНет
userTabNumberStringID серверного пользователяНет

Возвращаемые параметры

amount

Long

Номинал


balanceLongОстаток на карте
cardNumberStringНомер карты
expirationDatedateTimeДата окончания действия карты
statusstring

Статус:

  • Activate
  • Blocked
  • Changed
  • Create
  • EXTEND
  • Inactive
  • PARTIAL_USE
  • UNDO_USE
  • Used

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

Пример запроса на активацию подарочной карты
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.processing.cards.crystals.ru/">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:activatePresentCard>
         <!--Optional:-->
         <cardNumber>789222</cardNumber>
         <!--Optional:-->
         <purchaseUid>
            <!--Optional:-->
            <cashNum>2</cashNum>
            <!--Optional:-->
            <checkNum>4</checkNum>
            <!--Optional:-->
            <createDate>2019-05-13</createDate>
            <!--Optional:-->
            <shiftNum>8</shiftNum>
            <!--Optional:-->
            <shopNum>3382</shopNum>
         </purchaseUid>
         <!--Optional:-->
         <amount>50000</amount>
         <!--Optional:-->
         <userName>manager</userName>
         <!--Optional:-->
         <userTabNumber>1</userTabNumber>
      </ser:activatePresentCard>
   </soapenv:Body>
</soapenv:Envelope>

-

Деактивация подарочной карты

МетодdeActivatePresentCard
URLhttp://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager
WSDLhttp://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager?wsdl
КомментарийОтменить выдачу подарочной карты. После применения карты её статус будет отображаться "Еще не выдана" "Неактивна"

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

cardNumberStringНовый номер карты из существующих диапазоновДа
purchaseUidCollectionНабор полей чекаНет

cashNumLongНомер кассыНет
checkNumLongНомер чека к которому будет привязана активация подарочной картыНет
createDatedateTime

Дата регистрации чека

Формат: YYYY-MM-DD

Нет
shiftNumLongНомер сменыНет
shopNumLongНомер магазинаНет
userNameStringИмя пользователяНет
userTabNumberStringID серверного пользователяНет

Возвращаемые параметры

amountLongНоминал
balanceLongОстаток на карте
cardNumberStringНомер карты
expirationDatedateTimeДата окончания действия карты
statusString

Статус:

  • Activate
  • Blocked
  • Changed
  • Create
  • EXTEND
  • Inactive
  • PARTIAL_USE
  • UNDO_USE
  • Used

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

Пример запроса на активацию подарочной карты
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.processing.cards.crystals.ru/">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:activatePresentCard>
         <cardNumber>445666</cardNumberNew>
         <!--Optional:-->
         <purchaseUid>
            <!--Optional:-->
            <cashNum>2</cashNum>
            <!--Optional:-->
            <checkNum>4</checkNum>
            <!--Optional:-->
            <createDate>2019-05-13</createDate>
            <!--Optional:-->
            <shiftNum>8</shiftNum>
            <!--Optional:-->
            <shopNum>3382</shopNum>
         </purchaseUid>
         <!--Optional:-->
         <userName>manager</userName>
         <!--Optional:-->
         <userTabNumber>1</userTabNumber>
      </ser:activatePresentCard>
   </soapenv:Body>
</soapenv:Envelope>

-

Погасить подарочную карту

МетодpaymentPresentCard
URLhttp://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager
WSDLhttp://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager?wsdl
КомментарийОтменить выдачу подарочной карты. После применения карты её статус будет отображаться "Еще не выдана" "Неактивна"

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

cardNumberStringНовый номер карты из существующих диапазоновДа
purchaseUidCollectionНабор полей чекаДа

cashNumLongНомер кассыДа
checkNumLongНомер чека к которому будет привязана активация подарочной картыДа
createDatedateTime

Дата регистрации чека

Формат: YYYY-MM-DD

Да
shiftNumLongНомер сменыДа
shopNumLongНомер магазинаДа
userNameStringИмя пользователяНет
userTabNumberStringID серверного пользователяНет

Возвращаемые параметры

paymentPresentCardResponse
Отображение наименования ответа paymentPresentCardResponse в случае успешной обработки пакета

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

Пример запроса на активацию подарочной карты
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.processing.cards.crystals.ru/">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:paymentPresentCard>
         <!--Optional:-->
         <cardNumber>654987</cardNumber>
         <!--Optional:-->
         <purchaseUid>
            <!--Optional:-->
            <cashNum>2</cashNum>
            <!--Optional:-->
            <checkNum>4</checkNum>
            <!--Optional:-->
            <createDate>2019-05-15</createDate>
            <!--Optional:-->
            <shiftNum>8</shiftNum>
            <!--Optional:-->
            <shopNum>3382</shopNum>
         </purchaseUid>
         <!--Optional:-->
         <userName>manager</userName>
         <!--Optional:-->
         <userTabNumber>1</userTabNumber>
      </ser:paymentPresentCard>
   </soapenv:Body>
</soapenv:Envelope>

-

Списать сумму с подарочной карты

МетодpaymentPresentCard
URLhttp://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager
WSDLhttp://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager?wsdl
КомментарийОтменить выдачу подарочной карты. После применения карты её статус будет отображаться "Еще не выдана" "Неактивна"

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

cardNumberStringНовый номер карты из существующих диапазоновДа
amountLong

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

Нельзя списать сумму превышающую номинал подарочной карты.


purchaseUidCollectionНабор полей чекаДа

cashNumLongНомер кассыДа
checkNumLongНомер чека к которому будет привязана активация подарочной картыДа
createDatedateTime

Дата регистрации чека

Формат: YYYY-MM-DD

Да
shiftNumLongНомер сменыДа
shopNumLongНомер магазинаДа
userNameStringИмя пользователяНет
userTabNumberStringID серверного пользователяНет

Возвращаемые параметры

redeemPresentCardResponse
Отображение наименования ответа paymentPresentCardResponse в случае успешной обработки пакета

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

Списание суммы в размере 11руб.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.processing.cards.crystals.ru/">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:redeemPresentCard>
         <!--Optional:-->
         <cardNumber>111333</cardNumber>
         <!--Optional:-->
         <amount>2600</amount>
         <!--Optional:-->
         <purchaseUid>
            <!--Optional:-->
            <cashNum>2</cashNum>
            <!--Optional:-->
            <checkNum>4</checkNum>
            <!--Optional:-->
            <createDate>2019-05-15</createDate>
            <!--Optional:-->
            <shiftNum>8</shiftNum>
            <!--Optional:-->
            <shopNum>3382</shopNum>
         </purchaseUid>
         <!--Optional:-->
         <userName>manager</userName>
         <!--Optional:-->
         <userTabNumber>1</userTabNumber>
      </ser:redeemPresentCard>
   </soapenv:Body>
</soapenv:Envelope>

-

Unable to render {include} The included page could not be found.

Unable to render {include} The included page could not be found.