Orders
Retrieve the available Orders in HubSpot.
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. | |
All teams | 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. | |
Billing City | String | False | True |
The city for the billing address. | |
Billing Country | String | False | True |
The country for the billing address. | |
Billing Email | String | False | True |
Customer's email from billing information | |
Billing First Name | String | False | True |
Customer's first name from billing information | |
Billing Last Name | String | False | True |
Customer's last name from billing information | |
Billing Phone Number | String | False | True |
The phone number for the billing address. | |
Billing ZIP/Postal Code | String | False | True |
The ZIP/postal code for the billing address. | |
Billing State | String | False | True |
The state for the billing address. | |
Billing Street | String | False | True |
The street for the billing address. | |
Buyer Accepts Marketing | Bool | False | True |
Indicates if the customer has opted in/out of receiving marketing emails. | |
Cancellation Reason | String | False | True |
The reason given for cancelling the order. | |
Closed Date | Datetime | True | True |
Date when the order was closed, null otherwise, set automatically | |
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. | |
Currency Code | String | False | True |
The currency code used in the order. | |
Customer Phone | String | False | True |
Phone number of Customer placing the Order | |
Date entered 'Stage 1 (Pipeline 1)' | Datetime | True | True |
The date and time when the order entered the 'Stage 1' stage, 'Pipeline 1' pipeline | |
Date exited 'Stage 1 (Pipeline 1)' | Datetime | True | True |
The date and time when the order exited the 'Stage 1' stage, 'Pipeline 1' pipeline | |
Discount Codes | String | False | True |
Discount Codes on an order. | |
Exchange rate | Decimal | False | True |
This is the exchange rate used to convert the cart amount into your company currency. | |
Canceled Date | Datetime | False | True |
Date the order is canceled. | |
Cart ID | String | False | True |
Unique identifier in an external system for the cart associated with the order. | |
Checkout ID | String | False | True |
Unique identifier in an external system for the checkout associated with the order. | |
Created Date | Datetime | False | True |
Date the order is created. | |
Modified Date | Datetime | False | True |
Most recent order modified date. | |
Order ID | String | False | True |
Unique identifier in an external system for the order. | |
Status | String | False | True |
Current status of the order as recorded on the source system. | |
Order URL | String | False | True |
An URL that links to an external site where the orders details can be viewed. | |
Fulfillment Status | String | False | True |
Current fulfillment/shipping status of the order. | |
Amount in company currency | Decimal | False | True |
The amount of the order, using the exchange rate, in your company's currency | |
Landing Site | String | False | True |
The URL of the first page on the sellers site that the customer landed on prior to them placing the order. | |
Object last modified date/time | Datetime | True | True |
Most recent timestamp of any property update for this object. This includes HubSpot internal properties, which can be visible or hidden. This property is updated automatically. | |
Merged record IDs | String | True | True |
The list of record IDs that have been merged into this record. 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. | |
Record Creation Source | String | True | True |
Raw internal propertySource present in the RequestMeta when this record was created | |
Record Source Detail 1 | String | True | True |
First level of detail on how this record was created | |
Record Source Detail 2 | String | True | True |
Second level of detail on how this record was created | |
Record Source Detail 3 | String | True | True |
Third level of detail on how this record was created | |
Record Creation Source ID | String | True | True |
Raw internal sourceId present in the RequestMeta when this record was created | |
Record Source | String | True | True |
How this record was created | |
Record Creation Source User ID | Decimal | True | True |
Raw internal userId present in the RequestMeta when this record was created | |
Discount | Decimal | False | True |
Total Discount on an order as an amount. | |
Name | String | False | True |
Unique ID as represented by a number. | |
Notes | String | False | True |
A block of text associated with the order. | |
Payment Processing Method | String | False | True |
Type of payment processing method. | |
Payment Status | String | False | True |
Current Payment status of the order. | |
Pinned engagement ID | Decimal | False | True |
The object ID of the current pinned engagement. This will only be shown if there is already an association to the engagement. | |
Pipeline | String | False | True |
The pipeline that contains this order | |
Stage | String | False | True |
The order pipeline stage. | |
Processed Date | Datetime | False | True |
The date/time the order was imported into HubSpot. | |
Read Only Object | Bool | True | True |
Is the object read only | |
Referring Site | String | False | True |
The URL of the site that the customer came from to arrive at the sellers site prior to placing their order. | |
Refund Amount | Decimal | False | True |
Refunded amount, if any, associated with an order. | |
Shared Team IDs | String | True | True |
The team IDs of all teams that have shared access to this object | |
Shared User IDs | String | True | True |
The user IDs of all users that have shared access to this object | |
Shipping City | String | False | True |
The city for the shipping address. | |
Shipping Country | String | False | True |
The country for the shipping address. | |
Shipping Phone Number | String | False | True |
The phone number for the shipping address. | |
Shipping ZIP/Postal Code | String | False | True |
The ZIP/postal code for the shipping address. | |
Shipping State | String | False | True |
The state for the shipping address. | |
Shipping Street | String | False | True |
The street for the shipping address. | |
Shipping Cost | Decimal | False | True |
The base cost (i.e. undiscounted), in the orders associated currency, associated with shipping the order. | |
Shipping Status URL | String | False | True |
URL to Shipping status for the order. | |
Shipping Tracking Number | String | False | True |
List of Shipment tracking IDs associated with the order. | |
Source ID | Decimal | True | True |
HubSpot developer App ID from where this order data is first synced. | |
Source Store | String | False | True |
Data used to identify which store the order came from. | |
Subtotal Price | Decimal | False | True |
Total order amount before discounts, tax, duties etc. | |
Tags | String | False | True |
A collection of tag strings associated with the order. | |
Tax Price | Decimal | False | True |
Tax amount associated with the order, including duties. | |
Time in 'Stage 1 (Pipeline 1)' | Decimal | True | True |
The total time in seconds spent by the order in the 'Stage 1' stage, 'Pipeline 1' pipeline | |
Total Price | Decimal | False | True |
Sum Total amount associated with this order. | |
Total Weight | String | False | True |
The total weight of the order for shipping purposes. | |
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. | |
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 | |
Performed in an import | Bool | True | True |
Object is part of an import | |
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. |