AfterShip

Aftership is a shipment tracking platform designed such that it can be integrated into your company’s website as a branded tracking page. It provides your customers with real-time updates about their orders and when they are expected to be delivered. Aftership reduces your logistics-related workload by automatically monitoring the status of an order and sending updates to your customers as soon as an order status changes. Additionally, it provides you with analytical reports on the number of orders shipped, delivered, lost, and so on, to identify any problems in your delivery system.

You can replicate the data from your Aftership account to a Destination database or data warehouse using Hevo Pipelines. Hevo ingests the data objects in Full Load mode. Refer to section, Data Model for the list of supported objects.

Aftership uses API keys to identify Hevo and authorize the request for accessing account data.


Prerequisites

  • An active AfterShip account from which data needs to be ingested.

  • An API key is available to authenticate Hevo on your AfterShip account. You can obtain the API key from your administrator.

  • You are logged in as an Administrator user, in case you need to generate the API key.


Obtaining the API Key

The API keys you generate in AfterShip do not expire. Therefore, you can use an existing key or create a new one to authenticate Hevo on your AfterShip account.

Note: You must be logged in as an Admin user to obtain the API key.

To retrieve the API key:

  1. Log in to your AfterShip account.

    AfterShip login

  2. In the left navigation pane, click Settings.

    AfterShip Settings

  3. In the Settings page, under Feature settings, click API keys.

    AfterShip API Keys

  4. In the API keys page, do one of the following:

    • Create an API key:

      1. Click Generate API key.

        Generate API Keys

      2. Provide a Description for the API key that helps you easily identify it later.

      3. Click Generate API key. The new key is added to the API keys list on the UI.

      4. Click the View ( View icon ) icon in the desired key description row to reveal the key.

        AfterShip view API keys

    • Use an existing API key:

      1. Click the View ( View icon ) icon in the desired key description row to reveal the key.

        AfterShip view API keys

  5. Copy the API key and save it securely like any other password.


Configuring AfterShip as a Source

Perform the following steps to configure AfterShip as the Source in your Pipeline:

  1. Click PIPELINES in the Asset Palette.

  2. Click + CREATE in the Pipelines List View.

  3. In the Select Source Type page, select AfterShip.

  4. In the Configure your AfterShip Source page, specify the following:

    AfterShip Source settings

  5. Click TEST & CONTINUE.

  6. Proceed to configuring the data ingestion and setting up the Destination.


Data Replication

Default Pipeline Frequency Minimum Pipeline Frequency Maximum Pipeline Frequency Custom Frequency Range (Hrs)
1 Hr 1 Hr 24 Hrs 1-24

Note: You must set the custom frequency in hours as an integer value. For example, 1, 2, 3 but not 1.5 or 1.75.

Hevo fetches all the objects in Full Load mode in each run of the Pipeline.


Source Considerations

  • Pagination: An API response for each AfterShip object includes one page with up to 200 records.

  • Rate Limit: AfterShip imposes a limit of a maximum of 10 API calls per second per account to optimize performance.

Schema and Primary Keys

Hevo uses the following schema to upload the records in the Destination:


Data Model

The following is the list of tables (objects) that are created at the Destination when you run the Pipeline:

Object Description
Couriers Contains the list of all couriers activated by your customer, along with information such as the name, phone number, and web URL of each courier.
Trackings Contains the information related to a shipment, such as the tracking number, origin, destination, and delivery time.

Limitations

  • Hevo currently does not support deletes. Therefore, any data deleted in the Source may continue to exist in the Destination.

  • The data is loaded in Full Load mode in each Pipeline run. As a result, you cannot load the historical data alone at any time.


Revision History

Refer to the following table for the list of key updates made to this page:

Date Release Description of Change
Jun-21-2022 1.91 New document.
Last updated on 29 Jun 2022