Pular para o conteúdo principal

updateICollectionRow

Edite um registro na coleção.

Descrição

Retorna uma Promise que resolve para um objeto ICollectionRow.

IntegrationCollections.updateICollectionRow(

marker, id, body, langCode

);

Esquema de parâmetros

Esquema

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

id(obrigatório): number
Identificador da linha na coleção
exemplo: 12

body(obrigatório): object
Objeto para atualizar um registro na coleção
exemplo:

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

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

Exemplos

Exemplo mínimo

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

const response = await IntegrationCollections.createICollectionRow("test_collection", 12, body);

Exemplo de resposta

{
"id": 461,
"createdDate": "2025-09-30T20:32:44.573Z",
"updatedDate": "2025-09-30T20:32:44.691Z",
"collectionId": 1,
"langCode": "en_US",
"formData": [
{
"marker": "c_marker",
"type": "string",
"value": "Valor atualizado"
}
],
"entityType": null,
"entityId": null,
"formIdentifier": "collection_form"
}

Esquema de resposta

Esquema: ICollectionRow

id: number
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: number | 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: number | 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"