商品項目

概要エンドポイント

HubSpotにおいて商品項目は、製品の個々のインスタンスです。製品は取引に紐付けられると、商品項目になります。個別の見積もり上に作成した商品項目は製品ライブラリーには追加されません。商品項目エンドポイントを使用することにより、商品項目データを管理したり、HubSpotと他のシステムとの間で同期したりできます。

使用例：営業担当者から潜在顧客に送信するための見積もり一式を作成する際に、商品項目APIを使用して、見積もりごとにスタンドアロンの商品項目ならびに既存の製品に関連付けられた商品項目を作成できます。

商品項目を作成する

商品項目を作成するには、POSTリクエストを/crm/v3/objects/line_itemに送信します。POSTリクエスト本文に、商品項目の詳細（名前、数量、価格など）を含めます。

既存の製品（製品APIを使用して作成された、またはHubSpot内で作成された）に基づく商品項目を作成するには、POSTリクエスト本文にhs_product_idを含めます。 

また、POSTリクエスト本文にassociations配列を含めることで、商品項目を取引と見積もりに関連付けることも可能です。例えば、以下のような本文でPOSTリクエストを送信すると、取引（ID：12345）と見積もり（ID：67890）が関連付けられた「New standalone line item」という名前の商品項目が作成されます。

// 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 } ] } ] }

注：

  • propertiesフィールド内で指定されたpriceを負の値にすることはできません。
  • 商品項目［期間］プロパティー（hs_recurring_billing_period）では、期間表記の形式ISO-8601のPnYnMnDおよびPnWを使用できます。

商品項目を取得する

商品項目を個別に、または一括で取得できます。

  • 特定の商品項目を取得するには、GETリクエストを/crm/v3/objects/line_items/{lineItemId}に送信します。lineItemIdは商品項目のIDを指します。
  • 全ての商品項目を取得するには、GETリクエストを/crm/v3/objects/line_itemsに送信します。 
リクエストのURLには、次のパラメーターを含められます。
Use this table to describe parameters / fields
ParameterDescription
properties

レスポンスで取得するプロパティーのカンマ区切りのリスト。指定したプロパティーのいずれかがリクエスト対象のオブジェクトに存在しない場合、これらのプロパティーは無視されます。

propertiesWithHistory

以前の値の履歴と併せて取得するプロパティーのカンマ区切りのリスト。指定したプロパティーのいずれかがリクエスト対象のオブジェクトに存在しない場合、これらのプロパティーは無視されます。

商品項目を更新する

商品項目を更新するには、PATCHリクエストを/crm/v3/objects/line_items/{lineItemId}に送信します。lineItemIdは商品項目のIDを指します。

リクエスト本文に、更新するプロパティー値を含めます。このメソッドを使用して関連付けを更新することはできません。代わりに、関連付けAPIを使用する必要があります。

例えば、リクエスト本文は次のようになります。

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

商品項目を削除する

商品項目を削除するには、DELETEリクエストを/crm/v3/objects/line_items/{lineItemId}に送信します。lineItemIdは商品項目のIDを指します。

参考になりましたか？
こちらのフォームではドキュメントに関するご意見をご提供ください。HubSpotがご提供しているヘルプはこちらでご確認ください。