Products: HubSpot Products |
ListRead a page of products. Control what is returned via the `properties` query param.
Catalog: Products3
Schema: Basic
Label: Products
Retrieve: true
Insert: true
Update: false
Delete: false
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function Products. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.
Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.
Name |
Data Type |
Required |
Default Value |
Documentation |
---|---|---|---|---|
after |
string |
☐ |
|
The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results. |
archived |
boolean |
☐ |
|
Whether to return only results that have been archived. |
Columns of Table Function
The columns of the table function Products are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert.
Name |
Data Type |
Label |
Required |
Documentation |
---|---|---|---|---|
archived |
boolean |
Archived |
☐ |
|
archivedAt |
datetime |
Archived at |
☐ |
|
associations |
string |
Associations |
☐ |
|
createdAt |
datetime |
Created at |
☐ |
|
id |
string |
ID |
☐ |
|
prop_amount |
decimal |
Amount |
☐ |
|
prop_createdate |
datetime |
Created at |
☐ |
|
prop_description |
string |
Description |
☐ |
|
prop_discount |
decimal |
Discount |
☐ |
|
prop_hs_all_accessible_team_ids |
string |
All Accessible Team IDs |
☐ |
|
prop_hs_all_assigned_business_unit_ids |
string |
All Assigned Business Unit IDs |
☐ |
|
prop_hs_all_owner_ids |
string |
All Owner IDs |
☐ |
|
prop_hs_all_team_ids |
string |
All Team IDs |
☐ |
|
prop_hs_avatar_filemanager_key |
string |
Avatar Filemanager Key |
☐ |
|
prop_hs_cost_of_goods_sold |
decimal |
Cost of Goods Sold |
☐ |
|
prop_hs_created_by_user_id |
decimal |
Created by User ID |
☐ |
|
prop_hs_createdate |
datetime |
Created at |
☐ |
|
prop_hs_discount_percentage |
decimal |
Discount Percentage |
☐ |
|
prop_hs_folder_id |
decimal |
Folder ID |
☐ |
|
prop_hs_images |
string |
Images |
☐ |
|
prop_hs_lastmodifieddate |
datetime |
Last Modified Date |
☐ |
|
prop_hs_merged_object_ids |
string |
Merged Object IDs |
☐ |
|
prop_hs_object_id |
decimal |
Object ID |
☐ |
|
prop_hs_object_source_detail_1 |
string |
{res:itgen_hubspot_prop_hs_object_source_detail_1} |
☐ |
|
prop_hs_object_source_detail_2 |
string |
{res:itgen_hubspot_prop_hs_object_source_detail_2} |
☐ |
|
prop_hs_object_source_detail_3 |
string |
{res:itgen_hubspot_prop_hs_object_source_detail_3} |
☐ |
|
prop_hs_object_source_id |
string |
{res:itgen_hubspot_prop_hs_object_source_id} |
☐ |
|
prop_hs_object_source_label |
string |
{res:itgen_hubspot_prop_hs_object_source_label} |
☐ |
|
prop_hs_object_source_user_id |
decimal |
{res:itgen_hubspot_prop_hs_object_source_user_id} |
☐ |
|
prop_hs_object_source |
string |
{res:itgen_hubspot_prop_hs_object_source} |
☐ |
|
prop_hs_product_type |
string |
Product Type |
☐ |
|
prop_hs_read_only |
boolean |
Read-only |
☐ |
|
prop_hs_recurring_billing_period |
string |
Recurring Billing Period |
☐ |
|
prop_hs_recurring_billing_start_date |
datetime |
Recurring Billing Start Date |
☐ |
|
prop_hs_shared_team_ids |
string |
{res:itgen_hubspot_prop_hs_shared_team_ids} |
☐ |
|
prop_hs_shared_user_ids |
string |
{res:itgen_hubspot_prop_hs_shared_user_ids} |
☐ |
|
prop_hs_sku |
string |
SKU |
☐ |
|
prop_hs_unique_creation_key |
string |
Unique Creation Key |
☐ |
|
prop_hs_updated_by_user_id |
decimal |
Updated by User ID |
☐ |
|
prop_hs_url |
string |
URL |
☐ |
|
prop_hs_user_ids_of_all_notification_followers |
string |
User IDs of All Notification Followers |
☐ |
|
prop_hs_user_ids_of_all_notification_unfollowers |
string |
User IDs of All Notification Unfollowers |
☐ |
|
prop_hs_user_ids_of_all_owners |
string |
User IDs of All Owners |
☐ |
|
prop_hs_was_imported |
boolean |
Was Imported |
☐ |
|
prop_hubspot_owner_assigneddate |
datetime |
Owner Assigned Date |
☐ |
|
prop_hubspot_owner_id |
string |
Owner ID |
☐ |
|
prop_hubspot_team_id |
string |
Team ID |
☐ |
|
prop_name |
string |
Name |
☐ |
|
prop_price |
decimal |
Price |
☐ |
|
prop_quantity |
decimal |
Quantity |
☐ |
|
prop_recurringbillingfrequency |
string |
Recurring Billing Frequency |
☐ |
|
prop_tax |
decimal |
Tax |
☐ |
|
updatedAt |
datetime |
Updated at |
☐ |
|
18-12-2024 20:09 Version 24.1.33-BETA+5180