Skip to main content

getICollectionById

Get collection by id.

IntegrationCollections.getICollectionById(id, langCode)

const result = await IntegrationCollections.getICollectionById(1);
Schema

id:* number
Collection id
example: 10

langCode: string
Language code
example: en_US

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: collection
default: marker

formId: number
Identifier for the form used by the order storage
example: 1
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