Публичный ресурс
Веб-сервисы импорта данных из 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 обратной связьюДанный метод не поддерживается при интеграции по SetESB | |
Метод | 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
Transaction Id
– является уникальным идентификатором этого пакета в SetRetail10, что накладывает определённые ограничения на повторный импорт пакета и загрузку разных типов данных с одним идентификатором.-
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 | Да |
Возвращаемые параметры | |||
Метод без обратной связи, в случае успешной или неуспешной загрузки ответа не будет. |
Описание формата данных кассиров
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
Transaction Id
– является уникальным идентификатором этого пакета в SetRetail10, что накладывает определённые ограничения на повторный импорт пакета и загрузку разных типов данных с одним идентификатором.-
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tran="http://transport.cashiers.setretailx.crystals.ru/"> <soapenv:Header/> <soapenv:Body> <tran:updateCashiers> <update> PGNhc2hVc2Vycz4NCgk8Y2FzaFVzZXI+DQoJCTx0YWJOdW0+MTAwPC90YWJOdW0+DQoJCTxmaXJzdE5hbWU+0JjQstCw0L08L2ZpcnN0TmFtZT4NCgkJPG1pZGRsZU5hbWU+0JjQstCw0L3QvtCy0LjRhzwvbWlkZGxlTmFtZT4NCgkJPGxhc3ROYW1lPtCY0LLQsNC90L7QsjwvbGFzdE5hbWU+DQoJPC9jYXNoVXNlcj4NCjwvY2FzaFVzZXJzPg0K </update> </tran:updateCashiers> </soapenv:Body> </soapenv:Envelope>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:updateCashiersResponse xmlns:ns2="http://transport.cashiers.setretailx.crystals.ru/"> <return>true</return> </ns2:updateCashiersResponse> </soap:Body> </soap:Envelope>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:updateCashiersResponse xmlns:ns2="http://transport.cashiers.setretailx.crystals.ru/"> <return>[Иван Иванов] doesn't have tabNum in input xml</return> </ns2:updateCashiersResponse> </soap:Body> </soap:Envelope>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:updateCashiersResponse xmlns:ns2="http://transport.cashiers.setretailx.crystals.ru/"> <return>Unable update cashiers. Reason: Unknown tabNumber [123456, 123457]</return> </ns2:updateCashiersResponse> </soap:Body> </soap:Envelope>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <soap:Fault> <faultcode>soap:Client</faultcode> <faultstring>Unmarshalling Error</faultstring> </soap:Fault> </soap:Body> </soap:Envelope>
Методы веб-сервиса для импорта справочника продавцов
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
Transaction Id
– является уникальным идентификатором этого пакета в SetRetail10, что накладывает определённые ограничения на повторный импорт пакета и загрузку разных типов данных с одним идентификатором.Методы веб-сервиса для импорта дисконтных карт и анкет клиентов
Без обратной связи | |
Метод | 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
Transaction Id
– является уникальным идентификатором этого пакета в SetRetail10, что накладывает определённые ограничения на повторный импорт пакета и загрузку разных типов данных с одним идентификатором.Начисление бонусных баллов через веб-сервис
Для начисления бонусных баллов из 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
Transaction Id
– является уникальным идентификатором этого пакета в SetRetail10, что накладывает определённые ограничения на повторный импорт пакета и загрузку разных типов данных с одним идентификатором.Методы веб-сервиса для импорта сегментов
Без обратной связи | |
Метод | 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
Transaction Id
– является уникальным идентификатором этого пакета в SetRetail10, что накладывает определённые ограничения на повторный импорт пакета и загрузку разных типов данных с одним идентификатором.Удаление участников сегментов
Без обратной связи | |
Метод | 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
Transaction Id
– является уникальным идентификатором этого пакета в SetRetail10, что накладывает определённые ограничения на повторный импорт пакета и загрузку разных типов данных с одним идентификатором.Методы веб-сервиса для импорта операций по подарочным картам
Активация подарочной карты | |
Метод | 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 | Дата регистрации чека Формат: YYYY-MM-DD | Нет | |
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>10000002233</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>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:activatePresentCardResponse xmlns:ns2="http://services.processing.cards.crystals.ru/"> <return> <activationDate>2023-10-05T14:37:57.367+03:00</activationDate> <amount>40000</amount> <balance>40000</balance> <cardNumber>10000002233</cardNumber> <maxAmount>0</maxAmount> <multiplicity>0</multiplicity> <status>Active</status> </return> </ns2:activatePresentCardResponse> </soap:Body> </soap:Envelope>
Замена подарочной карты | |
Метод | cardReplacement |
URL | http://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager |
WSDL | http://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager?wsdl |
Комментарий | Замена подарочной карты. Указываются номер двух карт, старой (которую требуется заменить), и новую (которая будет выдана вместо старой). |
Поле | Тип данных | Описание | Обязательное | |
Принимаемые параметры | ||||
cardNumberOld | String | Номер старой подарочной карты, которая будет деактивирована | Да | |
cardNumberNew | String | Номер новой подарочной карты, которая будет активирована | Да | |
purchaseUid | Collection | Набор полей чека | Нет | |
cashNum | Long | Номер кассы | Нет | |
checkNum | Long | Номер чека к которому будет привязана активация подарочной карты | Нет | |
createDate | dateTime | Дата регистрации чека Формат: YYYY-MM-DD | Нет | |
shiftNum | Long | Номер смены | Нет | |
shopNum | Long | Номер магазина | Нет | |
userName | String | Имя пользователя | Нет | |
userTabNumber | String | ID серверного пользователя | Нет | |
Возвращаемые параметры | ||||
cardReplacementResponse | Отображение наименования ответа cardReplacementResponse в случае успешной обработки пакета |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.processing.cards.crystals.ru/"> <soapenv:Header/> <soapenv:Body> <ser:cardReplacement> <!--Optional:--> <cardNumberOld>10000002233</cardNumberOld> <!--Optional:--> <cardNumberNew>10000002235</cardNumberNew> <!--Optional:--> <purchaseUid> <!--Optional:--> <cashNum>23</cashNum> <!--Optional:--> <checkNum>2</checkNum> <!--Optional:--> <createDate>2023-05-10</createDate> <!--Optional:--> <shiftNum>2</shiftNum> <!--Optional:--> <shopNum>779</shopNum> </purchaseUid> <!--Optional:--> <userName>manager</userName> <!--Optional:--> <userTabNumber>34</userTabNumber> </ser:cardReplacement> </soapenv:Body> </soapenv:Envelope>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:cardReplacementResponse xmlns:ns2="http://services.processing.cards.crystals.ru/"> <return/> </ns2:cardReplacementResponse> </soap:Body> </soap: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:deActivatePresentCard> <!--Optional:--> <cardNumber>10000002233</cardNumber> <!--Optional:--> <purchaseUid> <!--Optional:--> <cashNum>3</cashNum> <!--Optional:--> <checkNum>23</checkNum> <!--Optional:--> <createDate>2023-10-04</createDate> <!--Optional:--> <shiftNum>3</shiftNum> <!--Optional:--> <shopNum>779</shopNum> </purchaseUid> <!--Optional:--> <userName>manager</userName> <!--Optional:--> <userTabNumber>3</userTabNumber> </ser:deActivatePresentCard> </soapenv:Body> </soapenv:Envelope>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:deActivatePresentCardResponse xmlns:ns2="http://services.processing.cards.crystals.ru/"> <return> <amount>40000</amount> <balance>40000</balance> <cardNumber>10000002233</cardNumber> <maxAmount>0</maxAmount> <multiplicity>0</multiplicity> <status>Create</status> </return> </ns2:deActivatePresentCardResponse> </soap:Body> </soap:Envelope>
Получить информацию по подарочной карте | |
Метод | getPresentCardInfo |
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 | Новый номер карты из существующих диапазонов | Да | |
msrCardNumber | String | Номер карты из магнитной дорожки (полосы) | Нет | |
shopNumber | Long | Набор полей чека | Нет | |
Возвращаемые параметры | ||||
activationDate | dateTime | Дата активации | ||
amount | Long | Номинал | ||
balance | Long | Остаток на карте | ||
cardNumber | String | Номер карты | ||
maxAmount | String | Максимальный номинал | ||
multiplicity | String | Кратность | ||
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:getPresentCardInfo> <!--Optional:--> <request> <!--Optional:--> <cardNumber>10000002233</cardNumber> <!--Optional:--> <msrCardNumber>100000022339098213</msrCardNumber> <!--Optional:--> <shopNumber>779</shopNumber> </request> </ser:getPresentCardInfo> </soapenv:Body> </soapenv:Envelope>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:getPresentCardInfoResponse xmlns:ns2="http://services.processing.cards.crystals.ru/"> <return> <activationDate>2023-10-05T12:41:10.658+03:00</activationDate> <amount>40000</amount> <balance>40000</balance> <cardNumber>10000002233</cardNumber> <maxAmount>0</maxAmount> <multiplicity>0</multiplicity> <status>Active</status> </return> </ns2:getPresentCardInfoResponse> </soap:Body> </soap:Envelope>
Получить информацию по подарочной карте только по номеру | |
Метод | getPresentCardInformation |
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 | Новый номер карты из существующих диапазонов | Да | |
Возвращаемые параметры | ||||
activationDate | dateTime | Дата активации | ||
amount | Long | Номинал | ||
balance | Long | Остаток на карте | ||
cardNumber | String | Номер карты | ||
maxAmount | String | Максимальный номинал | ||
multiplicity | String | Кратность | ||
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:getPresentCardInformation> <!--Optional:--> <cardNumber>10000002234</cardNumber> </ser:getPresentCardInformation> </soapenv:Body> </soapenv:Envelope>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:getPresentCardInformationResponse xmlns:ns2="http://services.processing.cards.crystals.ru/"> <return> <activationDate>2023-10-05T12:43:34.256+03:00</activationDate> <amount>40000</amount> <balance>0</balance> <cardNumber>10000002234</cardNumber> <maxAmount>0</maxAmount> <multiplicity>0</multiplicity> <status>Used</status> </return> </ns2:getPresentCardInformationResponse> </soap:Body> </soap:Envelope>
Получить информацию по подарочной карте по номеру магнитной дорожки | |
Метод | getPresentCardInformationByMSRNumber |
URL | http://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager |
WSDL | http://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager?wsdl |
Комментарий | Получить информацию по подарочной карте по номеру магнитной полосы (дорожки) |
Поле | Тип данных | Описание | Обязательное | |
Принимаемые параметры | ||||
msrCardNumber | String | Номер карты из магнитной дорожки (полосы) | Да | |
Возвращаемые параметры | ||||
activationDate | dateTime | Дата активации | ||
amount | Long | Номинал | ||
balance | Long | Остаток на карте | ||
cardNumber | String | Номер карты | ||
maxAmount | String | Максимальный номинал | ||
multiplicity | String | Кратность | ||
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:getPresentCardInformationByMSRNumber> <!--Optional:--> <msrNumber>10000002235</msrNumber> </ser:getPresentCardInformationByMSRNumber> </soapenv:Body> </soapenv:Envelope>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:getPresentCardInformationByMSRNumberResponse xmlns:ns2="http://services.processing.cards.crystals.ru/"> <return> <amount>40000</amount> <balance>40000</balance> <cardNumber>10000002235</cardNumber> <maxAmount>0</maxAmount> <multiplicity>0</multiplicity> <status>Create</status> </return> </ns2:getPresentCardInformationByMSRNumberResponse> </soap:Body> </soap:Envelope>
Получить подробную информацию по подарочной карте, используя фильтры выборки поиска | |
Метод | getPresentCardsInfoByFilter |
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 | Номер карты | Нет | ||||
endDateFrom | dateTime | Дата окончания срока действия от Формат: YYYY-MM-DD | Нет | ||||
endDateTo | dateTime | Дата окончания срока действия до Формат: YYYY-MM-DD | Нет | ||||
operationDateFrom | dateTime | Дата начала действия по карте от Формат: YYYY-MM-DD | Нет | ||||
operationDateTo | dateTime | Дата начала действия по карте до Формат: YYYY-MM-DD | Нет | ||||
paymentDate | dateTime | Дата гашения Формат: YYYY-MM-DD | Нет | ||||
saleDate | dateTime | Дата продажи Формат: YYYY-MM-DD | Нет | ||||
startDateFrom | dateTime | Дата начала срока действия от Формат: YYYY-MM-DD | Нет | ||||
startDateTo | dateTime | Дата окончания срока действия до Формат: YYYY-MM-DD | Нет | ||||
status | Коллекция статусов | Статус
| Нет | ||||
Возвращаемые параметры | |||||||
getPresentCardsInfoByFilterResponse | Base64 | Информация по подарочной карте в формате Base64 Пример ответа в base64. | |||||
| Long | Номер карты | |||||
| Long | Номинал | |||||
| String | Статус
| |||||
| String | Дата начала действия | |||||
| String | Дата окончания | |||||
| String | Номер новой карты в замен этой, если есть | |||||
| Комплексный | Действия с картой:
| |||||
| Комплексный | Причина блокировки | |||||
| Комплексный | Причина продления |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.processing.cards.crystals.ru/"> <soapenv:Header/> <soapenv:Body> <ser:getPresentCardsInfoByFilter> <!--Optional:--> <filter> <!--Optional:--> <cardNumber>10000002234</cardNumber> <!--Optional:--> <endDateFrom>2023-10-05</endDateFrom> <!--Optional:--> <endDateTo>2024-10-05</endDateTo> <!--Optional:--> <operationDateFrom>2023-10-02</operationDateFrom> <!--Optional:--> <operationDateTo>2024-10-05</operationDateTo> <!--Optional:--> <paymentDate>2023-10-05</paymentDate> <!--Optional:--> <saleDate>2023-10-05</saleDate> <!--Optional:--> <startDateFrom>2023-10-05</startDateFrom> <!--Optional:--> <startDateTo>2023-10-05</startDateTo> <!--Optional:--> <status>Active</status> </filter> </ser:getPresentCardsInfoByFilter> </soapenv:Body> </soapenv:Envelope>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <presentCards xmlns="http://crystals.ru/cards/presentcards/report"> <presentCard> <cardNumber>10000002234</cardNumber> <amount>40000</amount> <balance>40000</balance> <status>Active</status> <startDate>2023-10-05T12:43:34.256+03:00</startDate> <endDate xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/> <replacedCardNumber/> <actions> <action type="Create" date="2023-10-05T12:43:34.256+03:00" source="SERVER"/> <action type="Activate" date="2023-10-05T12:43:34.257+03:00" source="SERVER"/> </actions> <blockingCause xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/> <prolongationCause xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/> </presentCard> </presentCards>
Погасить подарочную карту (перевести в статус "использована/погашена") | |
Метод | 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>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:paymentPresentCardResponse xmlns:ns2="http://services.processing.cards.crystals.ru/"/> </soap:Body> </soap:Envelope>
Списать сумму с подарочной карты | |
Метод | redeemPresentCard |
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 | Отображение наименования ответа redeemPresentCardResponse в случае успешной обработки пакета |
<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>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:redeemPresentCardResponse xmlns:ns2="http://services.processing.cards.crystals.ru/"/> </soap:Body> </soap:Envelope>
Переотправить подарочные карты в SetESB/Kafka по фильтру | |
Метод | resendPresentCardsToKafkaByFilter |
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 | Номер карты | Нет | ||||
endDateFrom | dateTime | Дата окончания срока действия от Формат: YYYY-MM-DD | Нет | ||||
endDateTo | dateTime | Дата окончания срока действия до Формат: YYYY-MM-DD | Нет | ||||
operationDateFrom | dateTime | Дата начала действия по карте от Формат: YYYY-MM-DD | Нет | ||||
operationDateTo | dateTime | Дата начала действия по карте до Формат: YYYY-MM-DD | Нет | ||||
paymentDate | dateTime | Дата гашения Формат: YYYY-MM-DD | Нет | ||||
saleDate | dateTime | Дата продажи Формат: YYYY-MM-DD | Нет | ||||
startDateFrom | dateTime | Дата начала срока действия от Формат: YYYY-MM-DD | Нет | ||||
startDateTo | dateTime | Дата окончания срока действия до Формат: YYYY-MM-DD | Нет | ||||
status | Коллекция статусов | Статус
| Нет | ||||
Возвращаемые параметры | |||||||
resendPresentCardsToKafkaByFilter | Base64 | Отображение наименования ответа resendPresentCardsToKafkaByFilter в случае успешной обработки пакета |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.processing.cards.crystals.ru/"> <soapenv:Header/> <soapenv:Body> <ser:resendPresentCardsToKafkaByFilter> <!--Optional:--> <filter> <!--Optional:--> <cardNumber>10000002234</cardNumber> <!--Optional:--> <endDateFrom>2023-10-05</endDateFrom> <!--Optional:--> <endDateTo>2024-10-05</endDateTo> <!--Optional:--> <operationDateFrom>2023-10-02</operationDateFrom> <!--Optional:--> <operationDateTo>2024-10-05</operationDateTo> <!--Optional:--> <paymentDate>2023-10-05</paymentDate> <!--Optional:--> <saleDate>2023-10-05</saleDate> <!--Optional:--> <startDateFrom>2023-10-05</startDateFrom> <!--Optional:--> <startDateTo>2023-10-05</startDateTo> <!--Optional:--> <status>Active</status> </filter> </ser:resendPresentCardsToKafkaByFilter> </soapenv:Body> </soapenv:Envelope>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:resendPresentCardsToKafkaByFilterResponse xmlns:ns2="http://services.processing.cards.crystals.ru/"/> </soap:Body> </soap:Envelope>
Отмена использования подарочной карты (возврат из статуса погашенной) | |
Метод | undoUsePresentCard |
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 серверного пользователя | Нет | |
Возвращаемые параметры | ||||
activationDate | dateTime | Дата активации | ||
amount | Long | Номинал | ||
balance | Long | Остаток на карте | ||
cardNumber | String | Номер карты | ||
maxAmount | String | Максимальный номинал | ||
multiplicity | String | Кратность | ||
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:undoUsePresentCard> <!--Optional:--> <cardNumber>10000002234</cardNumber> <!--Optional:--> <purchaseUid> <!--Optional:--> <cashNum>3</cashNum> <!--Optional:--> <checkNum>2</checkNum> <!--Optional:--> <createDate>2023-10-05</createDate> <!--Optional:--> <shiftNum>34</shiftNum> <!--Optional:--> <shopNum>57</shopNum> </purchaseUid> <!--Optional:--> <userName>manager</userName> <!--Optional:--> <userTabNumber>344</userTabNumber> </ser:undoUsePresentCard> </soapenv:Body> </soapenv:Envelope>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:undoUsePresentCardResponse xmlns:ns2="http://services.processing.cards.crystals.ru/"> <return> <activationDate>2023-10-05T12:43:34.256+03:00</activationDate> <amount>40000</amount> <balance>40000</balance> <cardNumber>10000002234</cardNumber> <maxAmount>0</maxAmount> <multiplicity>0</multiplicity> <status>Active</status> </return> </ns2:undoUsePresentCardResponse> </soap:Body> </soap:Envelope>
Разблокировка подарочной карты (возврат из статуса заблокированной) | |
Метод | unblockPresentCard |
URL | http://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager |
WSDL | http://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager?wsdl |
Комментарий | Разблокировать подарочную карту. |
10.4.1.0
Поле | Тип данных | Описание | Обязательное | |
Принимаемые параметры | ||||
cardNumber | String | Номер карты | Да | |
purchaseUid | Collection | Набор полей чека | Нет | |
cashNum | Long | Номер кассы | Нет | |
checkNum | Long | Номер чека, к которому будет привязана разблокировка подарочной карты | Нет | |
createDate | dateTime | Дата регистрации чека Формат: YYYY-MM-DD | Нет | |
shiftNum | Long | Номер смены | Нет | |
shopNum | Long | Номер магазина | Нет | |
userName | String | Имя пользователя | Нет | |
userTabNumber | String | ID серверного пользователя | Нет | |
comment | String | Комментарий | Нет | |
Возвращаемые параметры | ||||
unblockPresentCardResponse | Отображение наименования ответа |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.processing.cards.crystals.ru/"> <soapenv:Header/> <soapenv:Body> <ser:unblockPresentCard> <!--Optional:--> <cardNumber>2000</cardNumber> <!--Optional:--> <purchaseUid> <!--Optional:--> <cashNum>60</cashNum> <!--Optional:--> <checkNum>3</checkNum> <!--Optional:--> <createDate>2024-03-07T17:20:00</createDate> <!--Optional:--> <shiftNum>3</shiftNum> <!--Optional:--> <shopNum>188</shopNum> </purchaseUid> <!--Optional:--> <userName>Ext_user</userName> <!--Optional:--> <userTabNumber>3</userTabNumber> <!--Optional:--> <comment>Unblock card from external system</comment> </ser:unblockPresentCard> </soapenv:Body> </soapenv:Envelope>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:unblockPresentCardResponse xmlns:ns2="http://services.processing.cards.crystals.ru/"/> </soap:Body> </soap:Envelope>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <soap:Fault> <faultcode>soap:Server</faultcode> <faultstring>Некорректное состояние карты</faultstring> <detail> <ns1:PresentCardException xmlns:ns1="http://services.processing.cards.crystals.ru/"/> </detail> </soap:Fault> </soap:Body> </soap:Envelope>
© 1994-2024, ООО "Кристалл Сервис Интеграция".
Все права защищены.