最終更新日: 2025年8月22日

Run in Postman

 HubSpotの製品は、販売する品物やサービスを表します。製品ライブラリーを構築すると、効率的に製品を取引に追加したり、見積もりを作成したり、製品の実績についてレポートを作成したりできます。製品エンドポイントを使用すると、製品データを管理したり、HubSpotと他のシステムとの間で同期したりできます。 製品は、会社、コンタクト、取引、チケット、商品項目、見積もりと同様にHubSpotのCRMツールのオブジェクトです。オブジェクトのプロパティー、関連付け、関係性などの詳細は、HubSpotの「CRMオブジェクトについて」のガイドをご覧ください。 使用例: 営業担当者が取引や見積もりなどに商品とサービスを簡単に追加できるように、製品APIを使用して製品カタログをHubSpotにインポートします。

​
製品を作成する

製品を作成するには、POSTリクエストをcrm/v3/objects/productsに送信します。リクエスト本文に、作成時に設定する製品プロパティーを含むpropertiesオブジェクトを含めます。後から同じエンドポイントにPATCHリクエストを送信することで、製品のプロパティーを更新できます。 利用可能な全ての製品プロパティーを表示するには、プロパティーAPIにGETリクエストを送信します。製品プロパティーを取得する場合のリクエストURLは/crm/v3/properties/productsになります。 
{
  "properties": {
    "name": "Implementation Service",
    "price": "6000.00",
    "hs_sku": "123456",
    "description": "Onboarding service for data product",
    "hs_cost_of_goods_sold": "600.00",
    "hs_recurring_billing_period": "P12M"
  }
}
hs_recurring_billing_periodの値はP#Mという形式（# は月数）であることに注意してください。

​
製品を関連付ける

製品自体を他のCRMオブジェクトに関連付けることはできません。ただし、製品の情報を取引または見積もりに関連付けるために、その製品に基づく商品項目を作成できます。商品項目は製品の個々のインスタンスであり、製品とは別のオブジェクトであるため、製品自体を更新することなく、必要に応じて取引や見積もりで商品やサービスを調整できます。 例えば、いずれか1つの製品が販売される取引をまとめるときには、まず製品から商品項目を作成し、それを取引に関連付けます。商品項目の作成と関連付けは、2つの別々の呼び出しで行うことも、1つの呼び出しで行うこともできます。両方のオプションを以下に示します。

​
注：

商品項目は、1つの単一親オブジェクトに属します。オブジェクトを関連付ける場合、商品項目はラインアイテムはオブジェクトごとに個別にする必要があります。例えば取引と見積もりを作成する場合は、取引用に1つの商品項目セットを作成し、見積もり用に別の商品項目セットを作成する必要があります。これは、オブジェクト間でCRMデータを合理化し、商品項目を変更する必要があるときに予期しないデータ損失が発生しないようにするためです。例えば、見積もりを削除すると、見積もりの商品項目も削除されます。それらの商品項目が取引に関連付けられている場合、取引の商品項目も削除されます。

​
商品項目を作成して関連付ける（複数の呼び出し）

まず、IDが1234567である製品に基づいて商品項目を作成します。利用可能な商品項目プロパティー全てのリストを取得するには、プロパティーAPIにGETリクエストを送信します。商品項目のURLはcrm/v3/properties/line_itemsとなります。既存の製品から商品項目を作成しているため、その製品から価格などのプロパティー値を継承します。 
{
  "properties": {
    "quantity": 1,
    "hs_object_id": "1234567", //the object ID of the product
    "name": "New line item (product-based)"
  }
}
レスポンスで返される商品項目IDを使用すると、関連付けAPIを使ってそれを取引に関連付けることができます。この例では、返された商品項目IDが7791176460であると仮定します。 商品項目を既存の取引（ID：14795354663）に関連付けるには、PUTリクエストを/crm/v4/objects/line_items/7791176460/associations/default/deals/14795354663に送信します。このリクエストでは、デフォルトの関連付けタイプを使用します。 200レスポンスで、以下のような情報が返されます。 
{
  "status": "COMPLETE",
  "results": [
    {
      "from": {
        "id": "14795354663"
      },
      "to": {
        "id": "7791176460"
      },
      "associationSpec": {
        "associationCategory": "HUBSPOT_DEFINED",
        "associationTypeId": 19
      }
    },
    {
      "from": {
        "id": "7791176460"
      },
      "to": {
        "id": "14795354663"
      },
      "associationSpec": {
        "associationCategory": "HUBSPOT_DEFINED",
        "associationTypeId": 20
      }
    }
  ],
  "startedAt": "2023-12-21T20:06:52.083Z",
  "completedAt": "2023-12-21T20:06:52.192Z"
}
HubSpotでは、取引レコードの商品項目カードに「商品項目」が表示されます。
取引レコードに商品項目を関連付け

​
商品項目を作成して関連付ける（単一の呼び出し）

単一の呼び出しを使用して既存の製品から商品項目を作成し、取引に関連付けるには、商品項目の作成リクエストにassociations配列を含めます。 商品項目を作成するには、POSTリクエストをcrm/v3/objects/line_itemに送信します。リクエスト本文は以下のようになります。商品項目と取引の関連付けのassociationTypeIdは20であることに注意してください。詳しくは、さまざまなタイプのCRMレコード間の関連付けタイプをご確認ください。 
{
  "properties": {
    "quantity": 1,
    "hs_object_id": "1234567", //the object ID of the product
    "name": "New line item (product-based)"
  },
  "associations": [
    {
      "to": {
        "id": "14795354663"
      },
      "types": [
        {
          "associationCategory": "HUBSPOT_DEFINED",
          "associationTypeId": 20
        }
      ]
    }
  ]
}
200レスポンスで、新しい商品項目の詳細が返されます。HubSpotでは、取引レコードの商品項目カードに「商品項目」が表示されます。
取引レコードに商品項目を関連付け