getICollectionRowsById

Get all records belonging to the collection by collection id.

Description

It returns a Promise that resolves to an ICollectionRowsResponce object.

IntegrationCollections.getICollectionRowsById(

id*, langCode, userQuery

);

Parameters schema

Schema

id(required): number
Collection id
example: 1

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

userQuery: any
Optional set query parameters
example:

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

Examples

Minimal example

const result = await IntegrationCollections.getICollectionRowsById(1);

Example with attributes

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

Example response

{
  "items": [
    {
      "id": 1,
      "entityId": null,
      "entityType": null,
      "createdDate": "2025-02-25T07:05:52.627Z",
      "updatedDate": "2025-02-25T07:05:52.627Z",
      "formData": [
        {
          "marker": "naimenovanie_1",
          "type": "string",
          "value": "Наименование"
        }
      ],
      "attributeSetIdentifier": null
    },
    {
      "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
    },
    {
      "id": 3,
      "entityId": null,
      "entityType": null,
      "createdDate": "2025-02-25T07:05:54.003Z",
      "updatedDate": "2025-02-25T07:05:54.460Z",
      "formData": [
        {
          "marker": "naimenovanie_1",
          "type": "string",
          "value": "Наименование 2"
        }
      ],
      "attributeSetIdentifier": null
    },
    "..."
  ],
  "total": 214
}

Response schema

Schema: ICollectionRowsResponce

items: ICollectionRow[]
Array of collection row objects.
example:

[
  {
    "id": 1,
    "createdDate": "2025-06-06T19:08:54.616Z",
    "updatedDate": "2025-06-06T19:08:54.616Z",
    "entityId": null,
    "entityType": null,
    "formData": [
      {
        "marker": "name_1",
        "type": "string",
        "value": "Value"
      }
    ],
    "attributeSetIdentifier": null
  }
]

items.id: number
Object identifier.
example: 1

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

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

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

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

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

formData.marker: string
Text identifier (marker) of the form field.
example: "collection_marker"

formData.type: string
Type of the form field, such as "text", "number", "date", "etc".
example: "number"

formData.value: string
Value of the form field, which can be a "string", "number", "date", "etc".
example: "Collection marker"

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

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

items.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

items.total: string
Total count.
example: "1"

total: number
Total number of found records.
example: 10

---