Create a line item

Method Details

HTTP Methods:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Headers

Products:

Sales Professional

Required Scope:

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

JSON

Example POST URL: https://api.hubapi.com/crm-objects/v1/objects/line_items Example POST JSON: [ { "name": "hs_product_id", "value": "1642736" }, { "name": "quantity", "value": "50" }, { "name": "price", "value": "9.50" }, { "name": "name", "value": "A custom name for the product for this line item. Discounting 5% on bulk purchase." } ] Example Response: { "objectType": "LINE_ITEM", "portalId": 62515, "objectId": 9867220, "properties": { "amount": { "versions": [ { "name": "amount", "value": "475.00", "timestamp": 0, "sourceId": "LineItemAmountCalculator", "source": "CALCULATED", "sourceVid": [] } ], "value": "475.00", "timestamp": 0, "source": "CALCULATED", "sourceId": "LineItemAmountCalculator" }, "quantity": { "versions": [ { "name": "quantity", "value": "50", "timestamp": 1525368534412, "source": "API", "sourceVid": [] } ], "value": "50", "timestamp": 1525368534412, "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.50", "timestamp": 1525368534412, "source": "API", "sourceVid": [] } ], "value": "9.50", "timestamp": 1525368534412, "source": "API", "sourceId": null }, "name": { "versions": [ { "name": "name", "value": "A custom name for the product for this line item. Discounting 5% on bulk purchase.", "timestamp": 1525368534412, "source": "API", "sourceVid": [] } ], "value": "A custom name for the product for this line item. Discounting 5% on bulk purchase.", "timestamp": 1525368534412, "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": "This product has an updated description and price.", "timestamp": 1525287810508, "source": "API", "sourceVid": [] } ], "value": "This product has an updated description and price.", "timestamp": 1525287810508, "source": "API", "sourceId": null }, "hs_product_id": { "versions": [ { "name": "hs_product_id", "value": "1642736", "timestamp": 1525368534412, "source": "API", "sourceVid": [] } ], "value": "1642736", "timestamp": 1525368534412, "source": "API", "sourceId": null } }, "version": 0, "isDeleted": false }