CRM API | 商品項目

​

スコープの要件

• crm.objects.line_items.read：商品項目データを取得するためのアクセス権を提供します。
• crm.objects.line_items.write：商品項目を作成および更新するためのアクセス権を提供します。
• tax_rates.read：アカウントで設定した税率を取得するためのアクセス権を提供します。

​

商品項目を作成する

• 既存の製品（製品APIを使用して作成された、またはHubSpot内で作成された）に基づく商品項目を作成するには、POSTリクエスト本文にhs_product_idを含めます。
• 商品項目の税率を含めるには、リクエスト本文のpropertiesフィールドにIDをhs_tax_rate_group_idとして含めます。
• POSTリクエスト本文にassociations配列を含めることで、商品項目を取引、見積もり、請求書、支払いリンク、サブスクリプションに関連付けることも可能です。例えば、以下のような本文でPOSTリクエストを送信すると、取引（ID：12345）が関連付けられた「New standalone line item」という名前の商品項目が作成されます。

{
  "properties": {
    "price": 10,
    "quantity": 1,
    "name": "New standalone line item",
    "hs_tax_rate_group_id": "2148420997"
  },
  "associations": [
    {
      "to": {
        "id": 12345
      },
      "types": [
        {
          "associationCategory": "HUBSPOT_DEFINED",
          "associationTypeId": 20
        }
      ]
    }
  ]
}

​

商品項目を取得する

• 特定の商品項目を取得するには、GETリクエストを/crm/v3/objects/line_items/{lineItemId}に送信します。lineItemIdは商品項目のIDを指します。
• 全ての商品項目を取得するには、GETリクエストを/crm/v3/objects/line_itemsに送信します。

​

商品項目を更新する

{
  "properties": {
    "price": 25,
    "quantity": 3,
    "name": "Updated line item"
  }
}

​

商品項目を削除する

​

商品項目のプロパティー

​

税率を取得する

{
  "name": "MA Sales tax 2025",
  "percentageRate": 6.25
  "label": "Sales Tax",
  "active": true,
  "id": "2148420997",
  "createdAt": "2024-12-12T23:20:39.923Z",
  "updatedAt": "2024-12-12T23:20:39.923Z"
}