Формат MS5. Спецификация формата MS5.

Описание файлов составляющих формат MS5

Вместе с MS5-документом, имеющим расширение .xml, формат MS5 включает в себя одноименную папку (с приставкой files_), в которой находятся две другие папки: base_files и shop_files. Папка base_files содержит исходные файлы изображений товаров, значений характеристик и окантовки для товаров. В папке же shop_files находятся сформированные файлы изображений товаров и значений характеристик. Наличие любых файлов не является обязательным, то есть они могут не поставляться вместе с MS5-документом.

Структура MS5-документа

<MS5>

<Info>

<Value>

<Icon>

<Topic>

<Icon>

<Store>

<Goods>

<Icon>

<Image>

<Icon>

<Trait>

<Place>

<Set>

<Order>

<Store>

<Goods>

<Field>

<MS5>

Основной элемент документа.

Атрибут

Тип данных

Описание

version

String

Номер версии MS5-документа

generate

String

Программа в который был сгенерирован данный документ.

- обязательный атрибут

- специфический атрибут, используемый программой Melbis Shop

» назад к структуре

Элемент товарных предложений.

Атрибут

Тип данных

Описание

with_base_file

True/False

Флаг, указывающий на то, прилагаются ли к данному документы исходные изображения (True) или нет (False).

date_time

String

Дата и время создания элемента.
Формат: Год-месяц-число часы(24h): минуты:секунды.

- обязательный атрибут

- специфический атрибут, используемый программой Melbis Shop

» назад к структуре

Элемент дерева характеристик и их значений для товаров.

<Info>

Элемент характеристики.

Атрибут

Тип данных

Описание

Integer(>0)

ID - уникальный идентификатор характеристики.

parent_id

Integer

ID родителя в дереве. Имеет значение 0, если элемент расположен в корне.

name

String(255)

Наименование характеристики.

descr

String

Описание характеристики.

is_folder

True/False

Флаг, указывающий тип характеристики. True - группа характеристик (раздел), False - непосредственно сама характеристика (файл).

key_name

String(20)

Ключ в шаблоне на место которого подставляется значение характеристики.

in_main

True/False

Флаг отображения характеристики в каталоге.

in_preview

True/False

Флаг отображения характеристики на странице или в расширенном описании товара.

in_family

True/False

Флаг отображения характеристики на странице товара в таблице семейства товаров.

- обязательный атрибут

- специфический атрибут, используемый программой Melbis Shop

» назад к структуре

<Value>

Элемент значения характеристики.

Атрибут

Тип данных

Описание

Integer(>0)

ID - уникальный идентификатор значения характеристики.

name

String(255)

Непосредственно значение характеристики.

- обязательный атрибут

- специфический атрибут, используемый программой Melbis Shop

» назад к структуре

<Icon>

Элемент связки изображения с конечным файлом.

Атрибут

Тип данных

Описание

icon_file

String

Наименования файла сформированного изображения.

base_file

String

Наименование файла исходного изображения.

base_x

Integer

Координата Х левого угла вырезаемой области исходного изображения. Начало координат в верхнем левом углу.

base_y

Integer

Координата Y левого угла вырезаемой области исходного изображения. Начало координат в верхнем левом углу.

base_w

Integer

Ширина вырезаемой области исходного изображения.

base_h

Integer

Высота вырезаемой области исходного изображения.

icon_x

Integer

Отступ слева вставленной области исходного изображения внутрь формируемой иконки.

icon_y

Integer

Отступ сверху вставленной области исходного изображения внутрь формируемой иконки.

icon_w

Integer

Ширина иконки либо новое значение ширины области исходного изображения.

icon_h

Integer

Высота иконки либо новое значение высоты области исходного изображения.

pos_center

True/False

Флаг автоматического позиционирования вырезанной области исходного изображения, внутри формируемой иконки.

color_trans

Integer

Код цвета, который следует считать прозрачным в изображении окантовки.

color_back

Integer

Код цвета заднего фона формируемой иконки.

border_w

Integer

Величина отступа от краев вставленной области исходного изображения внутрь формируемой иконки.

border_file

Integer

Наименование файла c изображением окантовки.

- обязательный атрибут

- специфический атрибут, используемый программой Melbis Shop

» назад к структуре

Элемент дерева разделов для товаров.

<Topic>

Элемент раздела.

Атрибут

Тип данных

Описание

Integer(>0)

ID - уникальный идентификатор раздела.

parent_id

Integer

ID родителя в дереве. Имеет значение 0, если элемент расположен в корне.

name

String(255)

Наименование раздела.

full_descr

String

Описание раздела для покупателей.

active

True/False

Флаг состояния: True - отображать, False - не отображать.

is_type

Integer

Код типа раздела. Возможные значения:

- 0 : "Отдел с товарами";

- 1 : "Страница с текстом";

- 2 : "Ссылка на страницу";

- 3 : "Первая страница магазина".

link

String(255)

URL-адрес ссылки. Имеет смысл когда атрибут is_type имеет значение 2.

seo_title

String(255)

Заголовок страницы для SEO.

seo_descr

String(255)

Краткое описание для SEO.

seo_keywords

String(255)

Набор ключевых слов для SEO.

seo_link

String(255)

Подпись к ссылке на раздел для SEO.

seo_psu

String(70)

Псевдостатический код раздела для SEO.

in_xml

True/False

Флаг отображения раздела при формировании XML каталога: True - отображать, False - не отображать

div_before

True/False

Флаг разделителя перед разделом: True - отображать, False - не отображать.

in_cat_left

True/False

Флаг отображения раздела в каталоге типа "Боковой слева": True - отображать, False - не отображать.

in_cat_center

True/False

Флаг отображения раздела в каталоге типа "Центральный": True - отображать, False - не отображать.

in_cat_menu

True/False

Флаг отображения раздела в каталоге типа "Верхнее меню": True - отображать, False - не отображать.

in_cat_down

True/False

Флаг отображения раздела в каталоге типа "Выпадающий": True - отображать, False - не отображать.

template_name

String(50)

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

templates_goods

String(50)

Наименование папки с дизайн-макетом товаров раздела.

main_goods_col

Integer

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

step_goods

Integer

Количество товаров отображаемых за раз на одной странице раздела.

new_goods_col

Integer

Количество колонок для товаров в блоке "Новинки".

new_goods_how

Integer

Количество отображаемых товаров в блоке "Новинки".

hit_goods_col

Integer

Количество колонок для товаров в блоке "Хиты".

hit_goods_how

Integer

Количество отображаемых товаров в блоке "Хиты".

sub_sec_type

Integer

Код способа отображения подразделов данного раздела. Возможные значения:

- 0 : "Простой (1 уровень)",

- 1 : "С его подразделами (2 уровень)".

order_by_voice

True/False

Флаг активирующий способ сортировки товаров в разделе: True - по отзывам к товарам, False - по заданному порядку.

- обязательный атрибут

- специфический атрибут, используемый программой Melbis Shop

» назад к структуре

Элемент списка валют для задания цен товарам.

Элемент валюты.

Атрибут

Тип данных

Описание

Integer(>0)

ID - уникальный идентификатор валюты.

name

String(255)

Наименование валюты.

multiplex

Currency(0.00)

Курс перевода валюты по отношению к базовой валюте магазина.

division

True/False

Флаг курса перевода: True - делить на курс перевода, False - умножать на курс перевода.

- обязательный атрибут

- специфический атрибут, используемый программой Melbis Shop

» назад к структуре

Элемент списка поставщиков товаров.

Элемент поставщика.

Атрибут

Тип данных

Описание

Integer(>0)

ID - уникальный идентификатор поставщика.

name

String(255)

Наименование поставщика.

manager

String(255)

Менеджер поставщика.

e-mail

String(75)

E-mail адрес менеджера поставщика.

phone

String(255)

Телефон менеджера поставщика.

- обязательный атрибут

- специфический атрибут, используемый программой Melbis Shop

» назад к структуре

<Store>

Элемент списка товаров.

<Goods>

Элемент товара.

Атрибут

Тип данных

Описание

Integer(>0)

ID - уникальный идентификатор товара.

name

String(255)

Наименование товара.

code

String(255)

Артикул товара в магазине.

descr

String

Краткое описание товара.

price

Currency(0.00)

Стоимость товара.

curr_id

Integer

Идентификатор валюты для стоимости товара.

disc_price

Currency(0.00)

Стоимость товара для распродажи.

disc_price_curr_id

Integer

Идентификатор валюты для стоимости товара для распродажи.

prov_price

Currency(0.00)

Стоимость товара от поставщика.

prov_price_curr_id

Integer

Идентификатор валюты для стоимости товара от поставщика.

provider_id

Integer

Идентификатор поставщика.

meas

String(20)

Единица измерения товара.

status

Integer

Статус товара: 0 - "Есть на складе", 1 - "Отсутствует", 2 - "Ожидается", 3 - "Под заказ"

active

True/False

Флаг состояния: True - отображать, False - не отображать.

part_proc

Currency(0.00)

Процент от стоимости товара, выплачиваемый партнерам.

step_order

Integer

Шаг заказа товара.

min_order

Integer

Минимальное количество товара для заказа.

tax

Currency(0.00)

Такса товара (для расчета стоимости доставки).

how

Integer

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

kind

Integer

Тип товара: 0 - "Обычный товар", 1 - "Только в комплекте", 2 - "Комплект товаров".

seo_title

String(255)

Заголовок страницы для SEO.

seo_descr

String(255)

Краткое описание для SEO.

seo_keywords

String(255)

Набор ключевых слов для SEO.

seo_link

String(255)

Подпись к ссылке на товар для SEO.

seo_alt

String(255)

Альтернативный текст к изображению товара для SEO.

seo_psu

String(70)

Псевдостатический код товара для SEO.

in_xml

True/False

Флаг отображения товара при формировании XML каталога: True - отображать, False - не отображать

- обязательный атрибут

- специфический атрибут, используемый программой Melbis Shop

» назад к структуре

Элемент расширенного описания товара.

Атрибут

Тип данных

Описание

template_type

Integer

Код типа используемого макета для расширенного описания. Макет определяет стиль и способ компоновки текста и изображения. Возможные значения:

- от 0 до 3 : один из четырех стандартных макетов;

- 4 : используется собственный макет (определяется через атрибут "template")

template

String(50)

Наименование папки с собственным макетом расширенного описания. Имеет смысл, когда атрибут "template_type" имеет значение "4". Перед импортом папка с макетом должна находится в подкаталоге "Templates" в папке базы данных магазина.

title

String(255)

Заголовок расширенного описания товара.

col_big

Integer

Количество колонок для изображении класса "Большие".

col_small

Integer

Количество колонок для изображении класса "Маленькие".

font_title

String(255)

Наименование шрифта для заголовка расширенного описания.

font_img

String(255)

Наименование шрифта для подписи к изображениям.

size_title

Integer

Размер шрифта для заголовка расширенного описания.

size_img

Integer

Размер шрифта для подписи к изображениям.

open_type

Integer

Код способа просмотра расширенного описания:

- 0 : в выпадающем окне (pop-up);

- 1 : на странице товара.

Integer

Положение окна расширенного описания по оси Х. Имеет смысл, когда атрибут "open_type" имеет значение "0".

Integer

Положение окна расширенного описания по оси Y. Имеет смысл, когда атрибут "open_type" имеет значение "0".

Integer

Ширина окна расширенного описания. Имеет смысл, когда атрибут "open_type" имеет значение "0".

Integer

Высота окна расширенного описания. Имеет смысл, когда атрибут "open_type" имеет значение "0".

- обязательный атрибут

- специфический атрибут, используемый программой Melbis Shop

» назад к структуре

Элемент списка изображений в расширенном описании товара.

<Image>

Элемент изображения.

Атрибут

Тип данных

Описание

type

Integer

Код класса изображения. Возможные значения:

- 0 : "Большое" изображение;

- 1 : "Маленькое" изображение;

- 2 : "Увеличенное" изображение.

descr

String(255)

Краткое описание или подпись к изображению.

- обязательный атрибут

- специфический атрибут, используемый программой Melbis Shop

» назад к структуре

Элемент содержащий текстовый блок для расширенного описания товара.

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

<Trait>

Элемент связи характеристики и ее значения с товаром.

Атрибут

Тип данных

Описание

info_id

Integer

ID характеристики.

value_id

Integer

ID значения характеристики.

- обязательный атрибут

- специфический атрибут, используемый программой Melbis Shop

» назад к структуре

Элемент списка разделов в которых находится товар.

<Place>

Элемент связи раздела с товаром.

Атрибут

Тип данных

Описание

topic_id

Integer

ID раздела.

pos

Integer

Индекс определяющий позицию товара в разделе.

- обязательный атрибут

- специфический атрибут, используемый программой Melbis Shop

» назад к структуре

Элемент списка комплектующих товара. Имеет смысл, когда атрибут kind элемента Goods имеет значение 2.

<Set>

Элемент комплектующего.

Атрибут

Тип данных

Описание

goods_id

Integer

ID товара входящего в комплект.

how

Integer

Количество товара в комплекте.

- обязательный атрибут

- специфический атрибут, используемый программой Melbis Shop

» назад к структуре

Элемент списка заказов.

Атрибут

Тип данных

Описание

date_time

String

Дата и время создания элемента.
Формат: Год-месяц-число часы(24h): минуты:секунды.

- обязательный атрибут

- специфический атрибут, используемый программой Melbis Shop

» назад к структуре

<Order>

Элемент заказа.

Атрибут

Тип данных

Описание

Integer(>0)

ID - уникальный идентификатор заказа.

sid

String(32)

Идентификационный код заказа.

date_time

String

Дата и время создания заказа.
Формат: Год-месяц-число часы(24h): минуты:секунды.

code

String(255)

Код заказа

status

Integer

Статус заказа: 0 - "Новый заказ", 1 - "Принят к выполнению", 2 - "В процессе доставки", 3 - "Выполнен", 4 - "Аннулирован"

payment

Integer

Статус оплаты заказа: 1 - "Не оплачен", 2 - "Оплачен".

in_all_sum

Currency(0.00)

Сумма "Итого".

discount_sum

Currency(0.00)

Сумма скидки.

condition_sum

Currency(0.00)

Сумма стоимости дополнительных услуг.

delivery_sum

Currency(0.00)

Сумма стоимости доставки.

total_sum

Currency(0.00)

Сумма "Всего".

payment_sum

Currency(0.00)

Сумма "К оплате".

condition_value

String

Наименование дополнительных услуг.

delivery_value

String(255)

Наименование способа доставки.

payment_value

String(255)

Наименование способа расчета.

payment_currency

String(20)

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

client_note

String

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

service_note

String

Внутреннее примечание к заказу.

delivery_id

Integer(>0)

ID - уникальный идентификатор доставки.

condition_code

String(255)

Перечень идентификаторов дополнительных условий (символ разделитель - ";").

payment_id

Integer(>0)

ID - уникальный идентификатор способа оплаты.

client_id

Integer(>0)

ID - уникальный идентификатор клиента.

manager_id

Integer(>0)

ID - уникальный идентификатор менеджера заказа.

partner_id

Integer(>0)

ID - уникальный идентификатор партнера.

partner_sum

Currency(0.00)

Сумма общего партнерского вознаграждения.

- обязательный атрибут

- специфический атрибут, используемый программой Melbis Shop

» назад к структуре

<Store>

Элемент списка товаров заказа.

<Goods>

Элемент товара.

Атрибут

Тип данных

Описание

Integer(>0)

ID - уникальный идентификатор товара.

code

String(255)

Артикул товара.

meas

String(20)

Единица измерения количества товара.

name

String(255)

Наименование товара.

parameter_value

String

Наименование дополнительных параметров товара.

start_price

Currency(0.00)

Исходная стоимость товара.

final_price

Currency(0.00)

Продажная стоимость товара за вычетом скидок.

prov_price

Currency(0.00)

Стоимость товара от поставщика.

provider_id

Integer

Идентификатор поставщика.

tax

Currency(0.00)

Такса товара (для расчета стоимости доставки).

inside_disc

Currency(0.00)

Сумма внутренней скидки.

how_ordered

Integer

Заказанное количество.

discount_in_all_sum

Currency(0.00)

Суммарная величина скидки.

partner_procent

Currency(0.00)

Партнерский процент.

partner_sum

Currency(0.00)

Сумма партнерского вознаграждения.

- обязательный атрибут

- специфический атрибут, используемый программой Melbis Shop

» назад к структуре

Элемент списка регистрационных полей покупателя.

Атрибут

Тип данных

Описание

String(255)

Логин покупателя.

String(75)

E-mail адрес покупателя.