Connect Your eCommerce Store Via API

Easyship connects with many different platforms natively, however, if you have a manually developed store, you can connect via our open API.

We'll Cover:

Connect Your Store to Easyship Via API

To connect to Easyship via our open API, you will need a token. Here we will explain how you generate this token.

The Easyship API uses Bearer Authentication (or token authentication). The name “Bearer authentication” can be understood as “give access to the bearer of this token.”

The bearer token is a cryptic string, usually generated by the server in response to a login request. To maintain access, you must send this token in the Authorization header when making requests to Easyship API resources.

Once you've logged into your account select Connect > New Integration.

mceclip0 (71).png

Next, select API Integration at the bottom of the page. You will be prompted to provide a name for your store or integration. Type in the name and click on Connect.

mceclip1 (52).png

Now, select Sandbox or Production, and click on the copy icon to add the token to your clipboard.

mceclip2 (34).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: 

  • RateThis is the shipping rate that will be available to the customer at checkout
  • ShipmentThis scope is to generate a Shipment ID
  • LabelThis scope is for confirming and buying your label
  • PickupThis scope is for scheduling pickups
  • TrackThis scope is used for tracking the journey of a shipment
  • CompanyThis 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