Specifies a comma-separated list or file path containing the names of fields to retrieve for the Orders table.

Syntax

Connect-HubSpot -OrderPropertiesFile string

Data Type

cstr

Default Value

""

Remarks

Use this property to limit the fields selected from the Orders table, especially when the number of custom properties may cause HubSpot to return an error. Selecting all fields at once can exceed the platform’s field count or payload limits.

You can set this property to either:

• A comma-separated list of field names (for example: "hs_object_id,hs_order_name,hs_order_note").
• The full file path to a text file containing the same list (for example: C:\Users\Public\Documents\customfields.txt).

The field names must match the internal (API) names used by HubSpot. This property is helpful when working in environments where you cannot modify the SQL query directly, such as dashboards, middleware, or analytics platforms.

Performance Considerations

Limiting the fields returned helps improve performance, reduce memory usage, and prevent API errors caused by excessive field counts or response size.