AfterShip Integration

AfterShip enables tracking the delivery status and sends callbacks to Paymonix whenever there is a status update. For each callback received, Paymonix sends an event through the mailer with the name of the new status. In addition, if the status is “Shipped” or "Delivered," the order status is updated accordingly in Paymonix.

AfterShip ↔ Paymonix

What it does & how to connect
 ⏱ Time to complete: ~5–10 minutes

What the AfterShip connection does

When you connect AfterShip to Paymonix:

• Live updates in Paymonix
  Shipment status (In transit, Out for delivery, Delivered, Exception) appears on your order events inside Paymonix.

• Customer notifications
  Paymonix can use AfterShip updates to trigger shipment emails/notifications/tracking page URLs to the ESP you’ve enabled within your Paymonix account. For the full list of tracking update events Paymonix can send to your ESP, see the Email Events Reference.
  

• Order Status Updates
  Orders in Paymonix will be updated to ‘Shipped’ or ‘Delivered’ based on AfterShip updates.
  
  

Paymonix developers maintain the backend connector. You only need to set up your Tracking API, Webhook details, and (optionally) your tracking landing page for customers.

Before you start

• Access to AfterShip Admin (owner or admin).
  

• Access to Paymonix with permission to view Store Settings.
  
  

Step-by-step: Connect AfterShip to Paymonix

1) Add (or update) a webhook in AfterShip

1. Sign in to AfterShip Admin.
   

2. Go to Tracking → Notifications → Webhooks.
   

3. Add a webhook (or edit your existing Paymonix webhook with the proper endpoint routing callback/aftership/new).
   

   • Webhook URL example:
     

     • https://your-paymonix-pay-url.com/callback/aftership/new
       
       
4. In Version, choose: 2025-07.
   

5. Select All status updates (or equivalent) under Shipment status in Events.
   

6. Click Save and if a new webhook was made, copy your Webhook Secret to a safe place.
   
   

2) Create or update your Tracking API Key

1. In AfterShip, go to Integrations → Developers → API Keys.
   

2. Create a new key or confirm your existing API key is on the newest version.
   

   • If the key label says “Legacy Tracking API access only”, that key will not work with the versioned API. A new key must be created.
     

3. Confirm the key settings:
   

   • Name: Paymonix AfterShip Tracking API (example)
     

   • Signature Header: API Key
     

   • Tracking: Default Settings
     

4. Save, and copy your API key to a safe place.
   
   

3) Create your tracking landing page

By creating a tracking page within AfterShip and connecting it to Paymonix, you can send customers a tracking page link with their tracking number automatically filled in.

Steps:

1. In AfterShip, go to Tracking → Tracking Pages.
   

2. Set up the tracking page for tracking number input.
   

3. Save the page.
   

4. Go to Tracking → Tracking Pages → URLs and domain.
   

5. Copy and save your universal default domain (example: https://yourdomain.aftership.com/).
   
   

4) Enable AfterShip in Paymonix

1. In Paymonix, go to Settings → Store Settings → AfterShip.
   

2. Toggle Enable AfterShip on.
   

3. Paste your API key, Webhook Secret, and Tracking URL.
   

4. Save settings.
   
   

5) Test the connection

• In AfterShip, send a test webhook (if available) or update a shipment status (e.g., moves to In transit).
  

• In Paymonix, open a recent order and confirm AfterShip order events display as success.
  

• In Paymonix, open a recently shipped or delivered order and confirm the order status updated.
  

• If you use shipment emails/notifications in Paymonix, verify the message was sent or queued.
  
  

Ongoing maintenance

If you rotate secrets, API keys, or change your Paymonix pay URL, update the settings in your Paymonix → AfterShip connection.

Troubleshooting

No updates appear in Paymonix

• Confirm the Webhook URL is exactly your Paymonix pay URL ending in /callback/aftership/new.
  

• In AfterShip, make sure your API key is not on a legacy version.
  

• In AfterShip, make sure the webhook is enabled and version is 2025-07.
  

FAQ

Does Paymonix change the data from AfterShip?
 No. Paymonix displays shipment events and statuses sent by AfterShip.

Will shipment updates send to Paymonix automatically?
 Yes. Once connected, status changes that AfterShip receives will flow into Paymonix in near real-time. You will see these updates in order events.

Who can help if we get stuck?
 Your Paymonix Customer Success Manager can confirm your connection and run validation testing with you.