Get ecommerce settings v2

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Headers

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

JSON

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" } ] } } }