There's a new version of the HubSpot API

Check out the new API

As of November 30, 2022, HubSpot API Keys are being deprecated and are no longer supported. Continued use of HubSpot API Keys is a security risk to your account and data. Your API Keys could be deactivated at any time after Nov. 30th, and we recommend that you migrate to Private Apps as soon as possible so you do not lose business-critical functionality.

Create or update a store

Last updated June 17, 2020

PUT /extensions/ecomm/v2/stores

Method Details

HTTP Methods:

PUT

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing & CRM

Required Scope:

integration-sync

Create a new store, or update an existing store. The Ecommerce Bridge v2 allows a single HubSpot account to be connected to multiple stores, either from the same ecommerce platform or from multiple platforms.

Users will be able to segment data based on the store it came from, and will be able to see separate overviews and import tools for each store.

Notes:
  • This operation is an update-replace. Blank values will clear out existing data.
  • When stores are created by an app using OAuth, uninstalling the app will delete any stores created by the app, and any workflows using the store will be disabled.
  • Creating a new store or modifying an existing store will revert the Ecommerce Pipeline to its default label and stages. This pipeline is shared across all integrations using the Ecommerce Bridge and it should not be modified.
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 "id": xxxx
Used in the request body

A unique identifier for the store. This ID is namespaced to your app and the specific account the store is created for.

Note: Using an existing ID will update the existing store. Using a new ID will create a new store.
 Label  "label":yyyy
Used in the request body		 A human readable title for the store. This will be used in several places in the HubSpot UI. It should clearly and uniquely identify this store for users.

Optional Parameters How to use Description
Admin URI "adminUri":zzzz
Used in the request body		 An address to the website where a user can manage their store in your ecommerce system. This URI will be linked in the ecommerce settings page for this store, allowing the user to easily get to the admin page.

About

Jobs

Learn Inbound

Support

Locations

HubSpot, Inc.
25 First Street, 2nd Floor
Cambridge, MA 02141
European Headquarters
Ground Floor, Two Dockland Central
Guild Street, Dublin 1
Asia/Pacific Office
20 Hunter St, Level 7
Sydney NSW 2000
View our other locations
Example PUT URL: https://api.hubapi.com/extensions/ecomm/v2/stores?hapikey=demo Example PUT data: { "id": "ecommercebridge-test-store", "label": "Ecommerce Bridge Test Store", "adminUri": "https://ecommercebridge-test-store.myshopify.com" } Example response: { "id": "ecommercebridge-test-store", "label": "Ecommerce Bridge Test Store", "adminUri": "https://ecommercebridge-test-store.myshopify.com" }