Official vendor OpenAPI document · agent-readyE CommerceOrder Managementoauth2,apiKey11 EndpointsREST
For Agents
Read, create, update, archive, and search HubSpot CRM order records, with batch endpoints for bulk import from external commerce systems.
Use for: I need to sync orders from Shopify into HubSpot, Find all orders placed in the last 7 days, Get the order record for a specific order ID, List orders associated with a given contact
Not supported: Does not handle payment processing, shipping label generation, or inventory levels - use for HubSpot CRM order record management only.
The HubSpot CRM Orders API exposes order records inside the HubSpot CRM as a first-class object with read, list, search, and patch operations. It supports batch read, create, update, and archive of up to 100 orders per call, and a search endpoint that can filter by any order property. Use it to sync external commerce orders into HubSpot for reporting, to associate orders with contacts, deals, or line items, or to drive marketing and sales workflows from order events. The endpoints follow the same generic CRM object pattern as other HubSpot CRM resources, so agents that already know how to call /crm/v3/objects/{objectType} can drop in immediately.
Install Jentic One Beta
Connect the Orders to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Orders, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fhubspot.com%2Fhubspot-crm-orders" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fhubspot.com%2Fhubspot-crm-orders" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Orders API.
Read a single order record by ID with property selection
List orders with cursor-based pagination and association expansion
Search orders by property filters such as status, amount, and create date
Create up to 100 orders in a single batch call from an external system
Update specific properties on an order without overwriting unrelated fields
Archive orders that are no longer relevant to the CRM
Use Cases
Patterns agents use Orders API for, with concrete tasks.
★ External commerce order sync
Import orders from an external commerce platform (Shopify, WooCommerce, custom checkout) into HubSpot so the sales and marketing teams can see them in the CRM. Use POST /crm/v3/objects/orders/batch/create to push up to 100 orders per call, then associate each order with the related contact and line items via the Associations API.
POST 50 order records to /crm/v3/objects/orders/batch/create with properties hs_order_name, hs_order_amount, and hs_currency_code, and verify each returned a non-null id.
Order-driven sales follow-up
Trigger a follow-up sequence whenever a high-value order lands in HubSpot. Search /crm/v3/objects/orders/search for orders above a threshold amount in a given window, then drive workflow steps off the result. Useful for VIP customer outreach and reorder campaigns.
POST a search to /crm/v3/objects/orders/search filtering hs_order_amount greater than 1000 with createdate in the last 24 hours, and return the order IDs.
Order status reconciliation
Keep HubSpot order status in sync with the upstream commerce system. PATCH /crm/v3/objects/orders/{orderId} to update the status property whenever a fulfillment, shipment, or refund event arrives, without disturbing other order fields. Pair with batch read to verify the update applied across many orders.
PATCH /crm/v3/objects/orders/12345 setting hs_pipeline_stage to fulfilled, then GET the same order and confirm the value updated.
AI agent execution through Jentic
An agent that needs to act on order records discovers the API via Jentic's intent search using a query like 'create a hubspot order', loads the input schema for the chosen operation, and executes the call with credentials supplied from your Jentic One instance. The same flow handles single-record CRUD, batch operations, and search.
Search Jentic for 'create a hubspot order', load POST /crm/v3/objects/orders/batch/create, and execute with a single order in the inputs array.
Key Endpoints
11 endpoints — the hubspot crm orders api exposes order records inside the hubspot crm as a first-class object with read, list, search, and patch operations.
METHOD
PATH
DESCRIPTION
GET
/crm/v3/objects/orders/{orderId}
Read a single order by ID
PATCH
/crm/v3/objects/orders/{orderId}
Update properties on an order
DELETE
/crm/v3/objects/orders/{orderId}
Archive an order
GET
/crm/v3/objects/orders
List orders with pagination
POST
/crm/v3/objects/orders/batch/create
Create up to 100 orders in one call
POST
/crm/v3/objects/orders/batch/read
Read up to 100 orders by ID
POST
/crm/v3/objects/orders/batch/update
Update up to 100 orders in one call
POST
/crm/v3/objects/orders/search
Search orders with filter groups and sorts
GET
/crm/v3/objects/orders/{orderId}
Read a single order by ID
PATCH
/crm/v3/objects/orders/{orderId}
Update properties on an order
DELETE
/crm/v3/objects/orders/{orderId}
Archive an order
GET
/crm/v3/objects/orders
List orders with pagination
POST
/crm/v3/objects/orders/batch/create
Create up to 100 orders in one call
POST
/crm/v3/objects/orders/batch/read
Read up to 100 orders by ID
POST
/crm/v3/objects/orders/batch/update
Update up to 100 orders in one call
POST
/crm/v3/objects/orders/search
Search orders with filter groups and sorts
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
O
Orders
- Foundational (D-)42/100
74
Foundational Compliance63
Developer Experience & Jentic Compatibility18
AI-Readiness & Agent Experience94
Agent Usability63
Security67
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
74
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: A-Signals: 4
94%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
0%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
100%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
63
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: BSignals: 4
8%
Example Density
How richly the API is illustrated with examples.
95%
Example Validity
Percentage of examples that conform to their schemas.
50%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
18
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: FSignals: 4
19%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
0%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
53%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
63
Security
Trust, risk posture, and security compliance.
Grade: BSignals: 1
63%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
67
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: B+Signals: 1
67%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring Orders by hand means implementing HubSpot's OAuth2 authorization-code flow (or managing a private-app header token), sending each call to api.hubapi.com with the right order properties and associations, and handling token refresh yourself. Through Jentic you install once, import Orders from the API Directory, store the token once, and your agent calls it.
Permission scoping
This API works against the orders object collection, with the order id in the URL path (/crm/v3/objects/orders/{orderId}) on reads, updates, and deletes. Limit the agent to the operations it needs, such as reading and searching orders, so destructive paths like order delete or batch update are not included unless you add them.
Credential isolation
Your HubSpot token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'create a HubSpot order' or 'search orders by status', and Jentic returns the matching Orders operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Orders API through Jentic.
What authentication does the HubSpot Orders API use?
It accepts OAuth 2.0 access tokens for HubSpot apps and private app tokens passed as a Bearer credential in the Authorization header. Through Jentic, the token is stored in the credential vault and attached to requests at execution time.
Can I create line items as part of an order?
No. The Orders API creates the order record itself; line items are a separate object. Use the Line Items API and the Associations API to attach line items to an order after the order is created.
What are the rate limits for the HubSpot Orders API?
HubSpot enforces account-level limits, typically 100 requests per 10 seconds for OAuth apps. The batch endpoints under /crm/v3/objects/orders/batch/* count as a single request, so prefer them when ingesting large order volumes.
How do I bulk import orders through Jentic?
Search Jentic with 'batch create hubspot orders', load POST /crm/v3/objects/orders/batch/create, and execute with up to 100 order records per call. The response returns each created order's id and properties for downstream association.
Is the HubSpot Orders API free?
It is available on HubSpot accounts that have the Commerce Hub or appropriate add-on enabled. The endpoints themselves do not carry per-call pricing; they are governed by your account's API rate limits.
How do I find orders for a specific contact?
POST a query to /crm/v3/objects/orders/search with a filter on the associated contact ID, or list orders via GET /crm/v3/objects/orders and pass associations=contacts to expand the link in the response.
Can I limit what my agent is allowed to do with the HubSpot Orders API?
Yes. Because you run Jentic One yourself, your own rules decide which HubSpot Orders operations and credentials the agent may use. You can grant only the operations it actually needs, such as reading a single order at /crm/v3/objects/orders/{orderId} or searching orders via /crm/v3/objects/orders/search, while withholding destructive paths like the DELETE archive or the batch update endpoints. The agent can only call the operations you enable, so it cannot reach any HubSpot order action you have not explicitly allowed.
GET STARTED