There's a new version of the HubSpot API

Check out the new API

Starting November 30, 2022, API keys will be sunset as an authentication method. Learn more about this change and how to migrate an API key integration to use a private app instead.

Get Ecommerce Settings

Last updated June 17, 2020

/extensions/ecomm/v2/settings

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Developer Tools

Retrieve the current ecommerce settings.
Required Parameters How to use Description
API Key hapikey=  The API key (hapikey) for your portal or your app.
Note: If you are working with an installed app using OAuth, you must use the Developer HAPIkey associated with the Developer portal that the OAuth app was created in.
App ID &appId=
Used in the request URL		 The ID of the app, created inside your HubSpot Developer portal. Required if you are retrieving the settings for an installed app.

Optional Parameters How to use Description
Show Provided Mappings showProvidedMappings= Boolean to indicate if the response should contain the HubSpot defined mappings. Defaults to false

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 GET URL, retrieving the settings for your portal: https://api.hubapi.com/extensions/ecomm/v2/settings?hapikey=demo Example URL, getting the settings for an installed app: https://api.hubapi.com/extensions/ecomm/v2/settings?hapikey=56...37&appId=26080 { "enabled": true, "webhookUri": "https://myapi.com/my-webhook-handler", "mappings": { "CONTACT": { "properties": [ { "externalPropertyName": "firstname", "hubspotPropertyName": "firstname", "dataType": "STRING" }, { "externalPropertyName": "phone_number", "hubspotPropertyName": "mobilephone", "dataType": "STRING" }, { "externalPropertyName": "familyname", "hubspotPropertyName": "lastname", "dataType": "STRING" }, { "externalPropertyName": "customer_email", "hubspotPropertyName": "email", "dataType": "STRING" } ] }, "DEAL": { "properties": [ { "externalPropertyName": "purchase_date", "hubspotPropertyName": "closedate", "dataType": "STRING" }, { "externalPropertyName": "name", "hubspotPropertyName": "dealname", "dataType": "STRING" }, { "externalPropertyName": "stage", "hubspotPropertyName": "dealstage", "dataType": "STRING" }, { "externalPropertyName": "abandoned_cart_url", "hubspotPropertyName": "ip__ecomm_bride__abandoned_cart_url", "dataType": "STRING" } ] }, "PRODUCT": { "properties": [ { "externalPropertyName": "product_name", "hubspotPropertyName": "name", "dataType": "STRING" }, { "externalPropertyName": "product_description", "hubspotPropertyName": "description", "dataType": "STRING" }, { "externalPropertyName": "price", "hubspotPropertyName": "price", "dataType": "NUMBER" } ] }, "LINE_ITEM": { "properties": [ { "externalPropertyName": "discount_amount", "hubspotPropertyName": "discount", "dataType": "NUMBER" }, { "externalPropertyName": "num_items", "hubspotPropertyName": "quantity", "dataType": "NUMBER" }, { "externalPropertyName": "price", "hubspotPropertyName": "price", "dataType": "NUMBER" }, { "externalPropertyName": "tax_amount", "hubspotPropertyName": "tax", "dataType": "NUMBER" } ] } } }