Pular para o conteúdo principal

createICollectionRow

Crie um registro na coleção.

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

Exemplo mínimo

const body = {
"formIdentifier": "collection-form",?
"formData": [?
{
"marker": "name_1",?
"type": "string"?
"value": "Value"?
}
]
};

const value = await IntegrationCollections.createICollectionRow(body)
Esquema

marker(obrigatório): string
Identificador de texto da coleção
exemplo: "collection1"

body(obrigatório): ICollectionFormObject
Objeto para criar um registro
exemplo:

{
"formIdentifier": "collection-form",
"formData": {
"en_US": [
{
"marker": "collection_marker",
"type": "string",
"value": "Marcador da coleção"
}
]
}
}

formIdentifier(obrigatório): string
Identificador de texto (marcador) do formulário.
exemplo: "collection-form"

formData(obrigatório): Registro<string, ICollectionFormData>
Um objeto onde as chaves são marcadores de campos do formulário e os valores são arrays de objetos ICollectionFormData.
exemplo:

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

langCode: string
Código do idioma. Padrão: "en_US"
exemplo: "en_US"

Exemplo de resposta

{
"formData": [
{
"marker": "c_marker",
"type": "string",
"value": "Valor"
}
],
"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
}
Esquema

id: número
Identificador do objeto.
exemplo: 1

createdDate: string
Data de criação do registro.
exemplo: "2023-01-01T00:00:00Z"

updatedDate: string
Data da última atualização do registro.
exemplo: "2023-01-02T00:00:00Z"

collectionId: número | null
collectionId associado à linha da coleção.
exemplo: "produto", "pedido", "etc"

formData: ICollectionFormData[]
Array de objetos de dados do formulário associados à linha da coleção.
exemplo:

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

entityType: string | null
Tipo da entidade associada à linha da coleção.
exemplo: "produto", "pedido", "etc"

entityId: número | null
Identificador da entidade associada à linha da coleção.
exemplo: 12345

attributeSetIdentifier: string | null
Identificador do conjunto de atributos usado pelo formulário anexado à linha da coleção, ou null se não aplicável.
exemplo: "attributeSet1" ou null

total: string
Contagem total.
exemplo: "1"