getICollectionRowsByMarker
Obtiene la primera página de filas de una colección por su marcador.
Descripción
Obtiene las filas de la colección con el marker indicado. Se resuelve en un ICollectionRowsResponce: las filas están en items y total contiene el número de filas de toda la colección. Este método no pasa limit ni offset, así que la API aplica su tamaño de página predeterminado y devuelve como máximo 30 filas. Para recorrer todas las filas, llama a getICollectionRowsById() con el ID numérico de la colección y limit/offset en su tercer argumento, userQuery, por ejemplo getICollectionRowsById(1, 'en_US', { limit: 30, offset: 30 }).
.getICollectionRowsByMarker(
,
);
Esquema de parámetros
Esquema
marker(requerido): string
Marcador de la colección.
ejemplo: "collection1"
langCode: cadena
Código de idioma. Predeterminado: el langCode pasado a defineOneEntry ("en_US" si no se pasó ninguno).
ejemplo: "en_US"
Ejemplos
Ejemplo mínimo
const result = await IntegrationCollections.getICollectionRowsByMarker('test_collection');
Ejemplo con langCode
const result = await IntegrationCollections.getICollectionRowsByMarker('test_collection', 'en_US');
Ejemplo de respuesta
{
"items": [
{
"id": 1,
"entityId": null,
"entityType": null,
"createdDate": "2025-02-25T07:05:52.627Z",
"updatedDate": "2026-10-27T09:01:53.242Z",
"formData": [
{
"marker": "name_1",
"type": "string",
"value": "Item name"
}
],
"attributeSetIdentifier": null
},
{
"id": 2,
"entityId": null,
"entityType": null,
"createdDate": "2025-02-25T07:05:53.057Z",
"updatedDate": "2026-10-27T09:02:08.429Z",
"formData": [
{
"marker": "name_1",
"type": "string",
"value": "Item name"
}
],
"attributeSetIdentifier": null
},
{
"id": 3,
"entityId": null,
"entityType": null,
"createdDate": "2025-02-25T07:05:54.003Z",
"updatedDate": "2026-10-27T09:02:09.104Z",
"formData": [
{
"marker": "name_1",
"type": "string",
"value": "Item name 2"
}
],
"attributeSetIdentifier": null
}
],
"total": 214
}
Esquema de respuesta
Esquema: ICollectionRowsResponce
items: ICollectionRow[]
Filas de la colección.
ejemplo:
[
{
"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: número
ID de la fila.
ejemplo: 1
items.createdDate: cadena
Fecha de creación del registro.
ejemplo: "2023-01-01T00:00:00Z"
items.updatedDate: cadena
Fecha de la última actualización del registro.
ejemplo: "2023-01-02T00:00:00Z"
items.collectionId: número | nulo
ID de la colección a la que pertenece la fila.
example: 1
items.formData: ICollectionFormData[]
Campos del formulario de la fila de la colección.
ejemplo:
[
{
"marker": "name_1",
"type": "string",
"value": "Value"
}
]
items.entityType: cadena | nulo
Tipo de la entidad a la que está vinculada la fila de la colección.
example: "product"
items.entityId: número | nulo
ID de la entidad a la que está vinculada la fila de la colección.
ejemplo: 12345
items.attributeSetIdentifier: cadena | nulo
Marcador del conjunto de atributos que usa el formulario vinculado a la fila de la colección, o null si no hay ninguno.
ejemplo: "attributeSet1" o null
items.langCode: cadena | nulo
Código de idioma bajo el cual se almacenó la fila.
ejemplo: "en_US"
items.formIdentifier: cadena | nulo
Marcador del formulario enviado en body.formIdentifier. Solo lo devuelve updateICollectionRow.
ejemplo: "collection_form"
items.total: cadena
Recuento interno que devuelve solo getICollectionRowByMarkerAndId; siempre "1". No te bases en él.
ejemplo: "1"
total: número
Número total de registros encontrados.
ejemplo: 10