Jump to Content
API Reference
Docs
Discussions
Docs
Samples
API Reference
Discussions
v2023.01
v2024.09
API Reference
Docs
Discussions
Dashboard
API Reference
Dashboard
2023-01
Docs
Samples
API Reference
Discussions
Create an Access Token
Search
These docs are for v2023.01. Click to read the latest docs for v2024.09.
JUMP TO
API
Overview
Errors
Authentication
Rate Limit
Idempotent Requests
Scopes
Easyship Public API
Account
Information about the Account
get
Addresses
List all Addresses
get
Create an Address
post
Update an Address
patch
Delete an Address
delete
Auto Recharge
Update Auto Recharge Credit Settings
patch
Get Auto Recharge Credit Settings
get
Batches
List all Batch Items
get
Create a Batch of Shipments
post
List all Batches
get
Get a Batch
get
Billing Documents
Download Billing Document
get
List all Billing Documents
get
List all Billing Document's Transaction Records
get
Boxes
List all Boxes
get
Create a Box
post
Update a Box
patch
Delete a Box
delete
Countries
List all Countries
get
Couriers
List all Estimated Delivery Dates for a Courier
get
List Available Pickup Slots
get
List all Couriers
get
Courier Accounts
List all Couriers in Couriers Accounts
get
Deactivate a Courier Account
post
List all Courier Accounts
get
Create a Courier Account
post
Get a Courier Account
get
Update a Courier Account
patch
Delete a Courier Account
delete
Bulk update of Courier Account's Couriers
post
Credit
Get credit
get
Add credit
post
eFulfillment
Tracking Updates
post
Warehouse State Updates
post
HS codes
List HS Codes
get
Item Categories
List all Item Categories
get
Labels
Create Labels
post
Pickups
Cancel a Pickup
post
List all Pickups
get
Create a Pickup
post
Get a Pickup
get
Products
List all Products
get
Create a Product
post
Delete a Product
delete
Update a Product
patch
Rates
Request Rates
post
Settings
Activate Assets
post
Deactivate Assets
post
List all Assets
get
Create an Asset
post
Update an Asset
patch
Delete an Asset
delete
List Account Settings
get
Update Multiple Account Settings
post
Shipments
Cancel a Shipment
post
List All Documents
get
Create a Return Shipment
post
List all Trackings
get
List Transaction Records for a Shipment
get
List Unavailable Couriers for a Shipment
get
List all Shipments
get
Create a Shipment
post
Get a Shipment
get
Update a Shipment
patch
Delete a Shipment
delete
List All Shipments of Specific Pickup
get
States
List all States
get
Stores
List all Stores
get
Tags
List all Tags
get
Create a Tag
post
Taxes and Duties
Calculate Tax and Duty
post
Transaction Records
List all Transaction Records
get
Webhooks
Webhooks Guide
Webhook Events
shipment.label.created
shipment.label.failed
shipment.tracking.checkpoints.created
shipment.tracking.status.changed
shipment.cancelled
shipment.warehouse.state.updated
batch.started
batch.finished
batch.item.finished
credit.balance.low
enterprise.company.creation
Webhooks
Activate a Webhook
post
Deactivate a Webhook
post
Test a Webhook
post
List all Webhooks
get
Create a Webhook
post
Get a Webhook
get
Delete a Webhook
delete
Update a Webhook
patch
Easyship Enterprise API
Authorization
Retrieve an Access Token
post
Retrieve info for the Access Token
get
Introspect an Access Token
post
Revoke an Access Token
post
Organizations
List all Companies of the Organization
get
List all Organizations
get
Create an Organization
post
Get an Organization
get
Update an Organization
patch
Delete an organization
delete
Companies
Downgrade a Subscription
post
Create a Redirect
post
List all Companies
get
Create a Company
post
Update a Company
patch
Delete a Company
delete
Shipping Rule's Actions
Create Action for a Shipping Rule
post
List all Actions for a Shipping Rule
get
Update Action of a Shipping Rule
patch
Delete Action of a Shipping Rule
delete
Shipping Rule's Conditions
Create Condition for a Shipping Rule
post
List all Conditions for a Shipping Rule
get
Update Condition of the Shipping Rule
patch
Delete Condition of a Shipping Rule
delete
Webhooks
Activate a Webhook
post
Deactivate a Webhook
post
Test a Webhook
post
List all Webhooks
get
Create a Webhook
post
Get a Webhook
get
Update a Webhook
patch
Delete a Webhook
delete
Shipping Rules
Activate a Shipping Rule
post
Deactivate a Shipping Rule
post
List all Platform Names
get
List all Shipping Rules
get
Create a Shipping Rule
post
Get a Shipping Rule
get
Update a Shipping Rule
patch
Delete a Shipping Rule
delete
Easyship OAuth 2 API for Partners
Authorization
Authorize user on Easyship
get
Create an Access Token
post
Retrieve info for the Access Token
get
Introspect an Access Token
post
Revoke an Access Token
post
Create an Access Token
post
https://api.easyship.com/oauth2/token
Retrieve an OAuth 2 Access Token.
Language
Shell
Node
Ruby
PHP
Python
RESPONSE
Click
Try It!
to start a request and see the response here!