createICollectionRow

Create a record in the collection.

IntegrationCollections?.createICollectionRow( marker?, body?, langCode? );

Minimal example

const body = {
"formIdentifier": "collection-form",?
"formData": [?
{
"marker": "name_1",?
"type": "string"?
"value": "Value"?
}
]
};
const value = await IntegrationCollections.createICollectionRow(body)

Schema

marker(required): string
Collection text identifier
example: "collection1"

body(required): ICollectionFormObject
Object for creating a record
example:

{
  "formIdentifier": "collection-form",
  "formData": {
    "en_US": [
      {
        "marker": "collection_marker",
        "type": "string",
        "value": "Collection marker"
      }
    ]
  }
}

formIdentifier(required): string
Text identifier (marker) of the form.
example: "collection-form"

formData(required): Record<string, ICollectionFormData>
An object where keys are form field markers and values are arrays of ICollectionFormData objects.
example:

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

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

Example response

{
  "formData": [
    {
      "marker": "c_marker",
      "type": "string",
      "value": "Value"
    }
  ],
  "collectionId": 1,
  "langCode": "en_US",
  "createdDate": "2025-07-21T09:40:07.591Z",
  "updatedDate": "2025-07-21T09:40:07.591Z",
  "entityType": null,
  "entityId": null,
  "id": 414
}

Schema

id: number
Object identifier.
example: 1

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

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

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

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

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

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

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

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

total: string
Total count.
example: "1"

---