Aller au contenu principal

getICollectionRowByMarkerAndId

Obtenir un enregistrement de la collection.

Description​

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

IntegrationCollections.getICollectionRowByMarkerAndId(

marker, id, langCode

);

Schéma des paramètres​

Schéma

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

id(obligatoire) : number
Identifiant de l'enregistrement de la collection
exemple : 1

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

Exemples​

Exemple minimal​

const result = await IntegrationCollections.getICollectionRowByMarkerAndId('test_collection', 1);

Exemple avec des attributs​

const result = await IntegrationCollections.getICollectionRowByMarkerAndId('test_collection', 1, 'en_US');

Exemple de réponse​

{
  "id": 2,
  "entityId": null,
  "entityType": null,
  "createdDate": "2025-02-25T07:05:53.057Z",
  "updatedDate": "2025-02-25T07:05:53.057Z",
  "formData": [
    {
      "marker": "naimenovanie_1",
      "type": "string",
      "value": "Наименование"
    }
  ],
  "attributeSetIdentifier": null,
  "total": "1"
}

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 la 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": "Value"
  }
]

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"