ShipEngine

The Lyftron Provider for ShipEngine offers the most natural way to access ShipEngine data from Lyftron with ease and also enables to connect with BI, MDM & ML tools, Data warehouses, Databases and other SAAS based applications with zero code and zero infrastructure requirements. The provider wraps the complexity of accessing ShipEngine data into easy-to-integrate relational fully managed ANSI Sql format. Make faster and better business decisions with Lyftron’s ShipEngine data provider and automatically build your data migration pipelines in minutes, not months

The provider hides the complexity of accessing data and provides additional powerful security features, smart caching, batching, socket management, and more.

Key Features

• Comprehensive Delta load mechanism.
• Real-time access to ShipEngine.
• Comprehensive full support of ANSI Sql to query data with ease.
• Collaborative query processing.

Prerequisites

The user must have credentials for ShipEngine, Lyftron and your destination data warehouse, lake or database to perform the data pipeline operation with Lyftron

Establishing a Connection with Lyftron's Quickstart Steps

Create your ShipEngine connection with Lyftron by following the 5 easy steps show below:

Step1. Add your connection

Click on Connect section on the left panel →  Click on Add Connection button

Step2. Select your connector

In the connector selection panel, search and click ShipEngine for your connection 

Step3. Enter your connection details

In the Connection String section enter the values of the below parameters. The following connection string is required to establish ShipEngine connection with Lyftron.

Profile=C:\profiles\ShipEngine.apip;ProfileSettings='APIKey=[your_api_key]';

Key	Value	Field
Connection Name	Enter your connection details	Required
Profile	C:\profiles\ShipEngine.apip	Required
Api-Key	Your ShipEngine api_key	Required
Logfile**	Use the logfile option to debug your job and provide your connection name to generate the log file.  [ConnectionConfigurationPath]\Connection_name_log.tx	Optional
Verbosity**	Choose verbosity 1-5 based on the severity of debugging	Optional

** For more information, check the Lyftron logging and debugging section.

If you want more detailed information about how to establish a connection with Lyftron, click on Lyftron Connection Quick Start guide.

Step4. Test your connection

Once you are done entering your connection details, simply click on the Test Connection button to test the connectivity. In case your connection fails, add Logfile and Verbosity parameters and check the Lyftron logging and debugging section, to debug the error.

Step5. Save your connection

Hurray! Now you have successfully connected with the Lyftron ShipEngine connector and can utilize the connector to Extract, Warehouse, Analyze, Visualize and Share your data.

Data Model

The provider models the data in APIs into a list of tables that can be queried using standard SQL statements.

Generally, querying APIs tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns.

Name	Type	Description
BatchErrors	Tables	Retrieve all errors for a given batch.
Batches	Tables	Retrieve all Batches
CarrierOptions	Tables	Retrieve all options for a given carrier.
Carriers	Tables	Retrieve a list of available carriers.
CarrierServices	Tables	Retrieve all services for a given carrier.
CustomPackage	Tables	Get a Custom Package
Labels	Tables	Retrieve all labels
Manifests	Tables	Retrieve all manifests
ShipmentRates	Tables	Retrieve all rates for a given shipment.
Shipments	Tables	Retrieve all shipments
Tags	Tables	Retrieve all tags
Warehouses	Tables	Retrieve all warehouses
Webhooks	Tables	Retrieve a list of active web hooks.