Connect Your eCommerce Store Via API

Easyship connects with many different platforms natively, but if you have a custom-built store, you can connect via our open API. Below, we’ll explain how to generate the necessary token.

How to Connect your Store to Easyship Via API

The Easyship API uses Bearer Authentication (token authentication). This method gives access to API resources based on a bearer token. The token, a cryptic string, is usually generated by the server after login and is sent in the Authorization header for API requests.

Make sure you store this token securely, as it grants access to your account.

1. Log into your Easyship account.

2. Select Connect > New Integration.

Untitled design - 2024-09-23T102957.494.png

3. Choose API Integration, name your store, and click Connect.

4. Choose Sandbox or Production, and copy the token.

Untitled design - 2024-09-23T131953.554.png

On this page, you are also able to define the scopes of the token relating to the Easyship account. The scopes you can choose from are: 

  • Rate: This is the shipping rate that will be available to the customer at checkout
  • Shipment: This scope is to generate a Shipment ID
  • Label: This scope is for confirming and buying your label
  • Pickup: This scope is for scheduling pickups
  • Track: This scope is used for tracking the journey of a shipment
  • Company: This scope is used for managing your account
  • Reference: This scope is for retrieving product categories

Your API token grants access to your account, so make sure you keep it safe!

To get additional information regarding our API and its documentation, kindly visit our dedicated developer page.

Was this article helpful?
0 out of 0 found this helpful
Popular Topics