Check the sync status of an object

GET /extensions/ecomm/v1/sync-status/:objectType/:integratorObjectId

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing & CRM

Required Scope:

integration-sync

Check the sync status of a object, based on the integratorObjectId and type of object. Returns a timestamp of last time the object was processed as well as the HubSpot object ID (for example, the vid for a contact).

When building using the Ecommerce Bridge API, to get the specific error message for an object, consider polling the Sync Errors endpoint when numErrors is greater than 0

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.
Object Type /:objectType
Used in the request URL
The object type that the updates are for. One of CONTACT, DEAL, PRODUCT, or LINE_ITEM.
Integrator Object ID

/:integratorObjectId
Used in the request URL

The ID, in your system, of the object that is being created, updated, or deleted.