Get a log of changes for line items

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

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Sales Professional

Required Scope:

e-commerce

Get a list of changes to line item objects. Returns 1000 (or fewer) changes, starting with the least recent change.

This endpoint is designed to be polled periodically, allowing your integration to keep track of which objects have been updated so that you can get the details of those updated objects.

After each request, the timestampchangeType, and objectId of the most recently changed record (which will be the last record in the returned list of changes) should be stored by your integration, as you can use those values to get changes that occurred later, allowing you to pull only changes that occurred after your last polling request. All three values must be stored, as the combination of those values is what your integration needs to use to get changes that occurred after your last polling attempt. 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.

Optional Parameters How to use Description
Timestamp timestamp=
Used in the request URL
The timestamp of the last change you pulled.
Note: The timestamp parameter can be used by itself, but the results will be inclusive, meaning you may see changes that you saw in a previous request if there was a change at the provided timestamp. You should only use the timestamp by itself if you haven't polled for changes before and don't need changes previous to the timestamp you're including (for example, after syncing all existing line items).
Change Type changeType=
Used in the request URL
The last changeType you pulled.
Object ID objectId=
Used in the request URL
The ID of the last object you received changes for.