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

Singer Community

Stitch plan

Free

API availability

Available

Singer GitHub repository

singer-io/tap-3plcentral

REPLICATION SETTINGS
Anchor Scheduling

Supported

Advanced Scheduling

Supported

Table-level reset

Unsupported

Configurable Replication Methods

Unsupported

DATA SELECTION
Table selection

Supported

Column selection

Supported

TRANSPARENCY
Extraction Logs

Supported

Loading Reports

Supported

Connecting 3PL Central

Step 1: Request API credentials from 3PL Central

  1. 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.
  2. Keep this information available so you can add the integration in the next step.

Step 2: Add 3PL Central as a Stitch data source

  1. Sign into your Stitch account.
  2. On the Stitch Dashboard page, click the Add Integration button.

  3. Click the 3PL Central icon.

  4. 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.

  5. Enter the information you requested from Step 1 into the corresponding fields in Stitch.

Step 3: Define the historical sync

The Sync Historical Data setting will define 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 data warehouse.
  • 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 data warehouse.

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:

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 tables and columns to replicate

To complete the setup, you’ll need to select the tables and columns you want to replicate to your data warehouse.

Check out the Schema section to learn more about the available tables in 3PL Central and how they replicate.

  1. In the list of tables that displays - or in the Tables to Replicate tab, if you skipped this step during setup - locate a table you want to replicate.
  2. To track a table, click the checkbox next to the table’s name. A green checkmark means the table is set to replicate.

  3. To track a column, click the checkbox next to the column’s name. A green checkmark means the column is set to replicate.

  4. Repeat this process for all the tables and columns you want to replicate.
  5. When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.

Note: If you change these settings while a replication job is still in progress, they will not be used until the next job starts.

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.

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 schemas

Replication Method :

Full Table

Primary Key :

customer_id

API endpoint :

Get customers

This table contains information about customers.

customer_id
INTEGER

The customer ID.

Reference:

company_info
OBJECT

Details about the company associated with the customer.

When identifying an existing contact, the lookup order is:

  1. id
  2. code, if no other fields are present
  3. All fields except id

If contact_id is not specified and other fields do not match an existing contact for the relevant customer, a new contact is created.

address1
STRING

address2
STRING

address_status
INTEGER

The confirmation status. Possible values are:

  • 0 - Unconfirmed
  • 1 - Confirmed
  • 2 - UserAccepted

city
STRING

code
STRING

The company code. This is used an identifier. If known, only this field is used. If other fields are specified, then the code is not used as the identifier.

company_name
STRING

contact_id
INTEGER

The contact ID. If the contact ID is known, then other fields are ignored.

country
STRING

dept
STRING

email_address
STRING

fax
STRING

name
STRING

phone_number
STRING

state
STRING

title
STRING

zip
STRING

customers (table), company_info (attribute)

creation_date
DATE-TIME

The date the customer was created.

deactivated
BOOLEAN

external_id
STRING

The ID of the customer on another system.

facilities
ARRAY

The list of facilities the customer’s items are stored in. The first in the list is the primary facility.

groups
STRING

The list of groups this customer belongs to.

options
OBJECT

The customer’s preferences.

alerts
OBJECT

expiration_notification_threshold
INTEGER

from_email_address
STRING

notify_ship_to
BOOLEAN

customers (table), alerts (attribute)

edi
OBJECT

customer_interchange_id
STRING

customer_interchange_id_qual
STRING

threepl_interchange_id
STRING

threepl_interchange_id_qual
STRING

trading_partner_id
STRING

customers (table), edi (attribute)

other_system_behaviors
OBJECT

flex_fields
BOOLEAN

require_attached_documents
BOOLEAN

customers (table), other_system_behaviors (attribute)

packaging
OBJECT

small_parcel_create_packages_on_find
BOOLEAN

small_parcel_customize_duties
BOOLEAN

small_parcel_duties_and_taxes
STRING

small_parcel_duty_billing_type
STRING

small_parcel_high_volume_default_checked
BOOLEAN

small_parcel_high_volume_zpl_batched
BOOLEAN

small_parcel_rate_shopping_carrier_ids
STRING

small_parcel_rate_shopping_logic
STRING

small_parcel_references
STRING

small_parcel_return_default_checked
BOOLEAN

small_parcel_return_fed_ex_service
STRING

small_parcel_return_shipping_cost
BOOLEAN

small_parcel_return_ups_service
STRING

small_parcel_usps_3rd_party
STRING

small_parcel_usps_return_type
STRING

sps_close_on_update
BOOLEAN

ucc128_manufacturers_id
INTEGER

use_vendor_id_on_bol
BOOLEAN

customers (table), packaging (attribute)

receivers
OBJECT

defs
NULL

item_defs
NULL

customers (table), receivers (attribute)

receiving
OBJECT

autofill_track_bys
BOOLEAN

create_multiple_mus
BOOLEAN

inherit_original_receipt_date_on_transfer
BOOLEAN

purchase_orders
BOOLEAN

receive_against_asns
INTEGER

Possible values are:

  • 0 - Disabled
  • 1 - Enabled
  • 2 - Blind

require_scac_for_asn
BOOLEAN

suggest_put_away_enabled
BOOLEAN

track_location
INTEGER

Possible vlaues are:

  • 0 - Disallow
  • 1 - Allow
  • 2 - Require

track_pallets
INTEGER

Possible vlaues are:

  • 0 - Disallow
  • 1 - Allow
  • 2 - Require

track_supplier
INTEGER

Possible vlaues are:

  • 0 - Disallow
  • 1 - Allow
  • 2 - Require
customers (table), receiving (attribute)

saved_elements
OBJECT

orders
OBJECT

defs
ARRAY

name
STRING

required
BOOLEAN

customers (table), defs (attribute)

item_defs
ARRAY

name
STRING

required
BOOLEAN

customers (table), item_defs (attribute)
customers (table), orders (attribute)
customers (table), saved_elements (attribute)

shipping
OBJECT

auto_confirm_order_on_tracking_update
BOOLEAN

bol_num_as_trans_num
BOOLEAN

fed_ex_account_number
STRING

fulfillment_invoicing
INTEGER

Possible values are:

  • 0 - Disabled
  • 1 - Enabled
  • 2 - Prepoulated

next_master_bol_id
INTEGER

next_master_bol_id_override
INTEGER

order_queue
BOOLEAN

packing_list_footer_url
STRING

packing_list_logo_url
STRING

prepopulate_carrier_info
INTEGER

Possible values are:

  • 0 - Off
  • 1 - On
  • 2 - PrepaidOnly
  • 3 - ThirdPartyOnly

require_tracking_number
BOOLEAN

roundupto_full_mu
BOOLEAN

ups_account_number
STRING

ups_account_zip
STRING

customers (table), shipping (attribute)

storage
OBJECT

accounting_customer_name
STRING

autofill_charges_on_confirm
BOOLEAN

fuel_surcharge
NUMBER

This value is a positive integer percentage.

set_invoice_date_to_xaction_confirm_date
BOOLEAN

customers (table), storage (attribute)

user_interface
OBJECT

auto_check_auto_reallocate_on_receive
BOOLEAN

branding_image_id
INTEGER

dashboard
BOOLEAN

exclude_location_with_zero_inventory
BOOLEAN

hide_location_selected_list
BOOLEAN

mobile_receipt_quantity_one_default
BOOLEAN

reallocate_at_pick_time
BOOLEAN

transaction_confirm_invoice_create_default
INTEGER

Possible values are:

  • 0 - Off
  • 1 - On
  • 2 - ReceiversOnly
  • 3 - OrdersOnly
customers (table), user_interface (attribute)
customers (table), options (attribute)

other_contacts
OBJECT

Customer contacts where the contact type is other than primary.

type
INTEGER

The customer contact type. Possible values are:

  • 2 - Invoicing
  • 3 - Additional
  • 4 - For753
  • 5 - SmallParcelReturnLabel

address1
STRING

address2
STRING

address_status
INTEGER

The confirmation status. Possible values are:

  • 0 - Unconfirmed
  • 1 - Confirmed
  • 2 - UserAccepted

city
STRING

code
STRING

The company code. This is used an identifier. If known, only this field is used. If other fields are specified, then the code is not used as the identifier.

company_name
STRING

contact_id
INTEGER

The contact ID. If the contact ID is known, then other fields are ignored.

country
STRING

dept
STRING

email_address
STRING

fax
STRING

name
STRING

phone_number
STRING

state
STRING

title
STRING

zip
STRING

customers (table), other_contacts (attribute)

primary_contact
OBJECT

address1
STRING

address2
STRING

address_status
INTEGER

The confirmation status. Possible values are:

  • 0 - Unconfirmed
  • 1 - Confirmed
  • 2 - UserAccepted

city
STRING

code
STRING

The company code. This is used an identifier. If known, only this field is used. If other fields are specified, then the code is not used as the identifier.

company_name
STRING

contact_id
INTEGER

The contact ID. If the contact ID is known, then other fields are ignored.

country
STRING

dept
STRING

email_address
STRING

fax
STRING

name
STRING

phone_number
STRING

state
STRING

title
STRING

zip
STRING

customers (table), primary_contact (attribute)

primary_facility_identifier
OBJECT

The primary facility.

website
STRING

The customer’s business website.


Replication Method :

Full Table

Primary Key :

receive_item_id

API endpoint :

Get inventory

This table contains information about inventory resources.

receive_item_id
INTEGER

Reference:

available_qty
NUMBER

cost
NUMBER

customer_identifier
OBJECT

Details about the customer associated with the inventory record.

expiration_date
DATE-TIME

facility_identifier
OBJECT

The facility identifier.

inventory_unit_of_measure_identifier
OBJECT

id
INTEGER

name
STRING

inventory (table), inventory_unit_of_measure_identifier (attribute)

inventory_units_per_secondary_unity
NUMBER

item_description
STRING

item_identifier
OBJECT

location_identifier
OBJECT

lot_number
STRING

on_hand_qty
NUMBER

on_hold
BOOLEAN

on_hold_date
DATE-TIME

on_hold_qty
NUMBER

on_hold_reason
STRING

on_hold_user_identifier
OBJECT

id
INTEGER

name
STRING

inventory (table), on_hold_user_identifier (attribute)

pallet_identifier
OBJECT

qualifier
STRING

quarantined
BOOLEAN

receive_qty
NUMBER

received_date
DATE-TIME

receiver_id
INTEGER

Reference:

secondary_available_qty
NUMBER

secondary_on_hand_qty
NUMBER

secondary_on_hold_qty
NUMBER

secondary_received_qty
NUMBER

secondary_unit_of_measure_identifier
OBJECT

id
INTEGER

name
STRING

inventory (table), secondary_unit_of_measure_identifier (attribute)

serial_number
STRING

supplier_identifier
OBJECT

id
INTEGER

Reference:

name
STRING

inventory (table), supplier_identifier (attribute)

weight_imperial
NUMBER

weight_imperial_available
NUMBER

weight_imperial_on_hand
NUMBER

weight_metric
NUMBER

weight_metric_available
NUMBER

weight_metric_on_hand
NUMBER


Replication Method :

Full Table

Primary Key :

location_id : facility_id

API endpoint :

Get inventory locations

This table contains information about inventory facility locations.

location_id
INTEGER

The location ID.

Reference:

facility_id
INTEGER

The facility ID.

Reference:

customer_identifier
OBJECT

Details about the customer associated with the location.

description
STRING

item_traits
OBJECT

locations (table), item_traits (attribute)

location_identifier
OBJECT

location_type_identifier
OBJECT

id
INTEGER

name
STRING

locations (table), location_type_identifier (attribute)

on_hand
NUMBER


Replication Method :

Key-based Incremental

Replication Key :

last_modified_date

Primary Key :

order_id

API endpoint :

Get orders

This table contains information about orders.

order_id
INTEGER

The order ID.

last_modified_date
DATE-TIME

The time the order was last modified.

add_freight_to_cod
BOOLEAN

asn_candidate
INTEGER

asn_number
STRING

asn_sent
BOOLEAN

asn_sent_date
DATE-TIME

batch_identifier
OBJECT

id
INTEGER

name_key
OBJECT

customer_identifier
OBJECT

name
STRING

orders (table), name_key (attribute)
orders (table), batch_identifier (attribute)

bill_to
OBJECT

address1
STRING

address2
STRING

address_status
STRING

city
STRING

code
STRING

company_name
STRING

contact_id
INTEGER

country
STRING

dept
STRING

email_address
STRING

fax
STRING

is_quick_lookup
BOOLEAN

name
STRING

phone_number
STRING

retailer_id
INTEGER

same_as
INTEGER

state
STRING

title
STRING

zip
STRING

orders (table), bill_to (attribute)

billing
OBJECT

billing_charges
ARRAY

charge_label
STRING

charge_per_unit
NUMBER

gl_acct_num
STRING

num_units
NUMBER

pt_ar_acct
STRING

pt_item
STRING

pt_item_description
STRING

sku
STRING

system_generated
BOOLEAN

unit_description
STRING

warehouse_transaction_price_calc_id
INTEGER

orders (table), billing_charges (attribute)
orders (table), billing (attribute)

billing_code
STRING

created_by_identifier
OBJECT

id
INTEGER

name
STRING

orders (table), created_by_identifier (attribute)

creation_date
DATE-TIME

customer_identifier
OBJECT

Details about the customer associated with the order.

defer_notification
BOOLEAN

description
STRING

earliest_ship_date
DATE-TIME

export_channel_identifier
OBJECT

id
INTEGER

name
STRING

orders (table), export_channel_identifier (attribute)

export_module_ids
STRING

external_id
STRING

facility_identifier
OBJECT

fulfill_inv_info
OBJECT

fulfill_inv_amount
NUMBER

fulfill_inv_discount_code
STRING

fulfill_inv_message
STRING

fulfill_inv_shipping_and_handling
NUMBER

fulfill_inv_tax
NUMBER

orders (table), fulfill_inv_info (attribute)

fully_allocated
BOOLEAN

import_channel_identifier
OBJECT

id
INTEGER

name
STRING

orders (table), import_channel_identifier (attribute)

invoice_delivered_date
DATE-TIME

invoice_exported_date
DATE-TIME

invoice_number
STRING

is_closed
BOOLEAN

labels_exported
BOOLEAN

last_modified_by_identifier
OBJECT

id
INTEGER

name
STRING

orders (table), last_modified_by_identifier (attribute)

load_out_done_date
DATE-TIME

loaded_state
INTEGER

master_billing_of_lading_id
STRING

notes
STRING

num_units
NUMBER

order_items
NULL

outbound_serial_numbers
NULL

pack_done_date
DATE-TIME

packages
NULL

parcel_label_type
INTEGER

pick_done_date
DATE-TIME

pick_ticket_print_date
DATE-TIME

pkgs_exported
BOOLEAN

po_num
STRING

process_date
DATE-TIME

reallocated_after_pick_ticket_date
DATE-TIME

reference_num
STRING

route_candidate
INTEGER

route_pickup_date
DATE-TIME

route_sent
BOOLEAN

routing_info
OBJECT

account
STRING

bill_of_lading
STRING

capacity_identifier
OBJECT

id
INTEGER

name
STRING

orders (table), capacity_identifier (attribute)

carrier
STRING

door_number
STRING

is_cod
BOOLEAN

is_insurance
BOOLEAN

load_number
STRING

mode
STRING

pickup_date
DATE-TIME

required_delivery_conf
BOOLEAN

required_return_receipt
BOOLEAN

scac_code
STRING

seal_number
STRING

ship_point_zip
STRING

tracking_number
STRING

trailer_number
STRING

orders (table), routing_info (attribute)

saved_elements
NULL

ship_cancel_date
DATE-TIME

ship_to
OBJECT

address1
STRING

address2
STRING

address_status
STRING

city
STRING

code
STRING

company_name
STRING

contact_id
INTEGER

country
STRING

dept
STRING

email_address
STRING

fax
STRING

is_quick_lookup
BOOLEAN

name
STRING

phone_number
STRING

retailer_id
INTEGER

retailer_info
OBJECT

id
INTEGER

name_key
OBJECT

customer_identifier
OBJECT

name
STRING

number
STRING

orders (table), name_key (attribute)
orders (table), retailer_info (attribute)

same_as
INTEGER

state
STRING

title
STRING

zip
STRING

orders (table), ship_to (attribute)

shipping_notes
STRING

sold_to
OBJECT

address1
STRING

address2
STRING

address_status
STRING

city
STRING

code
STRING

company_name
STRING

contact_id
INTEGER

country
STRING

dept
STRING

email_address
STRING

fax
STRING

is_quick_lookup
BOOLEAN

name
STRING

phone_number
STRING

retailer_id
INTEGER

same_as
INTEGER

state
STRING

title
STRING

zip
STRING

orders (table), sold_to (attribute)

status
INTEGER

total_volume
NUMBER

total_weight
NUMBER

transaction_entry_type
INTEGER

unit2_identifier
OBJECT

id
INTEGER

name
STRING

orders (table), unit2_identifier (attribute)

up_service_option_charge
NUMBER

up_transportation_charge
NUMBER

ups_is_residential
NUMBER

warehouse_transaction_source_type
INTEGER


Replication Method :

Key-based Incremental

Replication Key :

last_modified_date

Primary Key :

item_id

API endpoint :

Get SKU items

This table contains information about SKU items.

item_id
INTEGER

The item ID.

Reference:

last_modified_date
DATE-TIME

The time the item was last modified.

account_ref
STRING

classification_identifier
OBJECT

id
INTEGER

name
STRING

sku_items (table), classification_identifier (attribute)

cost
NUMBER

country_of_manufacture
STRING

creation_date
DATE-TIME

customer_id
INTEGER

Reference:

customer_identifier
OBJECT

deactivated
BOOLEAN

description
STRING

description2
STRING

harmonized_code
STRING

inventory_category
STRING

item
ARRAY

qualifier
STRING

sku_items (table), item (attribute)

kit
OBJECT

components
ARRAY

item_identifier
ARRAY

sku_items (table), item_identifier (attribute)
sku_items (table), components (attribute)

material_notes
STRING

sku_items (table), kit (attribute)

last_price_change
DATE-TIME

nmfc
STRING

options
OBJECT

auto_hold_on_receive
INTEGER

days_between_counts
INTEGER

directed_put_away
OBJECT

allow_mixed_item_storage
BOOLEAN

allow_mixed_lot_storage
BOOLEAN

force_into_preferred_location
BOOLEAN

location_zones
STRING

mixed_expiration_days_threshold
BOOLEAN

over_alloc_location_zones
STRING

pallet_location_zones
STRING

preferred_location_identifier
OBJECT

sku_items (table), directed_put_away (attribute)

haz_mat
OBJECT

flag
STRING

flash_point
STRING

hazard_class
STRING

id
INTEGER

is_haz_mat
BOOLEAN

label_code
STRING

packing_group
STRING

shipping_name
STRING

sku_items (table), haz_mat (attribute)

inventory_unit
OBJECT

inventory_method
INTEGER

maximum_stock
NUMBER

minimum_stock
NUMBER

reorder_quantity
NUMBER

unit_identifier
OBJECT

id
INTEGER

name
STRING

sku_items (table), unit_identifier (attribute)
sku_items (table), inventory_unit (attribute)

package_unit
OBJECT

imperial
OBJECT

height
NUMBER

length
NUMBER

net_weight
NUMBER

weight
NUMBER

width
NUMBER

sku_items (table), imperial (attribute)

metric
OBJECT

height
NUMBER

length
NUMBER

net_weight
NUMBER

weight
NUMBER

width
NUMBER

sku_items (table), metric (attribute)

unit_identifier
OBJECT

id
INTEGER

name
STRING

sku_items (table), unit_identifier (attribute)

upc
STRING

sku_items (table), package_unit (attribute)

pallets
OBJECT

high
NUMBER

imperial
OBJECT

height
NUMBER

length
NUMBER

weight
NUMBER

width
NUMBER

sku_items (table), imperial (attribute)

metric
OBJECT

height
NUMBER

length
NUMBER

weight
NUMBER

width
NUMBER

sku_items (table), metric (attribute)

qyt
NUMBER

tie
NUMBER

type_identifier
OBJECT

id
INTEGER

name
STRING

sku_items (table), type_identifier (attribute)

upc
STRING

sku_items (table), pallets (attribute)

secondary_unit
OBJECT

inventory_also
BOOLEAN

inventory_units_per_unit
NUMBER

unit_identifier
OBJECT

id
INTEGER

name
STRING

sku_items (table), unit_identifier (attribute)
sku_items (table), secondary_unit (attribute)

track_by
OBJECT

auto_hold_expiration_days_threshold
INTEGER

outbound_mobile_serialization
INTEGER

track_cost
INTEGER

track_expiration_date
INTEGER

track_lot_number
INTEGER

track_serial_number
INTEGER

sku_items (table), track_by (attribute)
sku_items (table), options (attribute)

price
NUMBER

qualifier_renamers
ARRAY

qualifier
STRING

renames
STRING

sku_items (table), qualifier_renamers (attribute)

sku
STRING

temperature
NUMBER

upc
STRING


Replication Method :

Full Table

Primary Key :

receive_item_id

API endpoint :

Get stock details

This table contains information about stock details.

receive_item_id
INTEGER

Reference:

available
NUMBER

cost
NUMBER

customer_id
INTEGER

Reference:

description
STRING

expiration_date
DATE-TIME

inventory_unit_of_measure_identifier
OBJECT

id
INTEGER

sku
STRING

stock_details (table), inventory_unit_of_measure_identifier (attribute)

is_on_hold
BOOLEAN

item_identifier
OBJECT

stock_details (table), item_identifier (attribute)

location_identifier
OBJECT

lot_number
STRING

on_hand
NUMBER

pallet_identifier
OBJECT

po_num
STRING

qualifier
STRING

quarantined
BOOLEAN

received
NUMBER

received_date
DATE-TIME

receiver_id
INTEGER

Reference:

reference_num
STRING

saved_elements
NULL

serial_number
STRING

supplier_identifier
OBJECT

id
INTEGER

Reference:

name
STRING

stock_details (table), supplier_identifier (attribute)

trailer_number
STRING


Replication Method :

Full Table

Primary Key :

facility_id : item_id

API endpoint :

Get stock summaries

This table contains information about stock summaries.