AfterShip

AfterShip integration

Quick Summary: Connect your AfterShip account and send eligible order tracking information there. For: Clients Level: Beginner

Overview

The AfterShip integration connects an AfterShip Tracking account to FedEx. While it is Active, eligible orders send their tracking number and related shipment data to AfterShip.

An Active status shows that delivery is enabled in FedEx. It does not prove that AfterShip accepted the API key or that a particular shipment was received.

Before you connect

  • Your AfterShip plan must include Tracking API access. AfterShip currently lists this access from Premium and higher in its plan guide.
  • Your user needs access to Integrations. Adding or changing a connection also requires write access.
  • Have the AfterShip Tracking API key available. Do not use a key from another AfterShip product.

Getting your AfterShip API key

In AfterShip, open Settings > API keys. Select Create API key, enter a name, set the required API permissions, and save it. Copy the generated key and store it securely.

The Portal accepts Tracking API keys that begin with asat_. It rejects other key formats when you save the connection.

Quick start

In the username menu at the top right, select Account Management, then select Integrations.

  1. Select + or Add New Integration.
  2. In New Integration, open Tracking and select Aftership.
  3. Enter the Tracking API key in API Key.
  4. Optionally enter a Tracking URL containing {tracking_number}.
  5. Select Save.
  6. Confirm that the Aftership card appears with status Active.

Saving checks the fields and stores the connection. It does not test the credentials against AfterShip.

Integration settings

Setting What it controls
API Key Required when adding a connection. After saving, the key is not displayed. Type a new asat_ key only when you need to replace the saved key.
Tracking URL Optional link for the tracking number. It must contain {tracking_number}. Leave it blank to use another configured tracking page or the courier link.
Status Active sends future eligible tracking to AfterShip. Inactive stops future delivery from this connection. Select Save after changing it.

Only a user with write access sees Save. The saved key remains blank when the connection is reopened; this is expected.

Optional: custom tracking URL

Enter a complete URL and include the literal placeholder:

https://tracking.example.com/{tracking_number}

The Portal replaces {tracking_number} with the shipment's tracking number. A blank Tracking URL does not create an AfterShip tracking link. The order then uses another configured tracking page or its courier link.

An active branded tracking page or configured custom tracking URL takes priority over the AfterShip Tracking URL. See Embedded Forms.

How tracking delivery works

FedEx sends tracking to each active AfterShip connection when eligible shipment tracking becomes available or changes. The order must have a supported tracking number and courier mapping. White-label and ineligible order types are skipped.

AfterShip controls the tracking page and customer notifications that it produces. Configure those features in your AfterShip account.

Repeated authentication, access, or account-plan failures can make the connection Inactive. Review FedEx notifications and the connection status before replacing credentials.

Troubleshooting

Issue Cause Solution
Save is unavailable Your user has view-only integration access Ask your company administrator for integration write access.
API Key is rejected The value is not a current Tracking API key Create a Tracking API key beginning with asat_, then enter it in API Key.
Tracking URL is rejected The URL lacks {tracking_number} Add the literal placeholder to a complete URL, then select Save.
API Key is blank on a saved connection Stored credentials are hidden after saving Leave it untouched to keep the saved key, or enter a new key to replace it.
Status is Active, but AfterShip has no tracking The key, API access, courier mapping, or shipment eligibility may be missing Correct the AfterShip details, save a replacement key if needed, then check an existing eligible shipment.
The order tracking link opens the courier page This AfterShip connection has no Tracking URL, or another branded page takes priority Set a valid AfterShip Tracking URL or review the active tracking page settings.
The connection becomes Inactive Someone disabled it, or repeated provider failures stopped delivery Correct the AfterShip account or key, set Status to Active, and select Save.

Related Articles