Lignes de produit

Vue d'ensemblePoints de terminaison

Dans HubSpot, les lignes de produit sont des instances individuelles de produits. Lorsqu'un produit est associé à une transaction, il devient une ligne de produit. Vous pouvez créer des lignes de produit propres à un devis, qui ne seront pas ajoutées à votre bibliothèque de produits. Les points de terminaison des lignes de produit vous permettent de gérer ces données et de les synchroniser entre HubSpot et d'autres systèmes.

Exemple de cas d'utilisation : lors de la création d'un ensemble de devis que les représentants commerciaux enverront à de potentiels acheteurs, vous pouvez utiliser cette API pour créer des lignes de produit autonomes pour chaque devis ainsi que des lignes de produit associées à des produits existants.

Créer une ligne de produit

Pour créer un ligne de produit, effectuez une demande POST à /crm/v3/objects/line_items. Dans le corps de l'article, incluez les détails de la ligne de produit, tels que le nom, la quantité et le prix. Pour créer une ligne de produit basée sur un produit existant (créé via l'API de produits ou dans HubSpot), incluez hs_product_id dans le corps de l'article. 

Vous pouvez également associer la ligne de produit avec des transactions et des devis en incluant un tableau associations dans le corps de l'article. Par exemple, le corps d'article ci-dessous créerait une ligne de produit intitulée « Nouvelle ligne de produit autonome » associée à une transaction (ID : 12345) et à un devis (ID : 67890).

// POST request to https://api.hubapi.com/crm/v3/objects/line_item { "properties": { "price": 10, "quantity": 1, "name": "New standalone line item" }, "associations": [ { "to": { "id": 12345 }, "types": [ { "associationCategory": "HUBSPOT_DEFINED", "associationTypeId": 20 } ] }, { "to": { "id": 67890 }, "types": [ { "associationCategory": "HUBSPOT_DEFINED", "associationTypeId": 68 } ] } ] }

Please note: the line items Term property (hs_recurring_billing_period) accepts ISO-8601 period formats of PnYnMnD and PnW.

Récupérer une ligne de produit

Vous pouvez récupérer des lignes de produit de façon individuelle ou en masse.

  • Pour récupérer une ligne de produit spécifique, effectuez une demande GET à /crm/v3/objects/line_items/{lineItemId} où lineItemId est l'ID de la ligne de produit.
  • Pour récupérer toutes les lignes de produit, effectuez une demande GET à /crm/v3/objects/line_items. 
Vous pouvez inclure les paramètres suivants dans l'URL de la requête :
Use this table to describe parameters / fields
ParameterDescription
properties

Une liste séparée par des virgules des propriétés à renvoyer dans la réponse. Si l'une des propriétés spécifiées n'est pas présente sur le(s) objet(s) demandé(s), elle sera ignorée.

propertiesWithHistory

Une liste séparée par des virgules des propriétés à renvoyer avec un historique de leurs précédentes valeurs. Si l'une des propriétés spécifiées n'est pas présente sur le(s) objet(s) demandé(s), elle sera ignorée.

Mettre à jour une ligne de produit

Pour mettre à jour une ligne de produit spécifique, effectuez une demande PATCH à /crm/v3/objects/line_items/{lineItemId} où lineItemId est l'ID de la ligne de produit.

Dans le corps d'article, incluez les valeurs de propriété que vous souhaitez mettre à jour. Vous ne pouvez pas mettre à jour des associations via cette méthode. Vous devrez plutôt utiliser l'API des associations.

Par exemple, votre corps de requête peut ressembler aux éléments suivants :

// PATCH request to https://api.hubapi.com/crm/v3/objects/line_item/{lineItemId} { "properties": { "price": 25, "quantity": 3, "name": "Updated line item" }

Supprimer une ligne de produit

Pour supprimer une ligne de produit spécifique, effectuez une demande DELETE à /crm/v3/objects/line_items/{lineItemId} où lineItemId est l'ID de la ligne de produit.

Cet article vous a-t-il été utile ?
Ce formulaire est destiné à recueillir les avis sur la documentation pour les développeurs. Si vous souhaitez faire part de votre avis sur les produits HubSpot, veuillez le partager sur le forum des idéesde la communauté.