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: Get product return and refund details
  • Shipping: Get the shipment and delivery details
  • Tracking: Get real-time status updates of the shipment details
  • Address: Get reliable address correction service details 
  • Parser: Get logistics data from third-party emails for analysis and configuration
  • Members: Get members and different roles details
  • Commerce: Get all linked orders and product details
  • Protection: Get the store conversion rate and shopping experience details
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.

Fetch data 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 Token auth universal connector documentation.

  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

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.