Get a line item by ID

GET  /crm-objects/v1/objects/line_items/: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:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Sales Professional

Required Scope:

e-commerce

Get a specific line item by its ID.

By default, the response will only include the ID, a few system fields for the line item, 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 ID :id
Used in the request URL
The ID of the line item you want to get.

Optional Parameters How to use Description
Line item properties &property=
Used in the request URL
By default, only the ID, a few other system fields, and the hs_product_id property are returned for the line item. You can include 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.
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.