Aller au contenu principal

createICollectionRow

Créez un enregistrement dans la collection.

Description

Cela renvoie une promesse qui se résout en un objet ICollectionRow.

IntegrationCollections.createICollectionRow(

marker, body, body.formIdentifier, body.formData, langCode

);

Schéma des paramètres

Schéma

marker(obligatoire): string
Identifiant de texte de la collection
exemple : "collection1"

body(obligatoire): ICollectionFormObject
Objet pour créer un enregistrement
exemple :

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

body.formIdentifier(obligatoire): string
Identifiant de texte (marqueur) du formulaire.
exemple : "collection-form"

body.formData(obligatoire): Record<string, ICollectionFormData>
Un objet où les clés sont des marqueurs de champs de formulaire et les valeurs sont des tableaux d'objets ICollectionFormData.
exemple :

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

langCode: string
Code de langue. Par défaut : "en_US"
exemple : "en_US"

Exemples

Exemple minimal

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

const response = await IntegrationCollections.createICollectionRow(body);

Exemple de réponse

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

Schéma de réponse

Schéma : ICollectionRow

id: number
Identifiant de l'objet.
exemple : 1

createdDate: string
Date de création de l'enregistrement.
exemple : "2023-01-01T00:00:00Z"

updatedDate: string
Date de dernière mise à jour de l'enregistrement.
exemple : "2023-01-02T00:00:00Z"

collectionId: number | null
collectionId associé à la ligne de collection.
exemple : "produit", "commande", "etc"

formData: ICollectionFormData[]
Tableau d'objets de données de formulaire associés à la ligne de collection.
exemple :

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

entityType: string | null
Type de l'entité associée à la ligne de collection.
exemple : "produit", "commande", "etc"

entityId: number | null
Identifiant de l'entité associée à la ligne de collection.
exemple : 12345

attributeSetIdentifier: string | null
Identifiant de l'ensemble d'attributs utilisé par le formulaire attaché à la ligne de collection, ou null si non applicable.
exemple : "attributeSet1" ou null

total: string
Nombre total.
exemple : "1"