Содержание

Связанные референсы - getrefrelationship

Фильтрация по типам связи

Описание параметров запроса

Связанные референсы - getrefrelationship

Поддерживаемые параметры: commercialRef, pageSize, page, brand

Предыдущий функционал связанных референсов больше не поддерживается. Старые методы API автоматически передают запрос на новый метод, который возвращает выдачу с новой структурой данных. Обязательно обновите вашу систему, чтобы все полученные данные обрабатывались корректно.

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

• Compatible - совместимые референсы, которые можно использовать вместе. Например, к выбранной розетке предлагаются подходящие рамки, подрозетники и т.д.
• Cross selling - перекрестные референсы из других серий и ценовых сегментов (как правило, выше), подходящие по параметрам запрошенного.
• Up selling - предложение аксессуаров, дополнительного оборудования к запрашиваемому референсу.

Без использования дополнительных параметров в запросе метод возвращает список всех референсов со всеми типами связей. По умолчанию pageSize=100 (отображается 100 референсов на странице).

Пример запроса:

https://api.systeme.ru/new-api/XML/getrefrelationship?accessCode={YourApiToken}

Пример выдачи:

<content>
    <result>success</result>
    <data>
        <reference>
            <commercialRef>16753</commercialRef>
            <description>ДИФФ.ВЫКЛ.НАГР. ID 4П 40A 300mA B-ТИП</description>
            <relationship>
                <relationship>
                    <relationship-type>compatible</relationship-type>
                    <relationship-description>Товары этой же серии</relationship-description>
                    <reference>16940</reference>
                    <description>АКСЕССУАР OFSP ДЛЯ RCCB</description>
                    <ranking>1</ranking>
                </relationship>
                <relationship>
                    <relationship-type>compatible</relationship-type>
                    <relationship-description>Товары этой же серии</relationship-description>
                    <reference>16939</reference>
                    <description/>
                    <ranking>2</ranking>
                </relationship>
                <relationship>
                    <relationship-type>compatible</relationship-type>
                    <relationship-description>Товары этой же серии</relationship-description>
                    <reference>27062</reference>
                    <description>Фальш-модуль на DIN рейку 9мм</description>
                    <ranking>3</ranking>
                </relationship>
                <relationship>
                    <relationship-type>compatible</relationship-type>
                    <relationship-description>Товары этой же серии</relationship-description>
                    <reference>26970</reference>
                    <description/>
                    <ranking>4</ranking>
                </relationship>
            </relationship>
        </reference>
    </data>
</content>

В выдаче связанные референсы сгруппированы по типам связи. При том, внутри связи порядок отображения связанного референса означает его наибольшую совместимость по убыванию от самого первого (более совместимо или что нужно допредложить в первую очередь).

Параметр Ranking - порядковый номер связанного референса в выдаче.

Фильтрация по типам связи

Фильтровать выдачу по типам связи возможно с использованием параметра relationshipType, например, если нужно загрузить только совместимые связанные референсы (тип связи compatible).

Пример запроса:

https://api.systeme.ru/new-api/XML/getrefrelationship?accessCode={YourApiToken}&relationshipType=up-selling

Пример выдачи:

<content>
    <result>success</result>
    <data>
        <reference>
            <commercialRef>16753</commercialRef>
            <description>ДИФФ.ВЫКЛ.НАГР. ID 4П 40A 300mA B-ТИП</description>
            <relationship>
                <relationship>
                    <relationship-type>compatible</relationship-type>
                    <relationship-description>Товары этой же серии</relationship-description>
                    <reference>16940</reference>
                    <description>АКСЕССУАР OFSP ДЛЯ RCCB</description>
                    <ranking>1</ranking>
                </relationship>
                <relationship>
                    <relationship-type>compatible</relationship-type>
                    <relationship-description>Товары этой же серии</relationship-description>
                    <reference>26970</reference>
                    <description/>
                    <ranking>2</ranking>
                </relationship>
                <relationship>
                    <relationship-type>compatible</relationship-type>
                    <relationship-description>Товары этой же серии</relationship-description>
                    <reference>27062</reference>
                    <description>Фальш-модуль на DIN рейку 9мм</description>
                    <ranking>3</ranking>
                </relationship>
                <relationship>
                    <relationship-type>compatible</relationship-type>
                    <relationship-description>Товары этой же серии</relationship-description>
                    <reference>16939</reference>
                    <description/>
                    <ranking>4</ranking>
                </relationship>
            </relationship>
        </reference>
    </data>
</content>

Поддерживаемые параметры для фильтрации:

• compatible - совместимые референсы
• cross-selling - перекрестные референсы
• up-selling - аксессуары, доппродажи

Параметры можно группировать знаком амперсанда &, например &relationshipType[]=up-selling&relationshipType[]=compatible. Группировка возможна для общего списка связанных референсов и по каждому референсу отдельно.

Описание параметров запроса

&page={N} - пагинация, осуществляет переход к указанной странице, где N - ее номер. Общее количество страниц в выдаче системой не определяется (нецелесообразно), поэтому осуществлять перебор данных постранично нужно до тех пор, пока ответ не перестанет возвращать продуктовые данные (выдача станет пустой).

Пример запроса:
https://api.systeme.ru/new-api/XML/getrefrelationship?accessCode={YourApiToken}&page=2

&pageSize={N} – задает количество записей в выдаче, где N - числовое значение. По умолчанию большинство методов содержит лимит в 50 записей на страницу. Максимальное значение лимита 50.

Пример запроса:
https://api.systeme.ru/new-api/XML/getrefrelationship?accessCode={YourApiToken}&pageSize=50

&commercialRef={N} – запрос данных по конкретному референсу или списку референсов, где N - точное обозначение референса, например GSL000434. Если в качестве значения задается список референсов, то они должны перечисляться через запятую без пробелов: GSL000434,16765,18636. Максимальное значение лимита 50.

Примеры запросов:
https://api.systeme.ru/new-api/XML/getrefrelationship?accessCode={YourApiToken}&commercialRef=GSL000434
https://api.systeme.ru/new-api/XML/getrefrelationship?accessCode={YourApiToken}&commercialRef=GSL000434,16765,18636

&brand - бренд товара.

Поддерживается сортировка товара по бренду, для этого используйте: https://api.systeme.ru/new-api/XML/getrefrelationship?accessCode={YourApiToken}&brand={ID-бренда}

Чтобы получить список брендов с их идентификаторами (ID) используйте метод API getbrands https://api.systeme.ru/new-api/XML/getbrands?accessCode={YourApiToken}