Reminder: As of August 9th, the demo API key will only be allowed to make GET requests. Please see the announcement for more details.

Import ecommerce data

Last updated September 6, 2018

PUT /extensions/ecomm/v1/import-pages/:importStartedAt/:objectType/:pageNumber

Method Details

HTTP Methods:


Content Type:


Response Format:


Requires Authentication?


Rate Limited?





Marketing & CRM

Required Scope:


Import a page of ecommerce objects. This endpoints is used as part of the import process.

Each request may contain up to 500 messages. Import messages are similar to sync messages without the action property, as all import messages are treated as upserts.

Note: This endpoint is only used with an installed app, and cannot be used with a custom integration using a hapikey.
Required Parameters How to use Description
OAuth Access Token Authorization: Bearer {token}
Used in the request headers
Used to authenticate the request. Please see this page for more details about authentication.
NOTE: The import process is only supported with installed apps. When importing data, you must use the OAuth access token associated with the portal that data is being imported into.
Import request timestamp :importStartedAt
Used in the request URL
The importStartedAt timestamp from the import intialization request.
Object type :objectType
Used in the request URL
The object type this data corresponds to. Must be one of CONTACT, DEAL, LINE_ITEM, or PRODUCT.
Page number :pageNumber
Used in the request URL
A numeric page number that identifies this page of data. Must be unique within this import. The integration is responsible for ensuring that each page number is unique for each import request as indicated by the importStartedAt value.

The request will be a list of up to 500 import messages. Each import message will have the following fields.

Field name Field type Description
integratorObjectId String, max length 100 characters, ascii-only
The ID, from your system, of the object that is being created or updated.
propertyNameToValues Map/Dictionary This is a map of your property names to the values for this object. These are the values that we will sync into corresponding HubSpot object. See the example for details.