Веб-сервис импорта подарочных карт

Публичный ресурс

Веб-сервис импорта подарочных карт

https://crystals.atlassian.net/browse/SR-5903

https://crystals.atlassian.net/browse/CR-8099

10.3.21.0

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

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

Метод

importGiftCards

URL

http://IP-адрес_сервера:8090/PresentCardsImporter/SET/Cards/PresentCards/Import

WSDL

http://IP-адрес_сервера:8090/PresentCardsImporter/SET/Cards/PresentCards/Import?wsdl

Формат данных для импорта подарочных карт

Категории подарочных карт

Атрибут

Тип данных

Описание

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

Атрибут

Тип данных

Описание

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

Id

Long

Идентификатор категории, для которой импортируются экземпляры ПК

Да

name

String

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

Да

start-from-number

String

Номер первой карты диапазона

Да

count

Integer

Количество карт в диапазоне

Запрещены отрицательные значения

Да

Сроки действия карт - комплексный:

Варианты:

  • в указанных период - задаются значения сроков действия

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

date-start

DateTime

Дата начала срока действия карт диапазона.

Нельзя загружать позже срока окончания.

Нет

date-finish

DateTime

Дата окончания срока действия карт диапазона.

Нельзя загружать раньше срока начала.

Нет

validity

Integer

Срок действия карты с момента активации.

Обязателен с параметром validity-time-unit

Да, при соблюдении условий

validity-time-unit

String

Варианты значений: дней, недель, месяцев, лет

Обязателен с параметром validity

Параметры:

  • DAYS

  • WEEKS

  • MONTHS

  • YEARS

Да, при соблюдении условий

fixed-face-value

Boolean

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

Нет

face-value

Long

Сумма фиксированного номинала в минимальных единицах валюты. Если fixed-face-value имеет значение false, то этот атрибут можно не указывать.

Да, при соблюдении условий

max-face-value

Long

Максимальная сумма произвольного номинала в минимальных единицах валюты. Если fixed-face-value имеет значение true, то этот атрибут можно не указывать.

Да, при соблюдении условий

multiplicity

Long

Кратность для суммы произвольного номинала в минимальных единицах валюты. Если fixed-face-value имеет значение true, то этот атрибут можно не указывать.

Да, при соблюдении условий

partial-payment-enabled

Boolean

Признак определяет, разрешено ли частичное гашение карт.

Если не передан, то не проставляется.

Нет

topology-filters

String

Привязка категории к “группе магазинов”.

https://crystals.atlassian.net/browse/SR-5904

https://crystals.atlassian.net/browse/CR-8102

10.3.21.0

Формат записи в JSON

1. Формат записывается в следующем составе:

  • id - индекс

    • Берется индекс того объекта зоны покрытия level, который присваивается для его указания:

      • Если REGION, то ID из сервера SetCentrum базы данных 

        set, таблица 

        topology_region.

      • Если CITY, то ID из сервера SetCentrum базы данных 

        set, таблица 

        topology_city.

      • Если SHOP, то ID из сервера SetCentrum базы данных 

        set, таблица 

        topology_shop.

  • level - зона покрытия привязывается к id в зависимости от типа.

    • ALL - все;

    • REGION - регион;

    • CITY - город;

    • SHOP - магазин.

  • formats - наименование формата.

    • Название из поля name сервера SetCentrum базы данных 

      set, таблица 

      topology_format.

[{"id": 63568, "level": "REGION", "formats": [{"id":63568,"name":"ГM1"}]}]

2. Следующим этапом является обязательное экранирование списка магазинов:

[{"id": 63568, "level": "REGION", "formats": [{"id":63568,"name":"ГM1"}]}]

Экранировать можно с помощью онлайн-инструмента.

  • Для экранирования скопируйте JSON-запрос по примеру из п.1 → кликните Escape XML.

  • Для преобразования без экранирования скопируйте экранированный JSON-запрос по примеру из п.2 → кликните Unescape XML.

Нет

deleted

Boolean

Признак определяет, что данный диапазон удалён.

Если не передан, то не проставляется.

Нет

Экземпляры подарочных карт

Поле

Тип данных

Описание

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

Поле

Тип данных

Описание

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

number

String

Номер подарочной карты

Да

category-Id

Long

Привязка карты к категории.

ВАЖНО! Карта может быть привязана к любой категории, даже если она не попадает в диапазон.

Да

date-finish

DateTime

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

Да

activation-date

DateTime

Дата активации карты

Да

face-value

Long

Номинал подарочной карты.

Значение указывается в минимальных единицах валюты. Не может быть отрицательным и нулевым.

Например, для карты номиналом 2000 рублей необходимо передать значение face-value="200000"

Да

balance

Long

Баланс подарочной карты.

Значение указывается в минимальных единицах валюты. Не может быть отрицательным. 

Например, для карты с балансом 500 рублей 50 копеек необходимо передать значение face-value="50050"

Нет

code

String

Проверочный код.

Данный параметр не поддерживается в текущей версии.

Нет

deleted

Boolean

Признак определяет, что данная карта удалена.

Нет

status

String

Варианты значений:

  • Create - создана, неактивна

  • Active - активирована

  • Blocked - заблокирована

  • Used - использована (погашена)

Да

Логика импорта

  1. При импорте категорий и экземпляров подарочных карт данные в SetCentrum перезаписываются.

  2. Категорию и экземпляры подарочных карт можно загружать, как вместе, так и отдельно.

Пример импорта

Пример файла импорта с экранированием.

 

© 1995-2026, ООО "Кристалл Сервис Интеграция".
Все права защищены.

Политика обработки персональных данных