createICollectionRow
Crea un registro en la colección.
Descripción
Devuelve una Promesa que se resuelve en un objeto ICollectionRow.
IntegrationCollections.createICollectionRow(
marker,
body,
body.formIdentifier,
body.formData,
langCode
);
Esquema de parámetros
Esquema
marker(requerido): string
Identificador de texto de la colección
ejemplo: "collection1"
body(requerido): ICollectionFormObject
Objeto para crear un registro
ejemplo:
{
"formIdentifier": "collection-form",
"formData": {
"en_US": [
{
"marker": "collection_marker",
"type": "string",
"value": "Marcador de colección"
}
]
}
}
body.formIdentifier(requerido): string
Identificador de texto (marcador) del formulario.
ejemplo: "collection-form"
body.formData(requerido): Record<string, ICollectionFormData>
Un objeto donde las claves son los marcadores de los campos del formulario y los valores son arreglos de objetos ICollectionFormData.
ejemplo:
[
{
"marker": "name_1",
"type": "string",
"value": "Valor"
}
]
langCode: string
Código de idioma. Predeterminado: "en_US"
ejemplo: "en_US"
Ejemplos
Ejemplo mínimo
const body = {
"formIdentifier": "collection-form","formData": [
{
"marker": "name_1","type": "string""value": "Valor"}
]
}
;
const response = await IntegrationCollections.createICollectionRow(body);
Ejemplo de respuesta
{
"formData": [
{
"marker": "c_marker",
"type": "string",
"value": "Valor"
}
],
"collectionId": 1,
"langCode": "en_US",
"createdDate": "2025-09-30T20:32:44.573Z",
"updatedDate": "2025-09-30T20:32:44.573Z",
"entityType": null,
"entityId": null,
"id": 461
}
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 última actualización del registro.
ejemplo: "2023-01-02T00:00:00Z"
collectionId: number | null
collectionId asociado con la fila de la colección.
ejemplo: "producto", "pedido", "etc"
formData: ICollectionFormData[]
Array de objetos de datos del formulario asociados con la fila de la colección.
ejemplo:
[
{
"marker": "name_1",
"type": "string",
"value": "Valor"
}
]
entityType: string | null
Tipo de la entidad asociada con la fila de la colección.
ejemplo: "producto", "pedido", "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"