Перейти к основному контенту

getICollections

Получение всех коллекций

IntegrationCollections.getICollections(langCode, userQuery)

const result = await IntegrationCollections.getICollections();
Схема

langCode: строка
Код языка
пример: en_US

userQuery: объект
Необязательные параметры запроса

userQuery.limit: число
Необязательный параметр для пагинации, по умолчанию 0
пример: 0

userQuery.offset: число
Необязательный параметр для пагинации, по умолчанию 30
пример: 30

Получите все коллекции.

Пример возврата:

[
{
"id": 1764,
"localizeInfos": {
"en_US": {
"title": "Collection 1"
}
},
"identifier": "collection",
"formId": 1,
"attributeSetId": "1",
"selectedAttributeMarkers": "marker1, marker2"
}
]
Схема

id: число
идентификатор объекта
пример: 1764

localizeInfos: CommonLocalizeInfos
Название с учетом локализации
пример:

{
"en_US": {
"title": "Collection 1"
}
}

identifier: строка
Текстовый идентификатор для поля записи
пример: 1
по умолчанию: marker

formId: число
Идентификатор формы, используемой хранилищем заказов
по умолчанию:

attributeSetId: строка
Идентификатор набора атрибутов, используемого формой, прикрепленной к коллекции
пример: 1
по умолчанию:

selectedAttributeMarkers: строка
Текстовые идентификаторы атрибутов объекта формы для отображения в таблице данных
пример: marker1, marker2
по умолчанию: