Vue d’ensemble de l’entité CustomProductDocument

L’entité CustomProductDocument possède plusieurs attributs utiles, notamment :

  • id : L’identifiant unique du document, généré automatiquement avec le préfixe cpdoc_
  • name : Le nom du document.
  • url : L’URL du document.
  • product_id : L’identifiant du produit associé à ce document.
  • bridge_metadata : Un objet JSON permettant de stocker des métadonnées spécifiques au bridge.
  • created_at : La date et l’heure de création de l’enregistrement.
  • updated_at : La date et l’heure de la dernière mise à jour de l’enregistrement.

Relations

L’entité CustomProductDocument a une relation importante :

  • product : Une relation many-to-one vers l’entité Product, représentant le produit auquel ce document est associé.

Playground

Essayer l'API

Découvrez comment utiliser l’API pour intéragir avec les documents.


Exemple de modèle JSON

Voici un exemple complet de ce à quoi pourrait ressembler une instance de CustomProductDocument en JSON :

{
  "id": "cpdoc_01H1G5V27GYX4QXFXYD9G63300",
  "name": "Manuel d'utilisation",
  "url": "https://example.com/documents/user-manual.pdf",
  "product_id": "prod_01H1G5V27GYX4QXFXYD9G63301",
  "created_at": "2023-07-15T10:30:00.000Z",
  "updated_at": "2023-07-15T14:45:00.000Z",
  "product": {
    "id": "prod_01H1G5V27GYX4QXFXYD9G63301",
    "title": "Sneakers Pro",
    "handle": "sneakers-pro",
    "status": "published"
  }
}

Dans cet exemple, nous voyons un document “Manuel d’utilisation” associé à un produit spécifique. Le produit associé est inclus dans la réponse lorsque la relation est explicitement chargée lors de la requête.

L’entité CustomProductDocument est directement liée à un produit spécifique via le champ product_id. Cela permet une association rapide et efficace entre les documents et les produits.