getICollections

Getting all collections

IntegrationCollections.getICollections(langCode, userQuery)

const result = await IntegrationCollections.getICollections();

Schema

langCode: string
Language code
example: en_US

userQuery: object
Optional set query parameters

userQuery.limit: number
Optional parameter for pagination, default is 0
example: 0

userQuery.offset: number
Optional parameter for pagination, default is 30
example: 30

Get all collections.

Example return:

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

Schema

id: number
object identifier
example: 1764

localizeInfos: CommonLocalizeInfos
Name considering localization
example:

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

identifier: string
Text identifier for record field
example: 1
default: marker

formId: number
Identifier for the form used by the order storage
default:

attributeSetId: string
Identifier of the set of attributes used by the form attached to the collection
example: 1
default:

selectedAttributeMarkers: string
Text identifiers of form object attributes for display in the data table
example: marker1, marker2
default: