Aftership

AfterShip is an AI-powered post-purchase platform for eCommerce businesses, providing shipment tracking, delivery notifications, returns management, and customer engagement tools to enhance the end-to-end customer experience.

Power end-to-end data operations for your Aftership API with Nexla. Our bi-directional Aftership connector is purpose-built for Aftership, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Aftership or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Aftership workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

• Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
• Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
• API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
• Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating an Aftership credential in Nexla, you need to obtain your API key from your Aftership account. This credential authenticates Nexla with the Aftership API and should be kept secure.

1. Sign in to your Aftership account.

2. Navigate to Settings in your Aftership account to access the settings page.

3. Click on API in the settings menu to access the API settings page.

4. Locate your API Key in the API settings section. The API key is a secret token that authenticates API requests and provides access to your Aftership account data. The API key is sent in the aftership-api-key header for all API requests.

   Your API key provides full access to your Aftership account data through the API. Keep your API key secure and do not share it publicly or commit it to version control systems. If you suspect your API key has been compromised, regenerate it immediately in your Aftership account settings. For detailed information about Aftership API authentication, see the Aftership API documentation.

Authenticate

Credentials required

Field	Required	Secret	Description
API Key	Yes	Yes	Your Aftership API Key. You can find it in your Aftership Account under Settings > API

Create a credential in Nexla

1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Aftership

2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

3. Enter your Aftership API key in the API Key field. This key authenticates Nexla with the Aftership API and should match the API key obtained from your Aftership account settings. The API key is sent in the aftership-api-key header for all API requests.

   The API key provides full access to your Aftership account data through the API. Keep your API key secure and do not share it publicly or commit it to version control systems. Aftership uses the API key in the aftership-api-key header for authentication, which allows Nexla to make authenticated requests to your account.

4. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Aftership connector tile, then select the credential that will be used to connect to the Aftership instance, and click Next; or, create a new Aftership credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Aftership endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

Get Activated Couriers.

This endpoint retrieves a list of couriers that have been activated in your Aftership account. Use this endpoint when you need to access information about the shipping carriers configured in your account.

• This endpoint automatically retrieves all activated couriers from your Aftership account. No additional configuration is required beyond selecting this endpoint template.
• The endpoint returns courier information including courier names, tracking numbers, and activation status.

For detailed information about retrieving activated couriers, see the Aftership API documentation.

Get All Couriers.

This endpoint retrieves a list of all available couriers supported by Aftership. Use this endpoint when you need to access information about all shipping carriers available in the Aftership system, regardless of activation status.

• This endpoint automatically retrieves all available couriers from Aftership. No additional configuration is required beyond selecting this endpoint template.
• The endpoint returns comprehensive courier information including courier names, tracking capabilities, and availability across different regions.

For detailed information about retrieving all couriers, see the Aftership API documentation.

Get Trackings

This endpoint retrieves tracking results for multiple shipments. Use this endpoint when you need to access tracking information for shipments in your Aftership account.

• This endpoint uses page-based pagination, automatically fetching additional pages as needed. By default, the endpoint retrieves up to 200 trackings per page, starting from page 1.
• The endpoint will return tracking information including shipment status, location updates, delivery estimates, and other relevant tracking data.

This endpoint supports pagination through page and limit parameters. Nexla automatically handles pagination to retrieve all available trackings. For detailed information about retrieving trackings, see the Aftership API documentation.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Aftership data sources can also be manually configured to ingest data from any valid Aftership API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Aftership API endpoints typically follow the pattern https://api.aftership.com/v4/{endpoint_path}. For responses that nest the relevant records inside a data object—for example, a trackings array—enter the corresponding path (e.g., $.data.trackings[*]) in the Set Path to Data in Response field. For a complete list of available Aftership API endpoints, see the Aftership API documentation.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Aftership data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the Aftership destination, and select the Send to Destination option from the menu. Select the Aftership connector from the list of available destination connectors, then select the credential that will be used to connect to the Aftership organization, and click Next; or, create a new Aftership credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Aftership endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

Create Trackings

This endpoint creates new tracking records in your Aftership account. Use this endpoint when you need to add shipment tracking information to your Aftership account from your Nexset data.

• The endpoint will send the Nexset data as JSON in the request body to create tracking records. Ensure your Nexset contains all required fields for tracking creation, including tracking number, courier information, and shipment details.
• Each record in the Nexset will be sent as a separate API request to create a new tracking in your Aftership account.
• The response will include the created tracking information including tracking ID, status, and other relevant details.

The request body must contain valid JSON with all required fields for tracking creation. For detailed information about required fields and data formats, see the Aftership API documentation.

Manual configuration

Aftership destinations can also be manually configured to send data to any valid Aftership API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Aftership API endpoints typically expect JSON format for request bodies and follow the pattern https://api.aftership.com/v4/{endpoint_path}. For update/upsert operations, include the ID of the object to be updated at the end of the URL.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Aftership endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Aftership endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.