Cmdlets for HubSpot

Build 25.0.9434

Orders

Lists all orders in HubSpot, with support for OAuth and private-app token authentication.

Table Specific Information

In HubSpot, order records store information about ecommerce purchases.

SELECT

When selecting orders, they can be filtered by columns marked below as 'Filterable'. For those columns, the supported server-side operators are: =, !=, <, <=, >, >=, IN

Further filtering is available using AND and OR combinations. A maximum of 3 OR operators are supported server-side, with each of these operators supporting up to 3 AND operators inside of them. For example: 

SELECT * FROM Orders;
SELECT * FROM Orders WHERE [Id] = '385815394826';
SELECT * FROM Orders WHERE [Discount] = 10 OR [Exchange rate] = 1.5;

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 Orders WHERE {Column} = {Value} AND {Column} < {Value} AND {Column} > {Value}
SELECT * FROM Orders WHERE {Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value}
SELECT * FROM Orders WHERE ({Column} = {Value} AND {Column} = {Value}) OR ({Column} != {Value} AND {Column} >= {Value})
SELECT * FROM Orders 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 Orders ([Currency Code]) VALUES ('INR')
INSERT INTO Orders ([Currency Code], [Exchange rate], [Created Date]) VALUES ('USD', 1.6, '2024-12-14 18:30:00.000'), ('ALL', 160.3, '2024-11-14 18:30:00.000')

UPDATE


UPDATE Orders SET [Exchange rate] = '2.5' WHERE ID = '3917882265'

DELETE


DELETE FROM Orders WHERE ID = '3917882265'

Columns

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

Unique identifier assigned to the order record in HubSpot.

Archived Bool True False

Indicates whether the order is archived and no longer active.

CreatedAt Datetime True False

Timestamp marking when the order was first created in the system.

UpdatedAt Datetime True False

Timestamp marking when the order was most recently updated.

All teams String True True

List of team IDs, including inherited teams, associated with ownership properties for this order.

Business units String False True

Business units to which this order record is assigned.

All owner ids String True True

All user IDs assigned as owners of the order, including default and custom ownership fields.

All team ids String True True

List of team IDs directly associated with owner properties on the order.

Billing City String False True

City specified in the billing address of the order.

Billing Country String False True

Country specified in the billing address of the order.

Billing Email String False True

Email address provided by the customer in the billing information.

Billing First Name String False True

Customer's first name from the billing address.

Billing Last Name String False True

Customer's last name from the billing address.

Billing Phone Number String False True

Phone number provided for the billing address.

Billing ZIP/Postal Code String False True

ZIP or postal code provided in the billing address.

Billing State String False True

State or province listed in the billing address.

Billing Street String False True

Street address entered for billing purposes.

Buyer Accepts Marketing Bool False True

Indicates whether the customer has opted in to receive marketing emails.

Cancellation Reason String False True

Reason provided for canceling the order, if available.

Closed Date Datetime True True

Date and time when the order was marked as closed. Automatically populated if applicable.

Created by user ID Decimal True True

HubSpot user ID of the individual who created the order. Automatically managed by the system.

Object create date/time Datetime True True

Date and time when the order object was created. Automatically populated by HubSpot.

Currency Code String False True

Three-letter currency code used for the order, such as USD or EUR.

Customer Phone String False True

Phone number provided by the customer placing the order.

Date entered Stage 1 (Pipeline 1) Datetime True True

Timestamp when the order entered the 'Stage 1' stage in 'Pipeline 1'.

Date exited Stage 1 (Pipeline 1) Datetime True True

Timestamp when the order exited the 'Stage 1' stage in 'Pipeline 1'.

Discount Codes String False True

List of discount codes applied to the order, if any.

Exchange rate Decimal False True

Exchange rate used to convert the order amount into the company's home currency.

Canceled Date Datetime False True

Date and time when the order was officially canceled.

Cart ID String False True

Identifier for the cart associated with the order in an external commerce platform.

Checkout ID String False True

Identifier for the checkout session associated with the order in an external system.

Created Date Datetime False True

Original date when the order was created. May differ from when it was imported into HubSpot.

Modified Date Datetime False True

Most recent date and time when the order record was modified in the source system.

Order ID String False True

Identifier for the order in an external system such as Shopify or WooCommerce.

Status String False True

Current status of the order, such as pending, fulfilled, or canceled.

Order URL String False True

URL linking to the order's detail page in the external commerce platform.

Fulfillment Status String False True

Current fulfillment status of the order, such as fulfilled, partially fulfilled, or unfulfilled.

Amount in company currency Decimal False True

Total order amount converted to your company's currency using the specified exchange rate.

Landing Site String False True

URL of the first page the customer landed on before placing the order.

Object last modified date/time Datetime True True

Most recent timestamp of any update to the order, including internal property changes.

Merged record IDs String True True

List of record IDs that have been merged into this order. Automatically generated by HubSpot.

Record ID Decimal True True

HubSpot-assigned unique identifier for this order record.

Record Creation Source String True True

Internal source indicator of how the record was originally created, such as API, import, or form submission.

Record Source Detail 1 String True True

First-level detail about the origin of this order record, such as form name or integration name.

Record Source Detail 2 String True True

Second-level detail about how the order record was created.

Record Source Detail 3 String True True

Third-level detail about how the order record was created.

Record Creation Source ID String True True

Internal ID referencing the system or tool that created this order record.

Record Source String True True

Description of the method or system that created the order record.

Record Creation Source User ID Decimal True True

User ID associated with the creation of this record if created manually or via user-authored import.

Discount Decimal False True

Total discount applied to the order as a monetary value.

Name String False True

Unique order number used as the primary display name of the order.

Notes String False True

Freeform text field for internal notes or comments related to the order.

Payment Processing Method String False True

Type of payment method used for processing the order, such as credit card or PayPal.

Payment Status String False True

Current payment status of the order, such as paid, pending, or refunded.

Pinned engagement ID Decimal False True

ID of the engagement (such as a note or email) currently pinned to the order.

Pipeline String False True

Name of the order pipeline that contains this order.

Stage String False True

Stage within the pipeline that the order currently resides in.

Processed Date Datetime False True

Date and time when the order was processed and imported into HubSpot.

Read Only Object Bool True True

Indicates whether the order is read-only and cannot be edited.

Referring Site String False True

URL of the website that referred the customer to the seller's site before placing the order.

Refund Amount Decimal False True

Total amount refunded to the customer, if applicable.

Shared Team IDs String True True

List of team IDs that have shared access to the order record.

Shared User IDs String True True

List of user IDs that have shared access to the order record.

Shipping City String False True

City entered in the shipping address of the order.

Shipping Country String False True

Country listed in the shipping address.

Shipping Phone Number String False True

Phone number entered in the shipping address.

Shipping ZIP/Postal Code String False True

ZIP or postal code used in the shipping address.

Shipping State String False True

State or region specified in the shipping address.

Shipping Street String False True

Street address for shipping the order.

Shipping Cost Decimal False True

Base cost of shipping, in the currency associated with the order, excluding discounts.

Shipping Status URL String False True

URL where the shipping or delivery status of the order can be tracked.

Shipping Tracking Number String False True

Tracking number(s) associated with the shipment of the order.

Source ID Decimal True True

HubSpot developer app ID or source system ID where the order originated.

Source Store String False True

Identifier for the storefront or ecommerce system where the order was placed.

Subtotal Price Decimal False True

Total amount of the order before discounts, taxes, shipping, or duties.

Tags String False True

List of tag values applied to this order for segmentation or categorization.

Tax Price Decimal False True

Total tax amount applied to the order, including applicable duties.

Time in Stage 1 (Pipeline 1) Decimal True True

Total time in seconds that the order remained in the 'Stage 1' stage of 'Pipeline 1'.

Total Price Decimal False True

Grand total for the order, including product cost, tax, shipping, and adjustments.

Total Weight String False True

Combined shipping weight of all items in the order.

Unique creation key String True True

Unique key used to prevent duplicate order creation during automated or batch processes.

Updated by user ID Decimal True True

User ID of the individual who last modified this order. Automatically set by HubSpot.

User IDs of all notification followers String True True

List of user IDs who opted in to receive notifications about changes to this order.

User IDs of all notification unfollowers String True True

List of owner user IDs who opted out of receiving notifications for this order.

User IDs of all owners String True True

List of all users assigned as owners of this order record.

Performed in an import Bool True True

Indicates whether the order was created as part of a bulk import.

Owner Assigned Date Datetime True True

Timestamp of the most recent owner assignment on the order. Automatically tracked by HubSpot.

Owner String False True

Current owner of the order as recorded in HubSpot.

HubSpot Team String True True

Primary HubSpot team associated with the order owner.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434