There's a new version of the HubSpot API

Check out the new API
View Beta Docs

We're also working on a new documentation website, you're invited to check it out and give us your feedback.

Create a group of line items

Last updated January 7, 2025

POST /crm-objects/v1/objects/line_items/batch-create

Method Details

HTTP Methods:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Sales Professional

Required Scope:

e-commerce

Create a group of line items. Up to 100 line items can be created in a single request. This would allow you to create all of the line items for an entire order (or multiple orders) in a single request.

The request body will be an array, with each entry being a list of properties you want to set for each new line item. Please see the example for more details.

You must set the hs_product_id property when creating a line item. This property needs to be the objectId of a product object, and represents the product being sold.

Required Parameters How to use Description
OAuth access token or private app access token Authorization: Bearer {token} header  Used to authenticate the request. Please see this page for more details about authentication.
Product ID "hs_product_id"
Used in the request JSON		 The objectId of a product object.

Optional Parameters How to use Description
Any line item properties Used in the request JSON Any properties you want to set for each line item being created.

About

Jobs

Learn Inbound

Support

Locations

HubSpot, Inc.
25 First Street, 2nd Floor
Cambridge, MA 02141
European Headquarters
Ground Floor, Two Dockland Central
Guild Street, Dublin 1
Asia/Pacific Office
20 Hunter St, Level 7
Sydney NSW 2000
View our other locations
Example POST URL: https://api.hubapi.com/crm-objects/v1/objects/line_items/batch-create Example POST JSON (creating two line items): [ [ { "name": "hs_product_id", "value": "1645342" }, { "name": "quantity", "value": "25" }, { "name": "name", "value": "A custom name for the product for this line item." } ], [ { "name": "hs_product_id", "value": "1645187" }, { "name": "quantity", "value": "25" }, { "name": "price", "value": "9.00" }, { "name": "name", "value": "Widgets, special discount price" } ] ] Example response: [ { "objectType": "LINE_ITEM", "portalId": 62515, "objectId": 9845651, "properties": { "amount": { "versions": [ { "name": "amount", "value": "687.50", "timestamp": 0, "sourceId": "LineItemAmountCalculator", "source": "CALCULATED", "sourceVid": [] } ], "value": "687.50", "timestamp": 0, "source": "CALCULATED", "sourceId": "LineItemAmountCalculator" }, "quantity": { "versions": [ { "name": "quantity", "value": "25", "timestamp": 1525369755209, "source": "API", "sourceVid": [] } ], "value": "25", "timestamp": 1525369755209, "source": "API", "sourceId": null }, "hs_lastmodifieddate": { "versions": [ { "name": "hs_lastmodifieddate", "value": "0", "timestamp": 0, "source": "CALCULATED", "sourceVid": [] } ], "value": "0", "timestamp": 0, "source": "CALCULATED", "sourceId": null }, "price": { "versions": [ { "name": "price", "value": "27.50", "timestamp": 1525299376761, "source": "API", "sourceVid": [] } ], "value": "27.50", "timestamp": 1525299376761, "source": "API", "sourceId": null }, "name": { "versions": [ { "name": "name", "value": "A custom name for the product for this line item.", "timestamp": 1525369755209, "source": "API", "sourceVid": [] } ], "value": "A custom name for the product for this line item.", "timestamp": 1525369755209, "source": "API", "sourceId": null }, "createdate": { "versions": [ { "name": "createdate", "value": "0", "timestamp": 0, "source": "API", "sourceVid": [] } ], "value": "0", "timestamp": 0, "source": "API", "sourceId": null }, "description": { "versions": [ { "name": "description", "value": "A description of this product.", "timestamp": 1525299376761, "source": "API", "sourceVid": [] } ], "value": "A description of this product.", "timestamp": 1525299376761, "source": "API", "sourceId": null }, "hs_product_id": { "versions": [ { "name": "hs_product_id", "value": "1645342", "timestamp": 1525369755209, "source": "API", "sourceVid": [] } ], "value": "1645342", "timestamp": 1525369755209, "source": "API", "sourceId": null }, "recurringbillingfrequency": { "versions": [ { "name": "recurringbillingfrequency", "value": "quarterly", "timestamp": 1525299376761, "source": "API", "sourceVid": [] } ], "value": "quarterly", "timestamp": 1525299376761, "source": "API", "sourceId": null } }, "version": 0, "isDeleted": false }, { "objectType": "LINE_ITEM", "portalId": 62515, "objectId": 9867373, "properties": { "amount": { "versions": [ { "name": "amount", "value": "-275.00", "timestamp": 0, "sourceId": "LineItemAmountCalculator", "source": "CALCULATED", "sourceVid": [] } ], "value": "-275.00", "timestamp": 0, "source": "CALCULATED", "sourceId": "LineItemAmountCalculator" }, "quantity": { "versions": [ { "name": "quantity", "value": "25", "timestamp": 1525369755209, "source": "API", "sourceVid": [] } ], "value": "25", "timestamp": 1525369755209, "source": "API", "sourceId": null }, "hs_lastmodifieddate": { "versions": [ { "name": "hs_lastmodifieddate", "value": "0", "timestamp": 0, "source": "CALCULATED", "sourceVid": [] } ], "value": "0", "timestamp": 0, "source": "CALCULATED", "sourceId": null }, "price": { "versions": [ { "name": "price", "value": "9.00", "timestamp": 1525369755209, "source": "API", "sourceVid": [] } ], "value": "9.00", "timestamp": 1525369755209, "source": "API", "sourceId": null }, "name": { "versions": [ { "name": "name", "value": "Widgets, special discount price", "timestamp": 1525369755209, "source": "API", "sourceVid": [] } ], "value": "Widgets, special discount price", "timestamp": 1525369755209, "source": "API", "sourceId": null }, "createdate": { "versions": [ { "name": "createdate", "value": "0", "timestamp": 0, "source": "API", "sourceVid": [] } ], "value": "0", "timestamp": 0, "source": "API", "sourceId": null }, "discount": { "versions": [ { "name": "discount", "value": "20", "timestamp": 1525292253568, "source": "API", "sourceVid": [] } ], "value": "20", "timestamp": 1525292253568, "source": "API", "sourceId": null }, "description": { "versions": [ { "name": "description", "value": "A description of yet another product.", "timestamp": 1525289943771, "source": "API", "sourceVid": [] } ], "value": "A description of yet another product.", "timestamp": 1525289943771, "source": "API", "sourceId": null }, "hs_product_id": { "versions": [ { "name": "hs_product_id", "value": "1645187", "timestamp": 1525369755209, "source": "API", "sourceVid": [] } ], "value": "1645187", "timestamp": 1525369755209, "source": "API", "sourceId": null }, "recurringbillingfrequency": { "versions": [ { "name": "recurringbillingfrequency", "value": "annually", "timestamp": 1525289943771, "source": "API", "sourceVid": [] } ], "value": "annually", "timestamp": 1525289943771, "source": "API", "sourceId": null } }, "version": 0, "isDeleted": false } ]