Веб-сервисы импорта данных из ERP в SetRetail10
Описание
Данный вариант импорта предполагает обмен данными на основе веб-сервисов, предоставляемых SetRetail10, при которых активной стороной запроса является ERP, то есть ERP должна отправлять данные в SetRetail10.
Внимание:
- Пакет данных, передаваемый в SetRetail10 должен преобразовываться в кодировку BASE64. (Кроме кассиров)
- Обмен происходит по порту 8090
Методы веб-сервиса для импорта товарного справочника
Внимание:
Без обратной связи | |
Метод | getGoodsCatalog |
URL | http://IP-адрес_сервера:8090/SET-ERPIntegration/SET/WSGoodsCatalogImport |
WSDL | http://IP-адрес_сервера:8090/SET-ERPIntegration/SET/WSGoodsCatalogImport?wsdl |
Поле | Тип данных | Описание | Обязательное |
Принимаемые параметры | |||
goodsCatalogXML | base64Binary | Товарный справочник в формате XML | Да |
Возвращаемые параметры | |||
Return | Boolean |
|
C обратной связью | |
Метод | getGoodsCatalogWithTi |
URL | http://IP-адрес_сервера:8090/SET-ERPIntegration/SET/WSGoodsCatalogImport |
WSDL | http://IP-адрес_сервера:8090/SET-ERPIntegration/SET/WSGoodsCatalogImport?wsdl |
Поле | Тип данных | Описание | Обязательное |
Принимаемые параметры | |||
getGoodsCatalog | base64Binary | Товарный справочник в формате XML | Да |
ti | string |
| Нет |
Возвращаемые параметры | |||
return | boolean |
|
Описание формата данных товарного справочника
Важно
ti
– является уникальным идентификатором этого пакета в SetRetail10, что накладывает определённые ограничения на повторный импорт пакета и загрузку разных типов данных с одним идентификатором. Transaction Id -
C приоритетом обработки пакетов | |
Метод | getGoodsCatalogWithParams |
URL | http://IP-адрес_сервера:8090/SET-ERPIntegration/SET/WSGoodsCatalogImport |
WSDL | http://IP-адрес_сервера:8090/SET-ERPIntegration/SET/WSGoodsCatalogImport?wsdl |
Комментарий | Приоритет является первым полем в сортировке при выборке пакетов на обработку. Вторым полем в сортировке является дата/время импорта пакета. Принцип обработки пакетов: в одну итерацию выборки пакетов должны попадать сначала все с самым наивысшим приоритетом, далее со следующим более низким приоритетом, и так далее вплоть до самого наименьшего приоритета, т.е. пакеты с приоритетом 0, всегда обрабатываются в последнюю очередь. |
Поле | Тип данных | Описание | Обязательное |
Принимаемые параметры | |||
getGoodsCatalog | base64Binary | Товарный справочник в формате XML | Да |
ti | string |
| Нет |
priority | int | Приоритет обработки пакета от 0 до 9. 0 самый наименьший. По умолчанию 0. Более высокий приоритет обрабатывается раньше. | Нет |
Возвращаемые параметры | |||
return | boolean |
|
Методы веб-сервиса для импорта данных о производителе и наборов альтернативных свойств товаров
C обратной связью | |
Метод | importGoodsProducers |
URL | http://IP-адрес_сервера:8090/SET-Producer/WSGoodsProducersImport |
WSDL | http://IP-адрес_сервера:8090/SET-Producer/WSGoodsProducersImport?wsdl |
Поле | Тип данных | Описание | Обязательное |
Принимаемые параметры | |||
producersXML | base64Binary | Данные о производителе и набор альтернативных свойств товара в формате XML | Да |
ti | string |
| Нет |
Возвращаемые параметры | |||
return | boolean |
|
Формат данных о производителе и наборов альтернативных свойств товаров
Методы web-сервиса для импорта кассиров
Внимание:
- При импорте кассиров не нужно преобразовывать данные в base64.
- Блок кассиров должен быть представлен в виде well formed XML в блоке CDATA.
Без обратной связи | |
Метод | importCashiers |
URL | http://IP-адрес_сервера:8090/SET-ERPIntegration/CashiersImport |
WSDL | http://IP-адрес_сервера:8090/SET-ERPIntegration/CashiersImport?wsdl |
Поле | Тип данных | Описание | Обязательное |
Принимаемые параметры | |||
xml | XML (CDATA) | Справочник кассиров в формате XML | Да |
Возвращаемые параметры | |||
return | boolean |
|
Описание формата данных кассиров
C обратной связью | |
Метод | importCashiersWithTi |
URL | http://IP-адрес_сервера:8090/SET-ERPIntegration/CashiersImport |
WSDL | http://IP-адрес_сервера:8090/SET-ERPIntegration/CashiersImport?wsdl |
Поле | Тип данных | Описание | Обязательное |
Принимаемые параметры | |||
xml | XML (CDATA) | Справочник кассиров в формате XML | Да |
ti | string |
| Нет |
Возвращаемые параметры | |||
return | boolean |
|
Описание формата данных кассиров
Важно
ti
– является уникальным идентификатором этого пакета в SetRetail10, что накладывает определённые ограничения на повторный импорт пакета и загрузку разных типов данных с одним идентификатором. Transaction Id Методы веб-сервиса для импорта справочника продавцов
C обратной связью | |
Метод | importSellers |
URL | http://IP-адрес_сервера:8090/SET-ERPIntegration/SellersImportWS |
WSDL | http://IP-адрес_сервера:8090/SET-ERPIntegration/SellersImportWS?wsdl |
Поле | Тип данных | Описание | Обязательное |
Принимаемые параметры | |||
xml | base64Binary | Справочник продавцов в формате XML, кодированный с помощью base64Binary | Да |
ti | String |
| Нет |
Возвращаемые параметры | |||
return | boolean |
|
Описание формата данных продавцов
Важно
ti
– является уникальным идентификатором этого пакета в SetRetail10, что накладывает определённые ограничения на повторный импорт пакета и загрузку разных типов данных с одним идентификатором. Transaction Id Методы веб-сервиса для импорта дисконтных карт и анкет клиентов
Без обратной связи | |
Метод | getCardsCatalog |
URL | http://IP-адрес_сервера:8090/SET-ERPIntegration/SET/WSCardsCatalogImport |
WSDL | http://IP-адрес_сервера:8090/SET-ERPIntegration/SET/WSCardsCatalogImport?wsdl |
Поле | Тип данных | Описание | Обязательное |
Принимаемые параметры | |||
cardsCatalogXML | base64Binary | Справочник карт и анкет клиентов в формате XML, кодированный с помощью base64Binary | Да |
Возвращаемые параметры | |||
return | boolean |
|
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 |
| Нет |
Возвращаемые параметры | |||
return | boolean |
|
Важно
ti
– является уникальным идентификатором этого пакета в SetRetail10, что накладывает определённые ограничения на повторный импорт пакета и загрузку разных типов данных с одним идентификатором. Transaction Id Начисление бонусных баллов через веб-сервис
Для начисления бонусных баллов из ERP системы используйте веб-сервис и методы из статьи SetRetail10 ◾️ Ручное начисление бонусов.
Методы веб-сервиса для импорта рекламных акций
Без обратной связи | |
Метод | importActions |
URL | http://IP-адрес_сервера:8090/SET-ERPIntegration/AdvertisingActionsImport |
WSDL | http://IP-адрес_сервера:8090/SET-ERPIntegration/AdvertisingActionsImport?wsdl |
Поле | Тип данных | Описание | Обязательное |
Принимаемые параметры | |||
xmlData | base64Binary | Рекламные акции в формате XML | Да |
Возвращаемые параметры | |||
return | boolean | Ответ об успешном прохождении валидации пакета данных и принятии его в обработку |
Описание формата рекламных акций
С обратной связью | |
Метод | importActionsWithTi |
URL | http://IP-адрес_сервера:8090/SET-ERPIntegration/AdvertisingActionsImport |
WSDL | http://IP-адрес_сервера:8090/SET-ERPIntegration/AdvertisingActionsImport?wsdl |
Поле | Тип данных | Описание | Обязательное |
Принимаемые параметры | |||
xmlData | base64Binary | XML в формате данных Рекламных акций, кодированный с помощью base64Binary | Да |
ti | String |
| Нет |
Возвращаемые параметры | |||
return | boolean |
|
Описание формата рекламных акций
Важно
ti
– является уникальным идентификатором этого пакета в SetRetail10, что накладывает определённые ограничения на повторный импорт пакета и загрузку разных типов данных с одним идентификатором. Transaction Id Методы веб-сервиса для импорта сегментов
Без обратной связи | |
Метод | add |
URL | http://IP-адрес_сервера:8090/SET-ERPIntegration/SegmentsImport |
WSDL | http://IP-адрес_сервера:8090/SET-ERPIntegration/SegmentsImport?wsdl |
Поле | Тип данных | Описание | Обязательное |
Принимаемые параметры | |||
xmlData | base64Binary | XML в формате данных сегментов, кодированный с помощью base64Binary | Да |
Возвращаемые параметры | |||
return | boolean |
|
С обратной связью | |
Метод | addWithTI |
URL | http://IP-адрес_сервера:8090/SET-ERPIntegration/SegmentsImport |
WSDL | http://IP-адрес_сервера:8090/SET-ERPIntegration/SegmentsImport?wsdl |
Поле | Тип данных | Описание | Обязательное |
Принимаемые параметры | |||
xmlData | base64Binary | XML в формате данных сегментов, кодированный с помощью base64Binary | Да |
TI | string |
| Нет |
Возвращаемые параметры | |||
return | boolean |
|
Важно
ti
– является уникальным идентификатором этого пакета в SetRetail10, что накладывает определённые ограничения на повторный импорт пакета и загрузку разных типов данных с одним идентификатором. Transaction Id Удаление участников сегментов
Без обратной связи | |
Метод | delete |
URL | http://IP-адрес_сервера:8090/SET-ERPIntegration/SegmentsImport |
WSDL | http://IP-адрес_сервера:8090/SET-ERPIntegration/SegmentsImport?wsdl |
Поле | Тип данных | Описание | Обязательное |
Принимаемые параметры | |||
xmlData | base64Binary | XML в формате данных сегментов, кодированный с помощью base64Binary | Да |
Возвращаемые параметры | |||
return | boolean |
|
С обратной связью | |
Метод | deleteWithTI |
URL | http://IP-адрес_сервера:8090/SET-ERPIntegration/SegmentsImport |
WSDL | http://IP-адрес_сервера:8090/SET-ERPIntegration/SegmentsImport?wsdl |
Поле | Тип данных | Описание | Обязательное |
Принимаемые параметры | |||
xmlData | base64Binary | XML в формате данных сегментов, кодированный с помощью base64Binary | Да |
TI | string |
| Нет |
Возвращаемые параметры | |||
return | boolean |
|
Важно
ti
– является уникальным идентификатором этого пакета в SetRetail10, что накладывает определённые ограничения на повторный импорт пакета и загрузку разных типов данных с одним идентификатором. Transaction Id Методы веб-сервиса для импорта операций по подарочным картам
Активация подарочной карты | |
Метод | activatePresentCard |
URL | http://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager |
WSDL | http://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager?wsdl |
Комментарий | Информация по подарочным картам, в качестве входных параметров принимает фильтр, по которому и будут отобраны карты. |
Поле | Тип данных | Описание | Обязательное | |
Принимаемые параметры | ||||
cardNumber | String | Номер карты | Да | |
purchaseUid | Collection | Набор полей чека | Нет | |
cashNum | Long | Номер кассы | Нет | |
checkNum | Long | Номер чека к которому будет привязана активация подарочной карты | Нет | |
createDate | dateTime | Дата регистрации чека Формат | Нет | |
shiftNum | Long | Номер смены | Нет | |
shopNum | Long | Номер магазина | Нет | |
amount | Long | Номинал | Нет | |
userName | String | Имя пользователя | Нет | |
userTabNumber | String | ID серверного пользователя | Нет | |
Возвращаемые параметры | ||||
amount | Long | Номинал | ||
balance | Long | Остаток на карте | ||
cardNumber | String | Номер карты | ||
expirationDate | dateTime | Дата окончания действия карты | ||
status | string | Статус:
|
<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 |
URL | http://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager |
WSDL | http://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager?wsdl |
Комментарий | Отменить выдачу подарочной карты. После применения карты её статус будет отображаться "Еще не выдана" "Неактивна" |
Поле | Тип данных | Описание | Обязательное | |
Принимаемые параметры | ||||
cardNumber | String | Новый номер карты из существующих диапазонов | Да | |
purchaseUid | Collection | Набор полей чека | Нет | |
cashNum | Long | Номер кассы | Нет | |
checkNum | Long | Номер чека к которому будет привязана активация подарочной карты | Нет | |
createDate | dateTime | Дата регистрации чека Формат: YYYY-MM-DD | Нет | |
shiftNum | Long | Номер смены | Нет | |
shopNum | Long | Номер магазина | Нет | |
userName | String | Имя пользователя | Нет | |
userTabNumber | String | ID серверного пользователя | Нет | |
Возвращаемые параметры | ||||
amount | Long | Номинал | ||
balance | Long | Остаток на карте | ||
cardNumber | String | Номер карты | ||
expirationDate | dateTime | Дата окончания действия карты | ||
status | String | Статус:
|
<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 |
URL | http://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager |
WSDL | http://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager?wsdl |
Комментарий | Отменить выдачу подарочной карты. После применения карты её статус будет отображаться "Еще не выдана" "Неактивна" |
Поле | Тип данных | Описание | Обязательное | |
Принимаемые параметры | ||||
cardNumber | String | Новый номер карты из существующих диапазонов | Да | |
purchaseUid | Collection | Набор полей чека | Да | |
cashNum | Long | Номер кассы | Да | |
checkNum | Long | Номер чека к которому будет привязана активация подарочной карты | Да | |
createDate | dateTime | Дата регистрации чека Формат: YYYY-MM-DD | Да | |
shiftNum | Long | Номер смены | Да | |
shopNum | Long | Номер магазина | Да | |
userName | String | Имя пользователя | Нет | |
userTabNumber | String | ID серверного пользователя | Нет | |
Возвращаемые параметры | ||||
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 |
URL | http://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager |
WSDL | http://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager?wsdl |
Комментарий | Отменить выдачу подарочной карты. После применения карты её статус будет отображаться "Еще не выдана" "Неактивна" |
Поле | Тип данных | Описание | Обязательное | |
Принимаемые параметры | ||||
cardNumber | String | Новый номер карты из существующих диапазонов | Да | |
amount | Long | Сумма списания в размере номинала подарочной карты. Нельзя списать сумму превышающую номинал подарочной карты. | ||
purchaseUid | Collection | Набор полей чека | Да | |
cashNum | Long | Номер кассы | Да | |
checkNum | Long | Номер чека к которому будет привязана активация подарочной карты | Да | |
createDate | dateTime | Дата регистрации чека Формат: YYYY-MM-DD | Да | |
shiftNum | Long | Номер смены | Да | |
shopNum | Long | Номер магазина | Да | |
userName | String | Имя пользователя | Нет | |
userTabNumber | String | ID серверного пользователя | Нет | |
Возвращаемые параметры | ||||
redeemPresentCardResponse | Отображение наименования ответа paymentPresentCardResponse в случае успешной обработки пакета |
<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>
-