Check the sync status of an object

Last updated September 12, 2019

GET /extensions/ecomm/v2/sync/status/:storeId/:objectType/:externalObjectId

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 externalObjectId 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

If there has been an error, it will appear in the errors array in the response and an erroredAt field will be present.  It is important to note that the errors array does not empty out if the last update was a success. You can check if the error is relevant to the latest update by comparing the erroredAt to the lastProcessedAt field

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

/:externalObjectId
Used in the request URL

The ID, in your system, of the object that you want to check the sync status for.