Get a group of line items by ID

This endpoint is part of our developer preview program, and should be considered as a non-stable release that will be subject to bugs and breaking changes while under development. Please take this into account as you build against a release. Please subscribe to our changelog for updates.

Method Details

HTTP Methods:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Headers

Products:

Sales Professional

Required Scope:

Get a group of line items by their IDs. Up to 100 IDs can be included in a single request.

By default, the response will only include the ID a few system fields, and the hs_product_id property. You can get specific properties in the response by using the properties parameter in the URL, and that parameter can be included multiple times to get multiple properties. See the example for more details.

Required Parameters	How to use	Description
OAuth Access Token or API Key	Authorization: Bearer {token} header or hapikey={key} query parameter.	Used to authenticate the request. Please see this page for more details about authentication.
Line item IDs	"ids": [ {list of IDs} ] Used in the request JSON	An array of line item IDs that you want to get. You can include up to 100 IDs in a single request.

Optional Parameters	How to use	Description
Line item properties	&properties= Used in the request URL	By default, only the ID, a few other system fields, and the `hs_product_id` property are returned. You can include any other properties in the response by requesting them in the URL. This parameter can be included multiple times to request multiple properties. See the example for more details.
Line item properties (with history)	&propertiesWithHistory= Used in the request URL	This parameter behaves exactly like the properties parameter above, with the exception that properties included with this parameter also return the full version history for the property.
Include deleted	includeDeletes=true Used in the request URL	By default, deleted records will not be returned by the API. You can include this parameter to make sure that records are returned even when they are deleted.

JSON

Example POST URL (without properties): https://api.hubapi.com/crm-objects/v1/objects/line_items/batch-read?hapikey=demo Example POST JSON: { "ids": [ 9845651, 9867373 ] } Example Response: { "9845651": { "objectType": "LINE_ITEM", "portalId": 62515, "objectId": 9845651, "properties": { "hs_product_id": { "versions": [ { "name": "hs_product_id", "value": "1645342", "sourceVid": [] } ], "value": "1645342", "timestamp": 0, "source": null, "sourceId": null } }, "version": 1, "isDeleted": false }, "9867373": { "objectType": "LINE_ITEM", "portalId": 62515, "objectId": 9867373, "properties": { "hs_product_id": { "versions": [ { "name": "hs_product_id", "value": "1645187", "sourceVid": [] } ], "value": "1645187", "timestamp": 0, "source": null, "sourceId": null } }, "version": 1, "isDeleted": false } } Example POST URL (with properties): https://api.hubapi.com/crm-objects/v1/objects/line_items/batch-read?hapikey=demo&properties=name&properties=quantity&properties=price Example POST JSON: { "ids": [ 9845651, 9867373 ] } Example response: { "9845651": { "objectType": "LINE_ITEM", "portalId": 62515, "objectId": 9845651, "properties": { "quantity": { "versions": [ { "name": "quantity", "value": "25", "timestamp": 1525369755209, "source": "API", "sourceVid": [] } ], "value": "25", "timestamp": 1525369755209, "source": "API", "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 }, "hs_product_id": { "versions": [ { "name": "hs_product_id", "value": "1645342", "sourceVid": [] } ], "value": "1645342", "timestamp": 0, "source": null, "sourceId": null } }, "version": 1, "isDeleted": false }, "9867373": { "objectType": "LINE_ITEM", "portalId": 62515, "objectId": 9867373, "properties": { "quantity": { "versions": [ { "name": "quantity", "value": "25", "timestamp": 1525369755209, "source": "API", "sourceVid": [] } ], "value": "25", "timestamp": 1525369755209, "source": "API", "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 }, "hs_product_id": { "versions": [ { "name": "hs_product_id", "value": "1645187", "sourceVid": [] } ], "value": "1645187", "timestamp": 0, "source": null, "sourceId": null } }, "version": 1, "isDeleted": false } }