Shippio

Shippio is a freight forwarding and logistics management platform.

Shippio integration replicates data using the Shippio REST API.

See the Schema section for a list of objects available for replication.

A high-level look at this connector, including useful links, and supported features.

Feature/Capability	Support details
Supported Qlik Talend Data Integration projects	Replication projects only. Data pipeline projects are not supported.
Target update methods	Replication tasks: Apply changes Store changes Landing data in a data lake tasks: Change data capture (CDC)
Managing metadata	Manual metadata generation is not required.
Schema evolution	Only the Change column data type operation is supported.
Replication of LOB columns (NCLOB, CLOB, and BLOB)	Not supported.
Scheduled CDC	Required. This is how the target is kept up-to-date with changes to the source. For replication tasks, see Scheduling tasks For lake landing tasks, see Scheduling CDC for lake landing tasks
Notifications	Partially supported Setting notifications for changes in operation
Monitoring	CDC-only, as full load is not relevant for this connector. Monitoring an individual data task
Automatic denesting of JSON column payloads	Not supported. JSON column payloads in source datasets are not denested automatically on the target.

Preparing for authentication

To access your data, you need to authenticate the connection with a Shippio Client ID and Client Secret.

Make sure that the account you use has read access to the tables you want to fetch.

To generate your client ID and client secret:

Log into your Shippio account.
Navigate to Settings > API Credentials > Shippio API Applications.
Click + New Application.
Copy and paste your client ID and client secret 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.

Connection settings
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 `MM/DD/YYYY`, from which the data must be replicated from your source to your target.
Client ID	Client ID.
Client Secret	Client secret.

Limitations and considerations

The Shippio API does not provide a date field that can be used as a query parameter. All tables use Full Table replication.
The Shippio API has a rate limit of 500 requests per minute. It is recommended to use a single task per Shippio connection. Creating multiple tasks replicating from the same Shippio account may cause the API to throttle requests and lead to task failures.
Tables with large volumes of data (for example, in_transit_products) may take a significant amount of time to extract due to full table replication. This can potentially cause tasks to time out.

Schema

Schemas and naming conventions can change from version to version. It is recommended to verify your version before continuing.

Depending on your destination, table and column names may not appear as they are outlined below.

addresses

The addresses table contains address records in your Shippio account.

Replication Method	Full Table
Primary Key	id
Useful links	Shippio API reference

carriers

The carriers table contains carrier records in your Shippio account.

Replication Method	Full Table
Primary Key	id
Useful links	Shippio API reference

companies

The companies table contains company records in your Shippio account.

Replication Method	Full Table
Primary Key	id
Useful links	Shippio API reference

consignees

The consignees table contains consignee records in your Shippio account.

Replication Method	Full Table
Primary Key	id
Useful links	Shippio API reference

containers

The containers table contains container records in your Shippio account.

Replication Method	Full Table
Primary Key	id
Useful links	Shippio API reference

customer_teams

The customer_teams table contains customer team records in your Shippio account.

Replication Method	Full Table
Primary Key	id
Useful links	Shippio API reference

customer_users

The customer_users table contains customer user records in your Shippio account.

Replication Method	Full Table
Primary Key	id
Useful links	Shippio API reference

events

The events table contains event records in your Shippio account.

Replication Method	Full Table
Primary Key	id
Useful links	Shippio API reference

in_transit_products

The in_transit_products table contains records of products currently in transit in your Shippio account.

Replication Method	Full Table
Primary Key	id
Useful links	Shippio API reference

partners

The partners table contains partner records in your Shippio account.

Replication Method	Full Table
Primary Key	id
Useful links	Shippio API reference

ports

The ports table contains port records in your Shippio account.

Replication Method	Full Table
Primary Key	id
Useful links	Shippio API reference

products

The products table contains product records in your Shippio account.

Replication Method	Full Table
Primary Key	id
Useful links	Shippio API reference

shipments

The shipments table contains shipment records in your Shippio account.

Replication Method	Full Table
Primary Key	id
Useful links	Shippio API reference

shippers

The shippers table contains shipper records in your Shippio account.

Replication Method	Full Table
Primary Key	id
Useful links	Shippio API reference

user_groups

The user_groups table contains user group records in your Shippio account.

Replication Method	Full Table
Primary Key	id
Useful links	Shippio API reference

vessels

The vessels table contains vessel records in your Shippio account.

Replication Method	Full Table
Primary Key	id
Useful links	Shippio API reference

warehouses

The warehouses table contains warehouse records in your Shippio account.

Replication Method	Full Table
Primary Key	id
Useful links	Shippio API reference

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!

Leave your feedback here