Create or update a store

Last updated April 24, 2019

PUT /extensions/ecomm/v2/stores

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:

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.

Note: This operation is an update-replace. Blank values will clear out existing data.

Note: 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.

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.