Cmdlets for HubSpot

Build 24.0.9032

Products

Retrieve the available Products in HubSpot. This table supports both OAuth and PrivateAppToken authentication.

Table Specific Information

In HubSpot, products represent the goods or services you sell. Building a product library allows you to quickly add products to deals, generate quotes, and report on product performance.

SELECT

When selecting products, they can be filtered by columns marked below as 'Filterable'. For those columns, the supported server-side operators are =, !=, <, <=, >, >=. Further filtering is available using AND and OR combinations. A maximum of 2 OR operators are supported server-side, with each of these operators supporting up to 2 AND operators inside of them. For example:

SELECT * FROM Products WHERE [Created by user ID] = 4465089 AND [Product price] > 250
SELECT * FROM Products WHERE [Created by user ID] = 4465089 OR [Created by user ID] = 4465090

In the below server-offloading examples, "{Column}" represents any column you'd like to filter and "{Value}" represents any value you want to filter it on:

SELECT * FROM Products WHERE {Column} = {Value} AND {Column} < {Value} AND {Column} > {Value}
SELECT * FROM Products WHERE {Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value}
SELECT * FROM Products WHERE ({Column} = {Value} AND {Column} = {Value}) OR ({Column} != {Value} AND {Column} >= {Value})
SELECT * FROM Products WHERE ({Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value}) OR ({Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value}) OR ({Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value})

INSERT


INSERT INTO Products ([Product description]) VALUES ('description')

UPDATE


UPDATE Products SET [Product description] = 'new description' WHERE ID = '75229453'

DELETE


DELETE FROM Products WHERE ID = '75229453'

Columns

Name Type ReadOnly References Filterable Description
Id [KEY] Long False True

Unique identifier of the object.

Archived Bool True False

Whether the object is archived or not.

CreatedAt Datetime True False

When the object was created.

UpdatedAt Datetime True False

When the object was last updated.

Net price Decimal True True

Internal placeholder _to prevent conflicts with line item property of same name_.

Create Date Datetime False True

The date the product was created.

Product description String False True

Full description of product.

Unit discount Decimal False True

The discount amount applied.

All accessible team IDs String True True

The team IDs_ including up the team hierarchy_ corresponding to all owner referencing properties for this object_ both default and custom.

Business units String False True

The business units this record is assigned to.

All owner ids String True True

The value of all owner referencing properties for this object_ both default and custom.

All team ids String True True

The team ids corresponding to all owner referencing properties for this object_ both default and custom.

Avatar FileManager key String True True

The path in the FileManager CDN for this product's image. Automatically set by HubSpot.

Unit cost Decimal False True

The amount that sold goods cost the HubSpot customer.

Created by user ID Decimal True True

The user that created this object. This value is automatically set by HubSpot and may not be modified.

Object create date_time Datetime True True

The date and time at which this object was created. This value is automatically set by HubSpot and may not be modified.

Discount Percentage Decimal False True

The discount percentage applied.

Folder Id Decimal False True

The ID of the folder that has this product.

Image Url String False True

Product images.

Last Modified Date Datetime True True

The date any property on this product was modified.

Merged object IDs String True True

The list of object IDs that have been merged into this object. This value is automatically set by HubSpot and may not be modified.

Record ID Decimal True True

The unique ID for this record. This value is automatically set by HubSpot and may not be modified.

Product Type String False True

The type of product. By default_ categorize your product as either Inventory_ Non_Inventory or Service.

Read Only Object Bool True True

Is the object read only.

Term String False True

Product recurring billing duration.

Start Date Date False True

Recurring billing start date for a line item.

SKU String False True

Unique product identifier.

Unique creation key String True True

Unique property used for idempotent creates.

Updated by user ID Decimal True True

The user that last updated this object. This value is automatically set by HubSpot and may not be modified.

URL String False True

Product url.

User IDs of all notification followers String True True

The user IDs of all users that have clicked follow within the object to opt_in to getting follow notifications.

User IDs of all notification unfollowers String True True

The user IDs of all object owners that have clicked unfollow within the object to opt_out of getting follow notifications.

User IDs of all owners String True True

The user IDs of all owners of this object.

Owner Assigned Date Datetime True True

The most recent date an owner was assigned to this object. This is set automatically by HubSpot and can be used for segmentation and reporting.

Owner String False True

The owner of the object.

HubSpot Team String True True

The primary team of the owner.

Name String False True

Product name.

Unit price Decimal False True

Cost of product.

Quantity Decimal True True

Internal placeholder _to prevent conflicts with line item property of same name_.

Recurring billing frequency String False True

How often a product with recurring billing is billed. It informs the pricing calculation for deals and quotes. Products with one_time billing aren_t included.

Tax Decimal False True

The tax amount applied.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9032