Skip to main content

getICollectionRowByMarkerAndId

Getting one record from the collection.

IntegrationCollections?.getICollectionRowByMarkerAndId( marker?, id?, langCode? );

Minimal example

const result = await IntegrationCollections.getICollectionRowByMarkerAndId('test_collection', 1);
Schema

marker(required): string
Collection text identifier
example: "collection1"

id(required): number
Collection record identifier
example: 1

langCode: string
Language code. Default: "en_US"
example: "en_US"

Example response

{
"id": 2,
"entityId": null,
"entityType": null,
"createdDate": "2025-02-25T07:05:53.057Z",
"updatedDate": "2025-02-25T07:05:53.057Z",
"formData": [
{
"marker": "naimenovanie_1",
"type": "string",
"value": "Наименование"
}
],
"attributeSetIdentifier": null,
"total": "1"
}
Schema

id: number
Object identifier.
example: 1

createdDate: string
Date of creation of the record.
example: "2023-01-01T00:00:00Z"

updatedDate: string
Date of last update of the record.
example: "2023-01-02T00:00:00Z"

collectionId: number | null
collectionId associated with the collection row.
example: "product", "order", "etc"

formData: ICollectionFormData[]
Array of form data objects associated with the collection row.
example:

[
{
"marker": "name_1",
"type": "string",
"value": "Value"
}
]

entityType: string | null
Type of the entity associated with the collection row.
example: "product", "order", "etc"

entityId: number | null
Identifier of the entity associated with the collection row.
example: 12345

attributeSetIdentifier: string | null
Identifier of the attribute set used by the form attached to the collection row, or null if not applicable.
example: "attributeSet1" or null

total: string
Total count.
example: "1"