Saltar al contenido principal

getICollectionRowByMarkerAndId

Obteniendo un registro de la colección.

Descripción

Devuelve una Promesa que se resuelve en un objeto ICollectionRow.

IntegrationCollections.getICollectionRowByMarkerAndId(

marker, id, langCode

);

Esquema de parámetros

Esquema

marker(requerido): string
Identificador de texto de la colección
ejemplo: "collection1"

id(requerido): number
Identificador del registro de la colección
ejemplo: 1

langCode: string
Código de idioma. Predeterminado: "en_US"
ejemplo: "en_US"

Ejemplos

Ejemplo mínimo

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

Ejemplo con atributos

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

Ejemplo de respuesta

{
"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"
}

Esquema de respuesta

Esquema: ICollectionRow

id: number
Identificador del objeto.
ejemplo: 1

createdDate: string
Fecha de creación del registro.
ejemplo: "2023-01-01T00:00:00Z"

updatedDate: string
Fecha de la última actualización del registro.
ejemplo: "2023-01-02T00:00:00Z"

collectionId: number | null
collectionId asociado con la fila de la colección.
ejemplo: "product", "order", "etc"

formData: ICollectionFormData[]
Array de objetos de datos de formulario asociados con la fila de la colección.
ejemplo:

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

entityType: string | null
Tipo de la entidad asociada con la fila de la colección.
ejemplo: "product", "order", "etc"

entityId: number | null
Identificador de la entidad asociada con la fila de la colección.
ejemplo: 12345

attributeSetIdentifier: string | null
Identificador del conjunto de atributos utilizado por el formulario adjunto a la fila de la colección, o null si no aplica.
ejemplo: "attributeSet1" o null

total: string
Conteo total.
ejemplo: "1"