Connect your Salesforce store on EcoShip

Modified on Thu, 09 Nov 2023 at 06:37 AM

Connecting your store is important to fetch product & shipping information and helps you in creating reverse shipments for your orders without hassle. Follow the steps below to connect your Salesforce store.


You'll need 3 credentials to connect your store

  1. Instance URL
  2. Consumer key (Connected App)
  3. Consumer secret (Connected App)


Instance URL

For example, https://mycompany.my.salesforce.com and https://mycompany.my.site.com


Create a profile and add an API Only User

External Reference - https://help.salesscreen.wiki/en/articles/22052-how-do-i-create-an-api-integration-user-in-salesforce


  • Set up profile - 

    The first thing you need to do is to create the API Only profile that will be set as the profile type of the integration user account.

    1. From Setup, input "Profiles" in the search field and select Profiles under Users.

    2. In the Profiles section, click on New Profile.
    3. The existing profile that you clone from must have a full Salesforce license. In the example below, we've chosen System Administrator - which indeed has a full Salesforce license. Set the Profile Name to be "API Only" and finally, click Save 

    4. After having saved the new profile in Step 3, you'll be presented with an overview of the profile, as seen in the image below.
    5. Proceed to click Edit and make sure that both the Standard Object Permissions and Custom Object Permissions allow Modify All as shown for the three standard objects in the image below.
    6. If you don't want the API Only user account to be allowed access to the Salesforce website dashboards, like typical Salesforce users, you can make sure the API Only User option is checked, like in the image below. Finally, scroll all the way up or down and click Save.


  • Create user with 'API Only' profile

    Now that the API Only profile has been set up, it's time to create a user with this profile.

    1. At the API Only profile overview, click View Users. 
    2. Click New User and proceed to set the User License to Salesforce and the Profile to be API Only, as shown in the image below.
    3. Finally, click Save and use this newly created user account - under the API Only profile - to initialize the connection between EcoShip and Salesforce.


Create a Connected App

Creating a connected app allows you to generate consumer key and consumer secret which will allow you to integrate salesforce with EcoShip.

  1. From Setup, input "App Manager" in the search field and select App Manager under Apps.
  2. Click on "New Connected App" in the App Manager section.
  3. Fill the information in Connected App as follows:
    • Under Basic Information section, keep the required details as follows -
    • Under API (Enable OAuth Settings) section, keep the details as follows -
      • Check Enable OAuth Settings setting.
      • Under Selected OAuth Scopes, select Full access(full).
      • Enable the following settings -
        • Enable Client Credentials Flow
        • Enable Authorization Code and Credentials Flow
        • Require user credentials in the POST body for Authorization Code and Credentials Flow
    • Scroll up or down the page and click on Save.
  4. After having saved the new Connected App in previous step, you'll be presented with an overview of the profile, as seen in the image below.
  5. Click on Manage button.
  6. Click on Edit Policies.
  7. Under OAuth Policies - 
    • Change Permitted Users to "All users may self-authorize".
    • Change IP Restrictions to "Relax IP restrictions".
  8. Under Client Credentials Flow, keep the user in "Run as" as the user you created in API Only profile (Phase-2) above.
  9. Click on Manage Connected Apps under Connected Apps under Apps on the left side of the screen.
  10. Click on EcoShip and you will be redirected to below page.
  11. Click on Manage Consumer Details  button and you will be redirected to another page where it will ask you for verification code. After verification has been done, you will be able to see your consumer key and consumer secret which will be used for integrating with EcoShip.
  12. You can add the Instance URL, consumer key, consumer secret in respective fields of your EcoShip dashboard, to connect your store. 

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons

Feedback sent

We appreciate your effort and will try to fix the article