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": [
    {
      "marker": "collection_marker",
      "type": "string",
      "value": "Collection marker"
    }
  ]
}

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": "Value"
  }
]

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": "Value"
    }
  ]
};
const response = await IntegrationCollections.createICollectionRow(body);

Ejemplo de respuesta

{
  "formData": [
    {
      "marker": "c_marker",
      "type": "string",
      "value": "Value"
    }
  ],
  "collectionId": 1,
  "langCode": "en_US",
  "createdDate": "2026-04-15T14:20:16.885Z",
  "updatedDate": "2026-04-15T14:20:16.885Z",
  "entityType": null,
  "entityId": null,
  "id": 738
}

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 del formulario asociados con la fila de la colección.
ejemplo:

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

formData.marker: string
Identificador de texto (marcador) del campo del formulario.
ejemplo: "collection_marker"

formData.type: string
Tipo del campo del formulario, como "text", "number", "date", "etc".
ejemplo: "number"

formData.value: string
Valor del campo del formulario, que puede ser un "string", "number", "date", "etc".
ejemplo: "Collection marker"

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
Total de conteo.
ejemplo: "1"

---