Jump to Content
API Reference
Docs
Docs
Samples
API Reference
v2023.01
v2024.09
API Reference
Docs
Dashboard
API Reference
Dashboard
2024-09
Docs
Samples
API Reference
Webhooks Guide
All
Pages
Start typing to search…
JUMP TO
API
Overview
Changelog
Migration guide from 2023-01
Errors
Authentication
Scopes
Rate Limit
Idempotent Requests
Migration Guide: V1 to 2024-09
Easyship Public API
Account
Information about the Account
get
Assets
Activate Assets
post
Deactivate Assets
post
List all Assets
get
Create an Asset
post
Update an Asset
patch
Delete an Asset
del
Settings
List Account Settings
get
Update Multiple Account Settings
post
App Access
Create an App Access
post
Redirects
Create a Redirect
post
Addresses
Validate a single address
post
List all Addresses
get
Create an Address
post
Update an Address
patch
Activate an Address
post
Deactivate an Address
post
Validate a single domestic (US) address
post
Analytics
List Analytics Sale Channels Data
get
List Analytics Shipment Status Data
get
List Shipment Analytics within a Date Range
get
List Analytics Shipments Data
get
List Analytics Top Couriers Data
get
List Analytics Top Shipments Destinations
get
Auto Recharge
Update Auto Recharge Credit Settings
patch
Get Auto Recharge Credit Settings
get
Batches
Create a Batch of Addresses
post
List all Batch Items
get
Create a Batch of Labels
post
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
del
Countries
List all Countries
get
Couriers
List all Courier Services of a Courier
get
List all LYOC
get
List all Couriers
get
Create a Courier
post
Get a Courier
get
Update a Courier
patch
Delete a Courier
del
Courier Services
List all Estimated Delivery Dates for a Courier Service
get
List Available Pickup Slots
get
List all Courier Services
get
Credit
Confirm Credit Top-up
post
Refund a Credit
post
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
Locations
List FedEx Locations
get
List UPS Locations
get
List USPS Locations
get
List Canada Post Locations
get
Manifests
List all Manifests
get
Create a Manifest
post
Get a Manifest
get
Payment Sources
Get a Stripe Public Key
get
Confirm Payment Source
post
List all Payment Sources
get
Create a Payment Source
post
Update a Payment Source
patch
Delete a Payment Source
del
Pickups
Cancel a Pickup
post
List all Pickups
get
Create a Pickup
post
Get a Pickup
get
List All Shipments of Specific Pickup
get
Products
List all Products
get
Create a Product
post
Delete a Product
del
Update a Product
patch
Rates
Request Rates
post
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
del
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
del
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
del
Shipments
Cancel a Shipment
post
List All Documents
get
Buy Insurance for a Shipment
post
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
del
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
Trackings
Update a tracking
patch
List of Supported Couriers
get
List of Supported Couriers
get
List all Trackings
get
Create a Tracking
post
Delete a Tracking
del
Get a Tracking
get
Transaction Records
List all Transaction Records
get
Insurance
List all Insurance Policies
get
Create an Insurance Policy
post
Webhooks
Webhooks Guide
Webhook Events
shipment.label.created
shipment.label.failed
shipment.tracking.checkpointscreated
shipment.tracking.statuschanged
shipment.cancelled
shipment.warehouse.stateupdated
batch.started
batch.finished
batch.item.finished
credit.balance.low
enterprise.company.creation
external.shipment.insured
courier.state.changed
oauth.authorization.revoked
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
del
Update a Webhook
patch
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
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
Companies
Downgrade a Subscription
post
List all Companies
get
Create a Company
post
Update a Company
patch
Delete a Company
del
Create a Company Onboarding
post
Get a Company Onboarding
get
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
del
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
del
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
del
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
del
Powered by
Webhooks Guide
Ask AI
