getICollections

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

Описание

Возвращает Promise, который разрешается в объект ICollectionEntity.

IntegrationCollections.getICollections(

langCode, userQuery

);

Схема параметров

Схема

langCode: string
Код языка. По умолчанию: "en_US"
пример: "en_US"

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

{
  "limit": 0,
  "offset": 30,
  "entityType": "orders",
  "entityId": 1
}

Примеры

Минимальный пример

const result = await IntegrationCollections.getICollections();

Пример с атрибутами

const userQuery = '';
const result = await IntegrationCollections.getICollections('en_US', userQuery);

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

[
  {
    "id": 1,
    "identifier": "test_collection",
    "formId": 2,
    "localizeInfos": {
      "title": "test_collection"
    },
    "attributeSetId": null,
    "selectedAttributeMarkers": null
  }
]

Схема ответа

Схема: ICollectionEntity[]

id: number
Идентификатор объекта.
пример: 1

identifier: string | null
Текстовый идентификатор для поля записи.
пример: "collection1"

formId: number | null
Идентификатор формы, используемой хранилищем заказов.
пример: 1234

localizeInfos: ILocalizeInfo
Локализованная информация о коллекции.
пример:

{
  "title": "Текст администраторов"
}

attributeSetId: string | null
Идентификатор набора атрибутов, используемых формой, прикрепленной к коллекции.
пример: "attributeSet1" или null, если не применимо

selectedAttributeMarkers: string | null
Текстовые идентификаторы атрибутов объекта формы для отображения в таблице данных.
пример: "collection_marker"

---