商品項目
商品項目を作成するには、POST
リクエストを/crm/v3/objects/line_item
に送信します。POSTリクエスト本文に、商品項目の詳細(名前、数量、価格など)を含めます。既存の製品(製品APIを使用して作成された、またはHubSpot内で作成された)に基づく商品項目を作成するには、POSTリクエスト本文にhs_product_id
を含めます。
また、POSTリクエスト本文にassociations
配列を含めることで、商品項目を取引と見積もりに関連付けることも可能です。例えば、以下のような本文でPOSTリクエストを送信すると、取引(ID:12345
)と見積もり(ID:67890
)が関連付けられた「New standalone line item」という名前の商品項目が作成されます。
注:商品項目のTermプロパティー(hs_recurring_billing_period
)は、ISO-8601の期間形式であるPnYnMnDおよびPnWを受け入れます。
商品項目を個別に、または一括で取得できます。
- 特定の商品項目を取得するには、
GET
リクエストを/crm/v3/objects/line_items/{lineItemId}
に送信します。lineItemId
は商品項目のIDを指します。 - 全ての商品項目を取得するには、
GET
リクエストを/crm/v3/objects/line_items
に送信します。
Parameter | Description |
---|---|
properties
| レスポンスで取得するプロパティーのカンマ区切りのリスト。指定したプロパティーのいずれかがリクエスト対象のオブジェクトに存在しない場合、これらのプロパティーは無視されます。 |
propertiesWithHistory
| 以前の値の履歴と併せて取得するプロパティーのカンマ区切りのリスト。指定したプロパティーのいずれかがリクエスト対象のオブジェクトに存在しない場合、これらのプロパティーは無視されます。 |
商品項目を更新するには、PATCH
リクエストを/crm/v3/objects/line_items/{lineItemId}
に送信します。lineItemId
は商品項目のIDを指します。
リクエスト本文に、更新するプロパティー値を含めます。このメソッドを使用して関連付けを更新することはできません。代わりに、関連付けAPIを使用する必要があります。
例えば、リクエスト本文は次のようになります。
貴重なご意見をありがとうございました。