Aller au contenu principal

createICollectionRow

Créer une ligne dans une collection.

Description​

Crée une ligne dans la collection avec le marker indiqué et renvoie le nouveau ICollectionRow.

.createICollectionRow(

, ,

);

Schéma des paramètres​

Schema

marker(required): string
Marqueur de la collection.
exemple : "collection1"

body(required): ICollectionFormObject
Données de la ligne : le marqueur du formulaire et les valeurs des champs.
exemple :

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

body.formIdentifier(required): string
Marqueur du formulaire.
exemple : "collection-form"

body.formData(required): ICollectionFormData[] | Record<string, ICollectionFormData[]>
Valeurs des champs : un tableau plat [{ marker, type, value }] (comme dans l'exemple), ou le même tableau enveloppé dans un code de langue — { "en_US": [...] }. La plateforme stocke les deux ; le SDK envoie la valeur telle quelle.
exemple :

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

formData.marker(required): string
Identifiant textuel (marqueur) du champ de formulaire.
exemple : "collection_marker"

formData.type(required): string
Type d'attribut du champ de formulaire, par exemple string, integer ou date.
exemple : "number"

formData.value(required): string | number | null
Valeur du champ de formulaire. Envoyez une chaîne ; à la lecture, les champs integer/float/real reviennent sous forme de number — et de null lorsque la valeur stockée n'est pas un nombre (l'API stocke "abc" dans un champ float tel quel, le SDK ne le transmet pas).
exemple : "Collection marker"

langCode: string
Code de langue. Par défaut : le langCode passé à defineOneEntry ("en_US" s'il n'y en a pas).
exemple : "en_US"

Exemples​

Exemple minimal​


const body = {
,
{
,
,
}
]
};

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

Exemple de réponse​

{
"formData": [
{
"marker": "c_marker",
"type": "string",
"value": "Value"
}
],
"collectionId": 1,
"langCode": "en_US",
"createdDate": "2026-10-27T09:15:04.121Z",
"updatedDate": "2026-10-27T09:15:04.121Z",
"entityType": null,
"entityId": null,
"id": 929
}

Schéma de réponse​

Schéma : ICollectionRow

id: number
ID de la ligne.
exemple : 1

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

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

collectionId: number | null
ID de la collection à laquelle appartient la ligne. Les endpoints de liste de lignes et de ligne par id ne le renvoient pas.
exemple : 1

formData: ICollectionFormData[]
Champs de formulaire de la ligne de collection.
exemple :

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

formData.marker: string
Identifiant textuel (marqueur) du champ de formulaire.
exemple : "collection_marker"

formData.type: string
Type d'attribut du champ de formulaire, par exemple string, integer ou date.
exemple : "number"

formData.value: string | number | null
Valeur du champ de formulaire. Envoyez une chaîne ; à la lecture, les champs integer/float/real reviennent sous forme de number — et de null lorsque la valeur stockée n'est pas un nombre (l'API stocke "abc" dans un champ float tel quel, le SDK ne le transmet pas).
exemple : "Collection marker"

entityType: string | null
Type de l'entité à laquelle la ligne de collection est liée.
exemple : "product"

entityId: number | null
ID de l'entité à laquelle la ligne de collection est liée.
exemple : 12345

attributeSetIdentifier: string | null
Marqueur de l'ensemble d'attributs utilisé par le formulaire rattaché à la ligne de collection, ou null s'il n'y en a pas.
exemple : "attributeSet1" or null

langCode: string | null
Code de langue sous lequel la ligne a été stockée.
exemple : "en_US"

formIdentifier: string | null
Marqueur du formulaire à partir duquel la ligne a été créée ; renvoyé par l'endpoint de mise à jour de ligne (la réponse de création l'omet).
exemple : "collection_form"