Articles in this section

Set up a connection to AfterShip

Naga Sri Hari Gonaboyina
Updated

AfterShip provides a world-class post-purchase experience through automated shipping, branded order tracking, proactive messaging, and seamless returns.

Set up a connection

After you start the connection, configure it in the Create connection panel and complete all of the required * authentication settings:

Setting

Instructions

Name your connection * 

Enter a clear and distinguishable name. Throughout integrator.io imports and exports, you will have the option to choose this new connection. A unique identifier will prove helpful later when selecting it from a list of the connections in your account.

API type * 

Choose your AfterShip API type:

  • Returns: Manage return requests, statuses, and labels to streamline the post-purchase experience and automate return workflows for shoppers and support teams.

  • Shipping: Get shipping rates, generate labels, and schedule pickups across multiple carriers to optimize order fulfillment and reduce logistics complexity.

  • Tracking: Track shipments from 1,000+ carriers globally to keep customers informed, reduce WISMO inquiries, and power proactive delivery updates.

  • Address: Validate and autocomplete shipping addresses to reduce failed deliveries, improve checkout accuracy, and enhance customer satisfaction.

  • Parser: Extract structured order data from unformatted shipping emails to centralize tracking across platforms without manual input.

  • Members: Manage member profiles and preferences to personalize the post-purchase journey and offer tailored notifications and self-service experiences.

  • Commerce: Sync product, order, and customer data from eCommerce platforms to enable unified tracking, returns, and customer engagement flows.

  • Protection: Offer shipping protection services during checkout to insure packages and streamline claims for lost, stolen, or damaged items.

The following setting is common for all API types

API key * 

Enter your AfterShip API key.

Multiple layers of protection, including AES 256 encryption, are in place to keep your API key safe. When editing this connection, you must re-enter this value each time; it is stored only when the connection is saved and never displayed as text.

dataLoad.svg​​ How to retrieve the API key

The following setting is visible only for the Shipping and Commerce API types

Environment * 

Select your AfterShip account environment type:

  • Production: if your AfterShip account URL is https://api.aftership.com

  • Sandbox: if your AfterShip account URL is https://sandbox-api.aftership.com 

API key * 

Enter your AfterShip API key.

Multiple layers of protection, including AES 256 encryption, are in place to keep your API key safe. When editing this connection, you must re-enter this value each time; it is stored only when the connection is saved and never displayed as text.

dataLoad.svg​​ How to retrieve the API key

AS store ID * 

Enter your AfterShip store ID. For detailed information on how to generate the store ID, See Create AS store ID.

Tip

This connector documentation describes only the settings shown for the Simple view. For the corresponding HTTP settings, see the Token auth universal connector documentation.

How to retrieve the API key

  1. Sign in to your AfterShip account.

  2. Navigate to Settings > API keys.

  3. Click Create API key.

  4. Enter a Name.

  5. Select the API key as the Signature header.

  6. Provide the API permissions as required.

  7. Click Save.

  8. Copy the API key.

Additional references