Get Ecommerce Settings

Last updated September 12, 2019

/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