Aftership
Aftership is a shipment tracking application and API for eCommerce retailers and buyers.
Aftership integration replicates data using the Aftership Tracking, Returns and Shipping API.
See the Schema section for a list of objects available for replication.Preparing for authentication
To access your data, you need to authenticate the connection with your account credentials.
To create your API key:
- Log into your Aftership account.
- Navigate to Developers > API keys > Create API key.
- Enter the following information:
- Name: Enter a name for your API key.
- Signature Header: Select API key.
- API permissions: Select Read permission for all scopes, except for Tracking - Estimated delivery dates, where only Write permission is available.
- Click Save.
- Copy and paste your API key into a secured file.
Creating the connection
For more information, see Connecting to SaaS applications.
- Fill in the required connection properties.
Provide a name for the connection in Connection name.
Select Open connection metadata to define metadata for the connection when it has been created.
Click Create.
| Setting | Description |
|---|---|
| Data gateway | Select a Data Movement gateway if required by your use case. Information note This field is not available with the Qlik Talend Cloud Starter subscription, as it does not support Data Movement gateway. If you have another subscription tier and do not want to use Data Movement gateway, select None. For information on the benefits of Data Movement gateway and use cases that require it, see Qlik Data Gateway - Data Movement. |
| Start Date | Enter the date, in the format |
| API Key | API key. |
Schema
Depending on your destination, table and column names may not appear as they are outlined below.
Replication of all tables and objects requires an Aftership Pro—or higher—subscription.
trackings
Replication Method | CDC |
Primary Key | id |
| Useful links |
couriers
Replication Method | Full Table |
Primary Key | id |
| Useful links |
courier_connections
Replication Method | CDC |
Primary Key | id |
| Useful links |
item_returns
Replication Method | Full Table |
Primary Key | id |
| Useful links |
item_tags
Replication Method | CDC |
Primary Key | id |
| Useful links |
query_claims
Replication Method | CDC |
Primary Key | id |
| Useful links |
query_coverages
Replication Method | CDC |
Primary Key | id |
| Useful links |
stores
Replication Method | CDC |
Primary Key | id |
| Useful links |
orders
Replication Method | CDC |
Primary Key | id |
| Useful links |
products
Replication Method | Full Table |
Primary Key | id |
| Useful links |
fulfillments
Replication Method | CDC |
Primary Key | id |
| Useful links |
memberships
Replication Method | Full Table |
Primary Key | id |
| Useful links |
roles
Replication Method | Full Table |
Primary Key | code |
| Useful links |
shipping_rates
Replication Method | CDC |
Primary Key | id |
| Useful links |
shipping_labels
Replication Method | CDC |
Primary Key | id |
| Useful links |
shipping_manifests
Replication Method | CDC |
Primary Key | id |
| Useful links |
shipping_couriers
Replication Method | Full Table |
Primary Key | slug |
| Useful links |
cancel_labels
Replication Method | CDC |
Primary Key | id |
| Useful links |
pickups
Replication Method | CDC |
Primary Key | id |
| Useful links |
cancel_pickups
Replication Method | CDC |
Primary Key | id |
| Useful links |
shipper_accounts
Replication Method | CDC |
Primary Key | id |
| Useful links |
locations
Replication Method | Full Table |
Primary Key | location_id |
| Useful links |