> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Easyship

> How to set up the Easyship connector, plus the actions and events that are available.

![Easyship](https://stackone-logos.com/api/easyship/filled/svg)

v1.3.0[See changelog](https://docs.stackone.com/connectors/easyship/changelog.md)

[48 actions](#actions) · [14 events](#events) · 4 auth methods

Logistics

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [Access Token · Connector Profile](https://docs.stackone.com/connectors/easyship/guides/connector-profile/access-token.md)
>
> Bearer token authentication provides secure access to Easyship APIs. Generate your API access token from the Easyship da...

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/easyship/guides/connector-profile/oauth-2-0.md)
>
> Connects a merchant's own Easyship account through the Easyship partner app flow, so the merchant authorizes access inst...

> [card] [Enterprise Delegated Account · Connector Profile](https://docs.stackone.com/connectors/easyship/guides/connector-profile/enterprise-delegated-account.md)
>
> For Easyship Enterprise organizations. Mints a token bound to one child company from the organization's own OAuth client...

> [card] [Enterprise Client Credentials · Connector Profile](https://docs.stackone.com/connectors/easyship/guides/connector-profile/enterprise-client-credentials.md)
>
> For Easyship Enterprise organizations. Mints one organization-wide token from the OAuth client, then selects the child c...

Optionally, configure receiving Events for Easyship into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/easyship/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [Access Token · Link Account](https://docs.stackone.com/connectors/easyship/guides/link-account/access-token.md)

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/easyship/guides/link-account/oauth-2-0.md)

> [card] [Enterprise Delegated Account · Link Account](https://docs.stackone.com/connectors/easyship/guides/link-account/enterprise-delegated-account.md)

> [card] [Enterprise Client Credentials · Link Account](https://docs.stackone.com/connectors/easyship/guides/link-account/enterprise-client-credentials.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

Access Token

Enterprise Client Credentials

Enterprise Delegated Account

OAuth 2.0

No auth methods found

Scopes

Select all
|
Clear

enterprise.child\_company::access

public.address:read

public.address:write

public.address\_validation:write

public.asset:read

public.asset:write

public.box:read

public.box:write

public.courier:read

public.courier:write

public.courier\_service:read

public.credit:read

public.hs\_code:read

public.label:write

public.payment\_source:read

public.rate:read

public.reference:read

public.setting:read

public.shipment:read

public.shipment:write

public.store:read

public.tag:read

public.tag:write

public.track:read

public.track\_3p:read

public.track\_3p:write

public.transaction\_record:read

No scopes found

48 actions

ActionDescriptionRequired scopes

Get Account`easyship_get_account`

Retrieve information about current account

`public.address:read``public.credit:read``public.payment_source:read``enterprise.child_company::access`

Get Account Settings`easyship_get_account_settings`

Retrieve account settings

`public.setting:read``enterprise.child_company::access`

List Countries`easyship_list_countries`

Retrieve a list of countries

`public.reference:read``enterprise.child_company::access`

List All States`easyship_list_states`

Retrieve a list of states

`public.reference:read``enterprise.child_company::access`

List All Addresses`easyship_list_addresses`

Retrieve a list of all addresses ordered by date of creation

`public.address:read``enterprise.child_company::access`

Validate A Single Address`easyship_validate_address`

Create an address validation for international addresses

`public.address_validation:write``enterprise.child_company::access`

Create An Address`easyship_create_address`

Create a new address

`public.address:write``enterprise.child_company::access`

Update An Address`easyship_update_address`

Update an address in your account

`public.address:write``enterprise.child_company::access`

Activate An Address`easyship_activate_address`

Activate specific address

`public.address:write``enterprise.child_company::access`

Deactivate An Address`easyship_deactivate_address`

Deactivate specific address

`public.address:write``enterprise.child_company::access`

Validate A Single Domestic (US) Address`easyship_validate_domestic_address`

Create a domestic address validation for US addresses

`public.address_validation:write``enterprise.child_company::access`

Create Asset`easyship_create_asset`

Upload a new asset

`public.asset:write``enterprise.child_company::access`

List Assets`easyship_list_assets`

Retrieve a list of assets

`public.asset:read``enterprise.child_company::access`

Update Asset`easyship_update_asset`

Update an existing asset

`public.asset:write``enterprise.child_company::access`

Delete Asset`easyship_delete_asset`

Delete an asset

`public.asset:write``enterprise.child_company::access`

Deactivate Asset`easyship_deactivate_asset`

Deactivate a specific asset

`public.asset:write``enterprise.child_company::access`

Activate Asset`easyship_activate_asset`

Activate a specific asset

`public.asset:write``enterprise.child_company::access`

List All Boxes`easyship_list_boxes`

Retrieve a list of available courier boxes and your custom boxes

`public.box:read``enterprise.child_company::access`

Create A Box`easyship_create_box`

Create a box

`public.box:write``enterprise.child_company::access`

Update A Box`easyship_update_box`

Update a box in your account

`public.box:write``enterprise.child_company::access`

Delete A Box`easyship_delete_box`

Delete a box from your account

`public.box:write``enterprise.child_company::access`

List All Couriers`easyship_list_couriers`

Retrieve a list of active couriers

`public.courier:read``enterprise.child_company::access`

Create A Courier`easyship_create_courier`

Create a new courier account

`public.courier:write``enterprise.child_company::access`

Get A Courier`easyship_get_courier`

Retrieve details of a courier

`public.courier:read``enterprise.child_company::access`

Delete A Courier`easyship_delete_courier`

Delete a LYOC courier

`public.courier:write``enterprise.child_company::access`

List All Courier Services Of A Courier`easyship_list_courier_services`

Retrieve a list of courier services for selected courier

`public.courier_service:read``enterprise.child_company::access`

List All LYOC`easyship_list_lyoc`

Retrieve a list of available LYOC

`public.courier:read``enterprise.child_company::access`

Create Label`easyship_create_label`

Create a new label for an existing shipment

`public.label:write``enterprise.child_company::access`

Create Shipment`easyship_create_shipment`

Create a new shipment

`public.shipment:write``enterprise.child_company::access`

List Shipments`easyship_list_shipments`

Retrieve a list of shipments with optional filters

`public.shipment:read``enterprise.child_company::access`

Get Shipment`easyship_get_shipment`

Retrieve details of a specific shipment

`public.shipment:read``enterprise.child_company::access`

Update Shipment`easyship_update_shipment`

Update shipment details

`public.shipment:write``enterprise.child_company::access`

Delete Shipment`easyship_delete_shipment`

Delete a shipment that has not yet been shipped

`public.shipment:write``enterprise.child_company::access`

List All Trackings`easyship_list_all_trackings`

Retrieve tracking status and checkpoint history for shipments

`public.track:read``enterprise.child_company::access`

List Transaction Records For A Shipment`easyship_list_transaction_records`

List transaction records for a specific shipment

`public.transaction_record:read``enterprise.child_company::access`

List Unavailable Couriers For A Shipment`easyship_list_unavailable_couriers`

List unavailable couriers and reasons for a specific shipment

`public.shipment:read``public.rate:read``enterprise.child_company::access`

Cancel A Shipment`easyship_cancel_shipment`

Cancel a shipment that has been shipped

`public.shipment:write``enterprise.child_company::access`

List All Item Categories`easyship_list_item_categories`

Retrieve a list of item categories

`public.reference:read``enterprise.child_company::access`

List HS Codes`easyship_list_hs_codes`

Retrieve a list of HS codes

`public.hs_code:read``enterprise.child_company::access`

List All Stores`easyship_list_stores`

Retrieve a list of stores

`public.store:read``enterprise.child_company::access`

List All Tags`easyship_list_tags`

Retrieve a list of tags

`public.tag:read``enterprise.child_company::access`

Create A Tag`easyship_create_tag`

Create a new tag

`public.tag:write``enterprise.child_company::access`

List All Trackings`easyship_list_trackings`

Retrieve a list of trackings available with your account

`public.track_3p:read``enterprise.child_company::access`

Get A Tracking`easyship_get_tracking`

Show a single tracking in your account

`public.track_3p:read``enterprise.child_company::access`

Delete A Tracking`easyship_delete_tracking`

Delete a single tracking from your account

`public.track_3p:write``enterprise.child_company::access`

Create A Tracking`easyship_create_tracking`

Create a single tracking in your account

`public.track_3p:write``enterprise.child_company::access`

List Supported Couriers`easyship_list_supported_couriers`

List supported couriers for tracking

`public.track_3p:read``enterprise.child_company::access`

List External Courier Services`easyship_list_external_courier_services`

List courier services that do not support label generation but are trackable

`public.track_3p:read``enterprise.child_company::access`

## Events

Tags

Select all
|
Clear

Authorizations

Batches

Couriers

Credits

Insurance

Labels

Shipments

Trackings

Webhooks

No tags found

14 events

EventDescriptionTags

Active Check`easyship_webhook_active_check`

Acknowledges Easyship health-check pings. Returns 200 OK to confirm the webhook endpoint is reachable.

Webhooks

Shipment Label Created`easyship_webhook_shipment_label_created`

Fired when a shipping label is successfully generated for a shipment.

ShipmentsLabelsWebhooks

Shipment Label Failed`easyship_webhook_shipment_label_failed`

Fired when label creation fails for a shipment.

ShipmentsLabelsWebhooks

Shipment Tracking Checkpoint Created`easyship_webhook_shipment_tracking_checkpoints_created`

Fired when a new tracking checkpoint is recorded for a shipment.

ShipmentsTrackingsWebhooks

Shipment Tracking Status Changed`easyship_webhook_shipment_tracking_status_changed`

Fired when the overall tracking status of a shipment changes.

ShipmentsTrackingsWebhooks

Shipment Cancelled`easyship_webhook_shipment_cancelled`

Fired when a shipment is cancelled.

ShipmentsWebhooks

Shipment Warehouse State Updated`easyship_webhook_shipment_warehouse_state_updated`

Fired when the warehouse state of a shipment changes.

ShipmentsWebhooks

Batch Started`easyship_webhook_batch_started`

Fired when the first shipment in a batch is processed.

BatchesWebhooks

Batch Finished`easyship_webhook_batch_finished`

Fired when the last shipment in a batch is processed, marking batch completion.

BatchesWebhooks

Batch Item Finished`easyship_webhook_batch_item_finished`

Fired when an individual shipment within a batch finishes processing.

BatchesWebhooks

Credit Balance Low`easyship_webhook_credit_balance_low`

Fired when the account credit balance falls below the configured threshold.

CreditsWebhooks

Courier Account State Changed`easyship_webhook_courier_account_state_changed`

Fired when a courier's activation state changes on the account.

CouriersWebhooks

External Shipment Insured`easyship_webhook_external_shipment_insured`

Fired when an external shipment is insured.

ShipmentsInsuranceWebhooks

OAuth Authorization Revoked`easyship_webhook_oauth_authorization_revoked`

Fired when OAuth authorization for an application is revoked.

AuthorizationsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.