Импорт покупателей на сайт - XML файл

На данной странице описана структура содержимого XML файла, использующегося для импорта покупателей на сайт на платформе komiz.io из системы бухгалтерского учета, например «1C».

Ниже приведен сокращенный пример файла имеющего описываемый формат (полный пример приведен далее).

	<?xml version="1.0" encoding="utf-8"?>
	<users amount="2">                          <!-- Содержит теги покупателей -->
		<user asId="12345678">                  <!-- Содержит информацию об одном покупателе -->
			<login>user1</login>                <!-- Одно из полей покупателя -->
			...
		</user>
		<user asId="87654321">
			...
		</user>
	</users>

Символом «троеточие» обозначены участки файла, которые в действительном файле заполнены, но в примере выше упущены с целью улучшения понимания общего принципа организации файла.

Данные в файле содержатся в кодировке UTF-8.

Ниже перечислены основные особенности структуры файла.

  • Коренным тегом XML документа является users. Он является контейнером списка покупателей, каждому из которых соответствует дочерний тег user.
  • Тег user в дочерних тегах и атрибутах содержит информацию о самом покупателе.

ОБРАТИТЕ ВНИМАНИЕ!

  • Все атрибуты тегов должны обязательно присутствовать.
  • Большинство тегов могут отсутствовать. Исключением коренной тег users. Если необязательного тега не передается, то соответствующее ему данное либо не изменяется (при существовании покупателя в базе данных сайта), либо заполняется «пустым значением» (в случае отсутствия покупателя в базе данных сайта).
  • Нужно учесть, что количество повторяемых тегов варьируется относительно количества отображаемых ими «сущностей». Например, количество тегов user равно количеству покупателей в данном файле (т.е. может быть равным нулю).

Ниже приведен перечень всех XML тегов, используемых в описываемом файле, с указанием инструкций по их использованию. Теги перечислены в алфавитном порядке.

Тег Контекст Содержимое Атрибуты Описание
activeKey user Цифра 1 или 0 Флаг указывающий активировать ли покупателя или нет. 1 - активировать. Все остальные значения игнорируются.
additionalField user Строка
0-4294967296
name - [строка: 1-255] - Значение поля «Имя в интерфейсе» для данного дополнительного поля. «Дополнительное поле» покупателя
country user Строка
1-255
«Страна» покупателя
description user Строка
0-255
Поле покупателя «Описание»
deleteKey user Цифра 1 или 0 Флаг указывающий удалить ли покупателя или нет. 1 - удалить. Все остальные значения игнорируются.
discount user Дробное число, разделитель «точка», максимум два символа после точки, если она есть
0-100
Поле покупателя «Скидка», в процентах.
ВНИМАНИЕ! Если передается, то скидка покупателя меняет свой тип на «Ручной» и устанавливается равной передаваемому значению.
Если не передается - то, если покупатель создается, ему будет назначена скида по умолчанию, а тип скидки будет установлен «Накопительная»
email user Строка
0-255
«Email» покупателя
firstName user Строка
0-255
Поле покупателя «Имя»
lastName user Строка
0-255
Поле покупателя «Фамилия»
login user Строка
0-255
«Логин» покупателя
middleName user Строка
0-255
Поле покупателя «Отчество»
minDiscount user Дробное число, разделитель «точка», максимум два символа после точки, если она есть
0-100
Поле покупателя «Минимальная скидка», в процентах
passwordHash user Строка
64
Хеш пароля покупателя, сформированный по алгоритму SHA-256
priceType user Строка
0-255
Тип цен, с которым связан данный покупатель. Если пустая строка - значит покупатель не связан с типом цен
telephone user Строка
0-255
«Телефон» покупателя
user users Дочерние теги id - [число: 1-2147483647] - Идентификатор покупателя на сайте. Может быть равен пустой строке, т.е. быть не указан. Единственная возможно отредактировать значение asId это указать значение поля id.
asId - [строка: 0-255] - Идентификатор покупателя в системе бухгалтерского учета (accounting system id). Должен быть всегда указан.
Информация о покупателе
users Коренной Дочерние теги Является контейнером для тегов покупателей (user)

<?xml version="1.0" encoding="utf-8"?>
<users amount="1">
	<user asId="test3">
		<deleteKey>0</deleteKey>
		<email>a1234567@site.com</email>
		<passwordHash>ef797c8118f02dfb649607dd5d3f8c7623048c9c063d532cc95c5ed7a898a64f</passwordHash>
		<telephone>0987654321</telephone>
		<login>some_user</login>
		<firstName>Иван</firstName>
		<middleName>Васильевич</middleName>
		<lastName>Бунша</lastName>
		<description>Создан пользователем ПУ</description>
		<additionalField name="Описание">Данный пользователь используется для тестирования работы магазина нашими операторами</additionalField>
		<activeKey>1</activeKey>
	</user>
</users>