This integration is powered by Singer's 3PL Central tap. For support, visit the GitHub repo or join the Singer Slack.
3PL Central feature snapshot
A high-level look at Stitch's 3PL Central (v1) integration, including release status, useful links, and the features supported in Stitch.
STITCH | |||
Release status |
Released on December 20, 2019 |
Supported by | |
Stitch plan |
Standard |
API availability |
Available |
Singer GitHub repository | |||
REPLICATION SETTINGS | |||
Anchor Scheduling |
Supported |
Advanced Scheduling |
Supported |
Table-level reset |
Unsupported |
Configurable Replication Methods |
Unsupported |
DATA SELECTION | |||
Table selection |
Supported |
Column selection |
Supported |
Select all |
Supported |
||
TRANSPARENCY | |||
Extraction Logs |
Supported |
Loading Reports |
Supported |
Connecting 3PL Central
Step 1: Request API credentials from 3PL Central
- Log into your 3PL Central account and request the following information from your account manager:
- Base URL: The API URL to which endpoints are appended.
- Client ID: Your secure OAuth 2.0 identifier.
- Client Secret: Your secure OAuth 2.0 secret key.
- Customer ID: The integer ID number for your customer organization.
- Facility ID: The integer ID number for your warehouse facility.
- TPL Key: Your warehouse-specific 3PL Central key.
- User Login: The interger ID number for your user account.
- Keep this information available so you can add the integration in the next step.
Step 2: Add 3PL Central as a Stitch data source
- Sign into your Stitch account.
-
On the Stitch Dashboard page, click the Add Integration button.
-
Click the 3PL Central icon.
-
Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.
For example, the name “Stitch 3PL Central” would create a schema called
stitch_3pl_central
in the destination. Note: Schema names cannot be changed after you save the integration. - Enter the information you requested from Step 1 into the corresponding fields in Stitch.
Step 3: Define the historical replication start date
The Sync Historical Data setting defines the starting date for your 3PL Central integration. This means that:
- For tables using Key-based Incremental Replication, data equal to or newer than this date will be replicated to your destination.
- For tables using Full Table Replication, all data - including records that are older, equal to, or newer than this date - will be replicated to your destination.
Change this setting if you want to replicate data beyond 3PL Central’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.
Step 4: Create a replication schedule
In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.
3PL Central integrations support the following replication scheduling methods:
-
Advanced Scheduling using Cron (Advanced or Premium plans only)
To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.
Step 5: Set objects to replicate
The last step is to select the tables and columns you want to replicate. Learn about the available tables for this integration.
Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.
For 3PL Central integrations, you can select:
-
Individual tables and columns
-
All tables and columns
Click the tabs to view instructions for each selection method.
- In the integration’s Tables to Replicate tab, locate a table you want to replicate.
-
To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.
-
To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.
- Repeat this process for all the tables and columns you want to replicate.
- When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
- Click into the integration from the Stitch Dashboard page.
-
Click the Tables to Replicate tab.
- In the list of tables, click the box next to the Table Names column.
-
In the menu that displays, click Track all Tables and Fields:
- Click the Finalize Your Selections button at the bottom of the page to save your data selections.
Initial and historical replication jobs
After you finish setting up 3PL Central, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.
For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
Free historical data loads
The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.
3PL Central table reference
Schemas and versioning
Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.
The schema and info displayed below is for version 1 of this integration.
This is the latest version of the 3PL Central integration.
Table and column names in your destination
Depending on your destination, table and column names may not appear as they are outlined below.
For example: Object names are lowercased in Redshift (CusTomERs
> customers
), while case is maintained in PostgreSQL destinations (CusTomERs
> CusTomERs
). Refer to the Loading Guide for your destination for more info.
customers
Replication Method : |
Full Table |
Primary Key |
customer_id |
API endpoint : |
This table contains information about customers.
customer_id
The customer ID. Reference:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
company_info
Details about the company associated with the customer. When identifying an existing contact, the lookup order is:
If
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_date
The date the customer was created. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivated
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
external_id
The ID of the customer on another system. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
facilities
The list of facilities the customer’s items are stored in. The first in the list is the primary facility. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
groups
The list of groups this customer belongs to. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
options
The customer’s preferences.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
other_contacts
Customer contacts where the contact type is other than primary.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
primary_contact
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
primary_facility_identifier
The primary facility. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
website
The customer’s business website. |
inventory
Replication Method : |
Full Table |
Primary Key |
receive_item_id |
API endpoint : |
This table contains information about inventory resources.
receive_item_id
Reference: |
||||||
available_qty
|
||||||
cost
|
||||||
customer_identifier
Details about the customer associated with the inventory record.
|
||||||
expiration_date
|
||||||
facility_identifier
The facility identifier. |
||||||
inventory_unit_of_measure_identifier
|
||||||
inventory_units_per_secondary_unity
|
||||||
item_description
|
||||||
item_identifier
|
||||||
location_identifier
|
||||||
lot_number
|
||||||
on_hand_qty
|
||||||
on_hold
|
||||||
on_hold_date
|
||||||
on_hold_qty
|
||||||
on_hold_reason
|
||||||
on_hold_user_identifier
|
||||||
pallet_identifier
|
||||||
qualifier
|
||||||
quarantined
|
||||||
receive_qty
|
||||||
received_date
|
||||||
receiver_id
Reference: |
||||||
secondary_available_qty
|
||||||
secondary_on_hand_qty
|
||||||
secondary_on_hold_qty
|
||||||
secondary_received_qty
|
||||||
secondary_unit_of_measure_identifier
|
||||||
serial_number
|
||||||
supplier_identifier
|
||||||
weight_imperial
|
||||||
weight_imperial_available
|
||||||
weight_imperial_on_hand
|
||||||
weight_metric
|
||||||
weight_metric_available
|
||||||
weight_metric_on_hand
|
locations
Replication Method : |
Full Table |
Primary Key |
location_id : facility_id |
API endpoint : |
This table contains information about inventory facility locations.
location_id
The location ID. Reference: |
||||||||||||||
facility_id
The facility ID. Reference:
|
||||||||||||||
customer_identifier
Details about the customer associated with the location.
|
||||||||||||||
description
|
||||||||||||||
item_traits
|
||||||||||||||
location_identifier
|
||||||||||||||
location_type_identifier
|
||||||||||||||
on_hand
|
orders
Replication Method : |
Key-based Incremental |
Replication Key |
last_modified_date |
Primary Key |
order_id |
API endpoint : |
This table contains information about orders.
order_id
The order ID. |
||||||||||||||||||||||||||||
last_modified_date
The time the order was last modified. |
||||||||||||||||||||||||||||
add_freight_to_cod
|
||||||||||||||||||||||||||||
asn_candidate
|
||||||||||||||||||||||||||||
asn_number
|
||||||||||||||||||||||||||||
asn_sent
|
||||||||||||||||||||||||||||
asn_sent_date
|
||||||||||||||||||||||||||||
batch_identifier
|
||||||||||||||||||||||||||||
bill_to
|
||||||||||||||||||||||||||||
billing
|
||||||||||||||||||||||||||||
billing_code
|
||||||||||||||||||||||||||||
created_by_identifier
|
||||||||||||||||||||||||||||
creation_date
|
||||||||||||||||||||||||||||
customer_identifier
Details about the customer associated with the order.
|
||||||||||||||||||||||||||||
defer_notification
|
||||||||||||||||||||||||||||
description
|
||||||||||||||||||||||||||||
earliest_ship_date
|
||||||||||||||||||||||||||||
export_channel_identifier
|
||||||||||||||||||||||||||||
export_module_ids
|
||||||||||||||||||||||||||||
external_id
|
||||||||||||||||||||||||||||
facility_identifier
|
||||||||||||||||||||||||||||
fulfill_inv_info
|
||||||||||||||||||||||||||||
fully_allocated
|
||||||||||||||||||||||||||||
import_channel_identifier
|
||||||||||||||||||||||||||||
invoice_delivered_date
|
||||||||||||||||||||||||||||
invoice_exported_date
|
||||||||||||||||||||||||||||
invoice_number
|
||||||||||||||||||||||||||||
is_closed
|
||||||||||||||||||||||||||||
labels_exported
|
||||||||||||||||||||||||||||
last_modified_by_identifier
|
||||||||||||||||||||||||||||
load_out_done_date
|
||||||||||||||||||||||||||||
loaded_state
|
||||||||||||||||||||||||||||
master_billing_of_lading_id
|
||||||||||||||||||||||||||||
notes
|
||||||||||||||||||||||||||||
num_units
|
||||||||||||||||||||||||||||
order_items
|
||||||||||||||||||||||||||||
outbound_serial_numbers
|
||||||||||||||||||||||||||||
pack_done_date
|
||||||||||||||||||||||||||||
packages
|
||||||||||||||||||||||||||||
parcel_label_type
|
||||||||||||||||||||||||||||
pick_done_date
|
||||||||||||||||||||||||||||
pick_ticket_print_date
|
||||||||||||||||||||||||||||
pkgs_exported
|
||||||||||||||||||||||||||||
po_num
|
||||||||||||||||||||||||||||
process_date
|
||||||||||||||||||||||||||||
reallocated_after_pick_ticket_date
|
||||||||||||||||||||||||||||
reference_num
|
||||||||||||||||||||||||||||
route_candidate
|
||||||||||||||||||||||||||||
route_pickup_date
|
||||||||||||||||||||||||||||
route_sent
|
||||||||||||||||||||||||||||
routing_info
|
||||||||||||||||||||||||||||
saved_elements
|
||||||||||||||||||||||||||||
ship_cancel_date
|
||||||||||||||||||||||||||||
ship_to
|
||||||||||||||||||||||||||||
shipping_notes
|
||||||||||||||||||||||||||||
sold_to
|
||||||||||||||||||||||||||||
status
|
||||||||||||||||||||||||||||
total_volume
|
||||||||||||||||||||||||||||
total_weight
|
||||||||||||||||||||||||||||
transaction_entry_type
|
||||||||||||||||||||||||||||
unit2_identifier
|
||||||||||||||||||||||||||||
up_service_option_charge
|
||||||||||||||||||||||||||||
up_transportation_charge
|
||||||||||||||||||||||||||||
ups_is_residential
|
||||||||||||||||||||||||||||
warehouse_transaction_source_type
|
sku_items
Replication Method : |
Key-based Incremental |
Replication Key |
last_modified_date |
Primary Key |
item_id |
API endpoint : |
This table contains information about SKU items.
item_id
The item ID. Reference: |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_modified_date
The time the item was last modified. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_ref
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
classification_identifier
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cost
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
country_of_manufacture
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_date
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customer_id
Reference:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customer_identifier
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivated
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description2
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
harmonized_code
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
inventory_category
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
item
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
kit
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_price_change
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nmfc
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
options
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
price
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
qualifier_renamers
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sku
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
temperature
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
upc
|
stock_details
Replication Method : |
Full Table |
Primary Key |
receive_item_id |
API endpoint : |
This table contains information about stock details.
receive_item_id
Reference: |
||||||
available
|
||||||
cost
|
||||||
customer_id
Reference:
|
||||||
description
|
||||||
expiration_date
|
||||||
inventory_unit_of_measure_identifier
|
||||||
is_on_hold
|
||||||
item_identifier
|
||||||
location_identifier
|
||||||
lot_number
|
||||||
on_hand
|
||||||
pallet_identifier
|
||||||
po_num
|
||||||
qualifier
|
||||||
quarantined
|
||||||
received
|
||||||
received_date
|
||||||
receiver_id
|