Формат данных веб-сервиса по управлению статусами и балансами подарочных карт из ERP в SetRetail10

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

  • Возможны только варианты импорта по подарочным картам ниже.
  • Импорт начисления баланса подарочных карт или её экземпляра в виде xml-сообщений не предусмотрен.

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

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

Метод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>

-

Формат данных

presentCards/presentCard

Наименование атрибута

Тип данных

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

Описание

cardNumber

StringДаНомер карты
amountLongДаНоминал
balanceLongНетОстаток на карте
statusStringДа

Статус:

  • Activate
  • Blocked
  • Changed
  • Create
  • EXTEND
  • Inactive
  • PARTIAL_USE
  • UNDO_USE
  • Used
startDateDateДа

Дата начала действия карты

Формат: yyyy-MM-dd hh:mm:ss.mmm

endDateDateНет

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

Формат: yyyy-MM-dd hh:mm:ss.mmm

replacedCardNumberStringНетНомер карты замены
actionsCollectionДаНабор действий с картой

typeStringДаНазвание действия
dateDateДаДата совершения действия
loginStringНетФИО или логин совершившего действие
sourceStringДа

Инициатор действия:

  • CASH
  • ERP
  • SERVER
  • UNKNOWN
cashStringНетНомер кассы
shopStringДаНомер магазина