EzeeShip API
Overview
EzeeShip API allows developers to use RESTful API to create a holistic shipping system for their online marketplaces or apps. The services include validating addresses, postage estimation, purchasing shipments and printing labels, tracking shipments, etc. All interfaces can be applied easily, quickly, directly, and individually—no precondition or workflow is needed.
Carrier
The current version of ezeeship.com provides services through FedEx,UPS and USPS.
API Endpoint
https://ezeeship.com/api/ezeeship-openapi
Authentication
Set your API KEY in all Request Header to complete access permission. First, register for an EzeeShip account to become a member. Then you can log into your account and find “Setting” on the top right corner,generate API KEY in API submenu. Keep your API KEY secured and do not share related configuration at public places such as GitHub.
EzeeShip.com does not have Sandbox testing environment, but you can print out a sample label for testing in order shipment interface free of charge.
API KEY
All requests need Request Header. API KEY needs to be set up in Authorization field, POST method also needs designated Content-Type
Authorization : {apiKey}
Content-Type : application/json
Common Response Data
All response will be returned with the Common Response Data; HTTP Status is always 200 unless encounter severe abnormality
Unified data format is explained below:
Parameter | Parameter Description |
---|---|
result | “OK” returned if changes are made successful; “ERR” returned if not successful |
errorCode | Error code (not in use for now) |
message | Error message |
data | API returns data object in json form |
Success Response Data sample:
{
"result": "OK",
"message": "",
"data": {
"rate": 48.71,
"feeDetail": {
"DryIce": 6.25,
"Cod": 16.25,
"Signture": 6.88,
"Insurance": 5,
"Fuel": 0.52,
"baseRate": 13.81
}
}
}
Error Response Data sample:
{
"result": "ERR",
"message": "Authorization failed!"
}
This is a book powered by GitBook.