Create a line item

POST /crm-objects/v1/objects/line_items

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?

Yes

Headers

User-Agent

Products:

Sales Professional

Required Scope:

e-commerce

Create a new line item.

The request body should be a list of properties you want to set for the new line item, with each entry being the internal name of the property to be set, and the value of that property.

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 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.
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 other properties that you want to set for the new line item.