Import ecommerce data

Last updated April 3, 2019

POST /extensions/ecomm/v2/imports/page

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:


Content Type:


Response Format:


Requires Authentication?


Rate Limited?






Required Scope:


Import a page of ecommerce data upon customer request.

Up to 200 import messages can be included in a single request.

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.
importStartedAt   In request body JSON  Timestamp from the webhook when the customer requested imported in HubSpot UI
 pageNumber In request body JSON  Integer starting at zero of the page number for that objectType
 messages In request body JSON Array of sync messages for this page of imports. Up to 200 messages can be included.
 storeId In request body JSON The key of the store for this import
objectType In request body JSON The HubSpot object this page of imports is for. Must be one of CONTACT, DEAL, LINE_ITEM or PRODUCT

If successful you will receive 204 No Content response.