How to integrate with Sherpa API

  • Updated

Whether you are a small business or a large enterprise, a direct integration with Sherpa means you will never need to manually log your deliveries ever again.

Integrating with Sherpa is simple enough but you will probably require your web developer to do it for you.

To make it easier, we use Swagger, an interactive API documentation that makes our API comprehensible for developers and non-developers:

Important update 1/2/2024

We have recently made a change to our API authentication method, and are transitioning from user credentials to API Token Authentication, enhancing the security of your accounts.

Instead of relying on traditional usernames and passwords, this method uses secure tokens to protect your data, making it much more resilient to potential breaches and ensuring the safety of your information.

Action required

Sherpa Business Account's now have access to Client API tokens which will be used to authenticate user accounts user account. 

Client API tokens can be accessed via Sherpa User Web:

If you have previously integrated with us via username & password, you or your technology team will need to update Sherpa user authentication method from username/password to accept Client API tokens.

Once changes are made, your team will need to be re-authenticate using your Client API Tokens, available within Sherpa user settings.


What is the deadline?

API Token Authentication is available to use now.

Authentication using user credentials will continue to work until May 1, 2024. We request that you make the change to the new authentication method before that date.


We have updated our documentation with the changes required. As always, we recommend you test these changes on our QA (sandbox) environment first.

If you have any questions or encounter any problems enabling the changes, please email and a member of our team will be able to assist.





Share this article

Was this article helpful?

Need some help?

Reach out to our support team today, and we'll get back to you as soon as we can.

Get in touch