Easyship API Documentation
This is the complete API documentation for connecting to the Easyship API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.
MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.
Meet Easyship: Easyship shipping and logistics platform for rates, shipments, pickups, tracking, shipping rules, and fulfillment operations. Keep reading to get started.
Quickstart
Before you run your first Easyship request, you need three things:
- A MindCloud account — sign in or create an account at MindCloud.
- A MindCloud API Key — create one in API Keys. Keep it on your server.
- At least one Easyship connection — create or choose one in Connections. Note its
connectionId.
Every Easyship action uses the same URL pattern:
https://connect.mindcloud.co/v1/universal/easyship/latest/actions/{actionSlug}You need a MindCloud API Key and a Easyship connection. Then call an action such as Get Account Information:
curl --request GET \
--url "https://connect.mindcloud.co/v1/universal/easyship/latest/actions/get-account-information" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--get \
--data-urlencode "connectionId=$CONNECTION_ID"Every response comes back in the same envelope, with your rows in a data array:
{
"success": true,
"data": [
{ "id": "1042", "name": "Ava" }
],
"meta": {}
}After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.
Authenticate with a MindCloud API Key plus a connectionId for your Easyship account. See Easyship API Authentication for the full flow and how to get your connection credentials.
Easyship actions
All 24 published actions for this Easyship version. Each page documents the endpoint, arguments, and response controls.
- PUTCancel Pickup
- PUTCancel Shipment
- POSTCreate Address
- POSTCreate Batch of Labels
- POSTCreate Pickup
- POSTCreate Product
- POSTCreate Shipment
- POSTCreate Shipping Rule
- GETGet Account Information
- GETGet Shipment
- GETGet Shipping Rule
- GETList Addresses
- GETList Courier Services
- GETList Couriers
- GETList Pickups
- GETList Products
- GETList Shipment Trackings
- GETList Shipments
- GETList Shipping Rules
- GETList Webhooks
- GETRequest Rates
- PUTUpdate Address
- PUTUpdate Product
- PUTUpdate Shipment
Related apps
More Commerce apps on the Universal API, behind the same REST shape. Or browse all apps.