Articles in this section

Available Easyship APIs

When you configure an export, import, or other type of flow step using the prebuilt Easyship connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Easyship API documentation. You can also create a composite endpoint for this application in HTTP mode.

Resource

API endpoint

Export

Import

Account

Account information

X

Account: App access

Create app access

X

Account: Assets

Activate assets

X

Deactivate assets

X

List assets

X

Create asset

X

Update an asset

X

Delete asset

X

Account: Redirects

Create redirect

X

Account: Settings

List account settings

X

Update multiple account settings

X

Addresses

Validate single address

X

List addresses

X

Create address

X

Update an address

X

Activate address

X

Deactivate address

X

Validate single domestic (US) address

X

Analytics

List analytics sale channels data

X

List analytics shipment status data

X

List shipment analytics within a date range

X

List analytics shipments data

X

List analytics top couriers data

X

List analytics top shipments destinations

X

Auto recharge

Update auto recharge credit settings

X

Get auto recharge credit settings

X

Batches

Create batch of addresses

X

List batch items

X

Create batch of labels

X

Easyship batch shipments

X

List batches

X

Get batch

X

Billing documents

Download billing document

X

List billing documents

X

List billing document's transaction records

X

Boxes

List boxes

X

Create box

X

Update box

X

Delete box

X

Categories

Item categories

X

Countries

List countries

X

Courier services

List estimated delivery dates for courier service

X

List available pickup slots

X

List courier services

X

Couriers

List courier services of a courier

X

List LYOC

X

List couriers

X

Create courier

X

Get courier

X

Update courier

X

Delete courier

X

Credit

Confirm credit top up

X

Refund credit

X

Get credit

X

Add credit

X

E-fulfillment

Tracking updates

X

Warehouse state updates

X

HS codes

List HS codes

X

Insurance

List insurance policies

X

Create insurance policy

X

Item categories

List item categories

X

Labels

Confirm and buy labels

X

Locations

List FedEx locations

X

List UPS locations

X

List USPS locations

X

List Canada Post locations

X

Manifests

List manifests

X

Create manifest

X

Get manifest

X

Payment sources

Get Stripe public key

X

Confirm payment source

X

List payment sources

X

Create payment source

X

Update payment source

X

Delete payment source

X

Pickups

Retrieve available pickup slots

X

Request pickup

X

Mark as directly handed over

X

Pickups

Cancel pickup

X

List pickups

X

Create pickup

X

Get pickup

X

List shipments of specific pickup

X

Products

List products

X

Create product

X

Delete product

X

Update product

X

Rates

Request rates and taxes

X

Request rates

X

Shipments

List shipments

X

Get shipment

X

Create shipment

X

Update shipment

X

Delete shipment

X

Update shipment's warehouse status

X

Cancel shipment

X

List documents

X

Buy insurance for shipment

X

Create return shipment

X

List trackings

X

List transaction records for shipment

X

List unavailable couriers for shipment

X

List shipments

X

Easyship shipments API

X

Get shipment

X

Update shipment

X

Delete shipment

X

Shipping rule's actions

Create action for shipping rule

X

List actions for shipping rule

X

Update action of a shipping rule

X

Delete action of a shipping rule

X

Shipping rule's conditions

Create condition for shipping rule

X

List conditions for shipping rule

X

Update condition of the shipping rule

X

Delete condition of a shipping rule

X

Shipping rules

Activate shipping rule

X

Deactivate shipping rule

X

List platform names

X

List shipping rules

X

Create shipping rule

X

Get shipping rule

X

Update shipping rule

X

Delete shipping rule

X

States

List states

X

Stores

List stores

X

Tags

List tags

X

Create tag

X

Taxes and duties

Calculate tax and duty

X

Tracking

Status

X

Checkpoints

X

Trackings

Update tracking

X

List of supported couriers

X

List of supported couriers

X

List trackings

X

Create tracking

X

Delete tracking

X

Get tracking

X

Transaction records

List transaction records

X