Skip to main content

Aftership Connector

The Aftership connector allows you to manage your shipment tracking operations directly within your application. By integrating the Aftership API, you can automate tracking, updating, and retrieving tracking details for your shipments.

Getting Started​

Before you can start using the Aftership connector, ensure you have completed the following prerequisites.

Prerequisites​

  • Aftership Account: You need an Aftership account. If you don’t have one, sign up at aftership.com.
  • API Key: Retrieve your Aftership API key by following the steps in the Aftership API documentation.

Supported Authentication Method​

The Aftership connector supports the following authentication method:

  • API Key Authentication: Use your Aftership API key to authenticate your requests.

Basic Operations​

With the Aftership connector, you can perform the following operations:

Tracking Management​

  • Create Tracking: Create a new tracking record for a shipment.
  • Get Tracking: Retrieve tracking details for an existing tracking record.
  • Update Tracking: Update the tracking number for an existing tracking record.
  • Delete Tracking: Delete a tracking record from your Aftership account.
  • Get All Trackings: Retrieve a list of all tracking records, with optional limits on results.

Operation Details​

Create Tracking​

This operation creates a new tracking record in Aftership.

Parameters​

  • Tracking Number (required): Enter the tracking number for the shipment.
  • Carrier (required): Select the carrier handling the shipment, such as FedEx, UPS, DHL, or USPS.
  • Title (required): Provide a title for the tracking entry.
  • Order ID (optional): Enter the order ID associated with the tracking.
  • Delivery Type (optional): Specify the delivery type, such as "Door to Door" or "Pickup at Store".
  • Tracking Ship Date (optional): The date when the shipment was sent.
  • Order Promised Delivery Date (optional): The promised delivery date for the order (format: YYYY-MM-DD).
  • Emails (optional): Email addresses to receive notifications about the tracking.

Get Tracking​

This operation retrieves details about a specific tracking record.

Parameters​

  • Tracking Number (required): Enter the tracking number for the shipment to retrieve.

Update Tracking​

This operation updates the tracking number for an existing shipment record.

Parameters​

  • Tracking Number (required): Enter the current tracking number of the shipment.
  • New Tracking Number (required): Provide the new tracking number for the shipment.

Delete Tracking​

This operation deletes an existing tracking record from Aftership.

Parameters​

  • Tracking Number (required): Enter the tracking number for the shipment you want to delete.

Get All Trackings​

This operation retrieves a list of all tracking records, with the ability to limit the number of results.

Parameters​

  • Limit (optional): Specify the maximum number of tracking records to return (defaults to 100, max 200).

Conclusion​

The Aftership connector is a valuable tool for tracking shipments and managing logistics. By following the steps above, you can start using Aftership to track and update shipments seamlessly. For more details, refer to the Aftership API Documentation.