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

Standard

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

Select all

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 replication start date

The Sync Historical Data setting defines the starting date for your 3PL Central integration. This means that data 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 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:

  1. Individual tables and columns

  2. All tables and columns

Click the tabs to view instructions for each selection method.

  1. In the integration’s Tables to Replicate tab, locate a table you want to replicate.
  2. To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.

  3. To track a column, click the checkbox next to the column’s name. A blue 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.
  1. Click into the integration from the Stitch Dashboard page.
  2. Click the Tables to Replicate tab.

  3. In the list of tables, click the box next to the Table Names column.
  4. In the menu that displays, click Track all Tables and Fields:

    The Track all Tables and Fields menu in the Tables to Replicate tab

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

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

customers

This table contains information about customers.

Replication Method

Full Table

Primary Key

customer_id

Useful links

3PL Central documentation

customers schema on GitHub

3PL Central API method

Join customers with on
sku_items
customers.customer_id = sku_items.customer_id
customers.customer_id = sku_items.customer_identifier.id
customers.facilities.id = sku_items.options.directed_put_away.preferred_location_identifier.name_key.facility_identifier.id
customers.primary_facility_identifier.id = sku_items.options.directed_put_away.preferred_location_identifier.name_key.facility_identifier.id
stock_details
customers.customer_id = stock_details.customer_id
customers.facilities.id = stock_details.location_identifier.name_key.facility_identifier.id
customers.primary_facility_identifier.id = stock_details.location_identifier.name_key.facility_identifier.id
customers.facilities.id = stock_details.pallet_identifier.name_key.facility_identifier.id
customers.primary_facility_identifier.id = stock_details.pallet_identifier.name_key.facility_identifier.id
inventory
customers.customer_id = inventory.customer_identifier.id
customers.facilities.id = inventory.facility_identifier.id
customers.primary_facility_identifier.id = inventory.facility_identifier.id
customers.facilities.id = inventory.location_identifier.name_key.facility_identifier.id
customers.primary_facility_identifier.id = inventory.location_identifier.name_key.facility_identifier.id
customers.facilities.id = inventory.pallet_identifier.name_key.facility_identifier.id
customers.primary_facility_identifier.id = inventory.pallet_identifier.name_key.facility_identifier.id
locations
customers.customer_id = locations.customer_identifier.id
customers.facilities.id = locations.facility_id
customers.primary_facility_identifier.id = locations.facility_id
customers.facilities.id = locations.item_traits.pallet_identifier.name_key.facility_identifier.id
customers.primary_facility_identifier.id = locations.item_traits.pallet_identifier.name_key.facility_identifier.id
customers.facilities.id = locations.location_identifier.name_key.facility_identifier.id
customers.primary_facility_identifier.id = locations.location_identifier.name_key.facility_identifier.id
orders
customers.customer_id = orders.customer_identifier.id
customers.customer_id = orders.batch_identifier.name_key.customer_identifier.id
customers.customer_id = orders.ship_to.retailer_info.name_key.customer_identifier.id
customers.facilities.id = orders.facility_identifier.id
customers.primary_facility_identifier.id = orders.facility_identifier.id
stock_summaries
customers.facilities.id = stock_summaries.facility_id
customers.primary_facility_identifier.id = stock_summaries.facility_id

company_info

OBJECT

address1

STRING

address2

STRING

address_status

INTEGER

city

STRING

code

STRING

company_name

STRING

contact_id

INTEGER

country

STRING

dept

STRING

email_address

STRING

fax

STRING

name

STRING

phone_number

STRING

state

STRING

title

STRING

zip

STRING

creation_date

DATE-TIME

customer_id

INTEGER

deactivated

BOOLEAN

external_id

STRING

facilities

ARRAY

id

INTEGER

name

STRING

groups

ARRAY

options

OBJECT

alerts

OBJECT

expiration_notification_threshold

INTEGER

from_email_address

STRING

notify_ship_to

BOOLEAN

edi

OBJECT

customer_interchange_id

STRING

customer_interchange_id_qual

STRING

threepl_interchange_id

STRING

threepl_interchange_id_qual

STRING

trading_partner_id

STRING

other_system_behaviors

OBJECT

flex_fields

BOOLEAN

require_attached_documents

BOOLEAN

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

receivers

OBJECT

defs

ARRAY

name

STRING

required

BOOLEAN

item_defs

ARRAY

name

STRING

required

BOOLEAN

receiving

OBJECT

autofill_track_bys

BOOLEAN

create_multiple_mus

BOOLEAN

inherit_original_receipt_date_on_transfer

BOOLEAN

purchase_orders

BOOLEAN

receive_against_asns

INTEGER

require_scac_for_asn

BOOLEAN

suggest_put_away_enabled

BOOLEAN

track_location

INTEGER

track_pallets

INTEGER

track_supplier

INTEGER

saved_elements

OBJECT

orders

OBJECT

defs

ARRAY

name

STRING

required

BOOLEAN

item_defs

ARRAY

name

STRING

required

BOOLEAN

shipping

OBJECT

auto_confirm_order_on_tracking_update

BOOLEAN

bol_num_as_trans_num

BOOLEAN

fed_ex_account_number

STRING

fulfillment_invoicing

INTEGER

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

require_tracking_number

BOOLEAN

roundupto_full_mu

BOOLEAN

ups_account_number

STRING

ups_account_zip

STRING

storage

OBJECT

accounting_customer_name

STRING

autofill_charges_on_confirm

BOOLEAN

fuel_surcharge

NUMBER

set_invoice_date_to_xaction_confirm_date

BOOLEAN

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

other_contacts

ARRAY

address1

STRING

address2

STRING

address_status

INTEGER

city

STRING

code

STRING

company_name

STRING

contact_id

INTEGER

country

STRING

dept

STRING

email_address

STRING

fax

STRING

name

STRING

phone_number

STRING

state

STRING

title

STRING

type

INTEGER

zip

STRING

primary_contact

OBJECT

address1

STRING

address2

STRING

address_status

INTEGER

city

STRING

code

STRING

company_name

STRING

contact_id

INTEGER

country

STRING

dept

STRING

email_address

STRING

fax

STRING

name

STRING

phone_number

STRING

state

STRING

title

STRING

zip

STRING

primary_facility_identifier

OBJECT

website

STRING

inventory

This table contains information about inventory resources.

Replication Method

Full Table

Primary Key

receive_item_id

Useful links

3PL Central documentation

inventory schema on GitHub

3PL Central API method

Join inventory with on
customers
inventory.customer_identifier.id = customers.customer_id
inventory.facility_identifier.id = customers.facilities.id
inventory.location_identifier.name_key.facility_identifier.id = customers.facilities.id
inventory.pallet_identifier.name_key.facility_identifier.id = customers.facilities.id
inventory.facility_identifier.id = customers.primary_facility_identifier.id
inventory.location_identifier.name_key.facility_identifier.id = customers.primary_facility_identifier.id
inventory.pallet_identifier.name_key.facility_identifier.id = customers.primary_facility_identifier.id
sku_items
inventory.customer_identifier.id = sku_items.customer_id
inventory.customer_identifier.id = sku_items.customer_identifier.id
inventory.facility_identifier.id = sku_items.options.directed_put_away.preferred_location_identifier.name_key.facility_identifier.id
inventory.location_identifier.name_key.facility_identifier.id = sku_items.options.directed_put_away.preferred_location_identifier.name_key.facility_identifier.id
inventory.pallet_identifier.name_key.facility_identifier.id = sku_items.options.directed_put_away.preferred_location_identifier.name_key.facility_identifier.id
inventory.item_identifier.id = sku_items.item_id
inventory.item_identifier.id = sku_items.kit.components.item_identifier.id
inventory.location_identifier.id = sku_items.options.directed_put_away.preferred_location_identifier.id
stock_details
inventory.customer_identifier.id = stock_details.customer_id
inventory.facility_identifier.id = stock_details.location_identifier.name_key.facility_identifier.id
inventory.location_identifier.name_key.facility_identifier.id = stock_details.location_identifier.name_key.facility_identifier.id
inventory.pallet_identifier.name_key.facility_identifier.id = stock_details.location_identifier.name_key.facility_identifier.id
inventory.facility_identifier.id = stock_details.pallet_identifier.name_key.facility_identifier.id
inventory.location_identifier.name_key.facility_identifier.id = stock_details.pallet_identifier.name_key.facility_identifier.id
inventory.pallet_identifier.name_key.facility_identifier.id = stock_details.pallet_identifier.name_key.facility_identifier.id
inventory.item_identifier.id = stock_details.item_identifier.id
inventory.location_identifier.id = stock_details.location_identifier.id
inventory.pallet_identifier.id = stock_details.pallet_identifier.id
inventory.receiver_id = stock_details.receiver_id
inventory.receive_item_id = stock_details.receive_item_id
inventory.supplier_identifier.id = stock_details.supplier_identifier.id
locations
inventory.customer_identifier.id = locations.customer_identifier.id
inventory.facility_identifier.id = locations.facility_id
inventory.location_identifier.name_key.facility_identifier.id = locations.facility_id
inventory.pallet_identifier.name_key.facility_identifier.id = locations.facility_id
inventory.facility_identifier.id = locations.item_traits.pallet_identifier.name_key.facility_identifier.id
inventory.location_identifier.name_key.facility_identifier.id = locations.item_traits.pallet_identifier.name_key.facility_identifier.id
inventory.pallet_identifier.name_key.facility_identifier.id = locations.item_traits.pallet_identifier.name_key.facility_identifier.id
inventory.facility_identifier.id = locations.location_identifier.name_key.facility_identifier.id
inventory.location_identifier.name_key.facility_identifier.id = locations.location_identifier.name_key.facility_identifier.id
inventory.pallet_identifier.name_key.facility_identifier.id = locations.location_identifier.name_key.facility_identifier.id
inventory.location_identifier.id = locations.location_id
inventory.location_identifier.id = locations.location_identifier.id
inventory.pallet_identifier.id = locations.item_traits.pallet_identifier.id
orders
inventory.customer_identifier.id = orders.customer_identifier.id
inventory.customer_identifier.id = orders.batch_identifier.name_key.customer_identifier.id
inventory.customer_identifier.id = orders.ship_to.retailer_info.name_key.customer_identifier.id
inventory.facility_identifier.id = orders.facility_identifier.id
inventory.location_identifier.name_key.facility_identifier.id = orders.facility_identifier.id
inventory.pallet_identifier.name_key.facility_identifier.id = orders.facility_identifier.id
stock_summaries
inventory.facility_identifier.id = stock_summaries.facility_id
inventory.location_identifier.name_key.facility_identifier.id = stock_summaries.facility_id
inventory.pallet_identifier.name_key.facility_identifier.id = stock_summaries.facility_id

available_qty

NUMBER

cost

NUMBER

customer_identifier

OBJECT

external_d

STRING

id

INTEGER

name

STRING

expiration_date

DATE-TIME

facility_identifier

OBJECT

id

INTEGER

name

STRING

inventory_unit_of_measure_identifier

OBJECT

inventory_units_per_secondary_unity

NUMBER

item_description

STRING

item_identifier

OBJECT

id

INTEGER

sku

STRING

location_identifier

OBJECT

id

INTEGER

name_key

OBJECT

facility_identifier

OBJECT

id

INTEGER

name

STRING

name

STRING

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

pallet_identifier

OBJECT

id

INTEGER

name_key

OBJECT

facility_identifier

OBJECT

id

INTEGER

name

STRING

name

STRING

qualifier

STRING

quarantined

BOOLEAN

receive_item_id

INTEGER

receive_qty

NUMBER

received_date

DATE-TIME

receiver_id

INTEGER

secondary_available_qty

NUMBER

secondary_on_hand_qty

NUMBER

secondary_on_hold_qty

NUMBER

secondary_received_qty

NUMBER

secondary_unit_of_measure_identifier

OBJECT

serial_number

STRING

supplier_identifier

OBJECT

id

INTEGER

name

STRING

weight_imperial

NUMBER

weight_imperial_available

NUMBER

weight_imperial_on_hand

NUMBER

weight_metric

NUMBER

weight_metric_available

NUMBER

weight_metric_on_hand

NUMBER

locations

This table contains information about inventory facility locations.

Replication Method

Full Table

Primary Keys

location_id

facility_id

Useful links

3PL Central documentation

locations schema on GitHub

3PL Central API method

Join locations with on
customers
locations.customer_identifier.id = customers.customer_id
locations.facility_id = customers.facilities.id
locations.item_traits.pallet_identifier.name_key.facility_identifier.id = customers.facilities.id
locations.location_identifier.name_key.facility_identifier.id = customers.facilities.id
locations.facility_id = customers.primary_facility_identifier.id
locations.item_traits.pallet_identifier.name_key.facility_identifier.id = customers.primary_facility_identifier.id
locations.location_identifier.name_key.facility_identifier.id = customers.primary_facility_identifier.id
sku_items
locations.customer_identifier.id = sku_items.customer_id
locations.customer_identifier.id = sku_items.customer_identifier.id
locations.facility_id = sku_items.options.directed_put_away.preferred_location_identifier.name_key.facility_identifier.id
locations.item_traits.pallet_identifier.name_key.facility_identifier.id = sku_items.options.directed_put_away.preferred_location_identifier.name_key.facility_identifier.id
locations.location_identifier.name_key.facility_identifier.id = sku_items.options.directed_put_away.preferred_location_identifier.name_key.facility_identifier.id
locations.item_traits.item_identifier.id = sku_items.item_id
locations.location_id = sku_items.options.directed_put_away.preferred_location_identifier.id
locations.location_identifier.id = sku_items.options.directed_put_away.preferred_location_identifier.id
stock_details
locations.customer_identifier.id = stock_details.customer_id
locations.facility_id = stock_details.location_identifier.name_key.facility_identifier.id
locations.item_traits.pallet_identifier.name_key.facility_identifier.id = stock_details.location_identifier.name_key.facility_identifier.id
locations.location_identifier.name_key.facility_identifier.id = stock_details.location_identifier.name_key.facility_identifier.id
locations.facility_id = stock_details.pallet_identifier.name_key.facility_identifier.id
locations.item_traits.pallet_identifier.name_key.facility_identifier.id = stock_details.pallet_identifier.name_key.facility_identifier.id
locations.location_identifier.name_key.facility_identifier.id = stock_details.pallet_identifier.name_key.facility_identifier.id
locations.location_id = stock_details.location_identifier.id
locations.location_identifier.id = stock_details.location_identifier.id
locations.item_traits.pallet_identifier.id = stock_details.pallet_identifier.id
inventory
locations.customer_identifier.id = inventory.customer_identifier.id
locations.facility_id = inventory.facility_identifier.id
locations.item_traits.pallet_identifier.name_key.facility_identifier.id = inventory.facility_identifier.id
locations.location_identifier.name_key.facility_identifier.id = inventory.facility_identifier.id
locations.facility_id = inventory.location_identifier.name_key.facility_identifier.id
locations.item_traits.pallet_identifier.name_key.facility_identifier.id = inventory.location_identifier.name_key.facility_identifier.id
locations.location_identifier.name_key.facility_identifier.id = inventory.location_identifier.name_key.facility_identifier.id
locations.facility_id = inventory.pallet_identifier.name_key.facility_identifier.id
locations.item_traits.pallet_identifier.name_key.facility_identifier.id = inventory.pallet_identifier.name_key.facility_identifier.id
locations.location_identifier.name_key.facility_identifier.id = inventory.pallet_identifier.name_key.facility_identifier.id
locations.location_id = inventory.location_identifier.id
locations.location_identifier.id = inventory.location_identifier.id
locations.item_traits.pallet_identifier.id = inventory.pallet_identifier.id
orders
locations.customer_identifier.id = orders.customer_identifier.id
locations.customer_identifier.id = orders.batch_identifier.name_key.customer_identifier.id
locations.customer_identifier.id = orders.ship_to.retailer_info.name_key.customer_identifier.id
locations.facility_id = orders.facility_identifier.id
locations.item_traits.pallet_identifier.name_key.facility_identifier.id = orders.facility_identifier.id
locations.location_identifier.name_key.facility_identifier.id = orders.facility_identifier.id
stock_summaries
locations.facility_id = stock_summaries.facility_id
locations.item_traits.pallet_identifier.name_key.facility_identifier.id = stock_summaries.facility_id
locations.location_identifier.name_key.facility_identifier.id = stock_summaries.facility_id
locations.item_traits.item_identifier.id = stock_summaries.item_id

customer_identifier

OBJECT

external_id

STRING

id

INTEGER

name

STRING

description

STRING

facility_id

INTEGER

item_traits

OBJECT

expiration_date

DATE-TIME

item_identifier

OBJECT

id

INTEGER

sku

STRING

lot_number

STRING

pallet_identifier

OBJECT

id

INTEGER

name_key

OBJECT

facility_identifier

OBJECT

id

INTEGER

name

STRING

name

STRING

qualifier

STRING

serial_number

STRING

location_id

INTEGER

location_identifier

OBJECT

id

INTEGER

name_key

OBJECT

facility_identifier

OBJECT

id

INTEGER

name

STRING

name

STRING

location_type_identifier

OBJECT

on_hand

NUMBER

orders

This table contains information about orders.

Replication Method

Key-based Incremental

Primary Key

order_id

Replication Key

last_modified_date

Useful links

3PL Central documentation

orders schema on GitHub

3PL Central API method

Join orders with on
customers
orders.customer_identifier.id = customers.customer_id
orders.batch_identifier.name_key.customer_identifier.id = customers.customer_id
orders.ship_to.retailer_info.name_key.customer_identifier.id = customers.customer_id
orders.facility_identifier.id = customers.facilities.id
orders.facility_identifier.id = customers.primary_facility_identifier.id
sku_items
orders.customer_identifier.id = sku_items.customer_id
orders.batch_identifier.name_key.customer_identifier.id = sku_items.customer_id
orders.ship_to.retailer_info.name_key.customer_identifier.id = sku_items.customer_id
orders.customer_identifier.id = sku_items.customer_identifier.id
orders.batch_identifier.name_key.customer_identifier.id = sku_items.customer_identifier.id
orders.ship_to.retailer_info.name_key.customer_identifier.id = sku_items.customer_identifier.id
orders.facility_identifier.id = sku_items.options.directed_put_away.preferred_location_identifier.name_key.facility_identifier.id
stock_details
orders.customer_identifier.id = stock_details.customer_id
orders.batch_identifier.name_key.customer_identifier.id = stock_details.customer_id
orders.ship_to.retailer_info.name_key.customer_identifier.id = stock_details.customer_id
orders.facility_identifier.id = stock_details.location_identifier.name_key.facility_identifier.id
orders.facility_identifier.id = stock_details.pallet_identifier.name_key.facility_identifier.id
inventory
orders.customer_identifier.id = inventory.customer_identifier.id
orders.batch_identifier.name_key.customer_identifier.id = inventory.customer_identifier.id
orders.ship_to.retailer_info.name_key.customer_identifier.id = inventory.customer_identifier.id
orders.facility_identifier.id = inventory.facility_identifier.id
orders.facility_identifier.id = inventory.location_identifier.name_key.facility_identifier.id
orders.facility_identifier.id = inventory.pallet_identifier.name_key.facility_identifier.id
locations
orders.customer_identifier.id = locations.customer_identifier.id
orders.batch_identifier.name_key.customer_identifier.id = locations.customer_identifier.id
orders.ship_to.retailer_info.name_key.customer_identifier.id = locations.customer_identifier.id
orders.facility_identifier.id = locations.facility_id
orders.facility_identifier.id = locations.item_traits.pallet_identifier.name_key.facility_identifier.id
orders.facility_identifier.id = locations.location_identifier.name_key.facility_identifier.id
stock_summaries
orders.facility_identifier.id = stock_summaries.facility_id

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

external_id

STRING

id

INTEGER

name

STRING

name

STRING

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

billing

OBJECT

billing_charges

ARRAY

charge_type

INTEGER

details

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

subtotal

NUMBER

billing_code

STRING

created_by_identifier

OBJECT

id

INTEGER

name

STRING

creation_date

DATE-TIME

customer_identifier

OBJECT

external_id

STRING

id

INTEGER

name

STRING

defer_notification

BOOLEAN

description

STRING

earliest_ship_date

DATE-TIME

export_channel_identifier

OBJECT

export_module_ids

STRING

external_id

STRING

facility_identifier

OBJECT

id

INTEGER

name

STRING

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

fully_allocated

BOOLEAN

import_channel_identifier

OBJECT

invoice_delivered_date

DATE-TIME

invoice_exported_date

DATE-TIME

invoice_number

STRING

is_closed

BOOLEAN

labels_exported

BOOLEAN

last_modified_by_identifier

OBJECT

last_modified_date

DATE-TIME

load_out_done_date

DATE-TIME

loaded_state

INTEGER

master_billing_of_lading_id

STRING

notes

STRING

num_units

NUMBER

order_id

INTEGER

order_items

ARRAY

expiration_date

DATE-TIME

external_id

STRING

fulfill_inv_discount_amt

NUMBER

fulfill_inv_discount_pct

NUMBER

fulfill_inv_note

STRING

fulfill_inv_sale_price

NUMBER

item_identifier

OBJECT

id

INTEGER

sku

STRING

lot_number

STRING

notes

STRING

order_item_packages

ARRAY

package_number

INTEGER

quantity

NUMBER

proposed_allocations

ARRAY

qty

NUMBER

receive_item_id

INTEGER

qty

NUMBER

qualifier

STRING

read_only

OBJECT

allocations

ARRAY

detail

OBJECT

expiration_date

DATE-TIME

item_traits

OBJECT

id

INTEGER

sku

STRING

location_identifier

OBJECT

id

INTEGER

name_key

OBJECT

facility_identifier

OBJECT

id

INTEGER

name

STRING

name

STRING

lot_number

STRING

pallet_identifier

OBJECT

id

INTEGER

name_key

OBJECT

facility_identifier

OBJECT

id

INTEGER

name

STRING

name

STRING

qualifier

STRING

serial_number

STRING

loaded_out

BOOLEAN

properly_picked_primary

NUMBER

properly_picked_secondary

NUMBER

qty

NUMBER

receive_item_id

INTEGER

estimated_qty

NUMBER

estimated_secondary_qty

NUMBER

full_allocated

BOOLEAN

is_order_qty_secondary

BOOLEAN

order_item_id

INTEGER

pick_exceptions

ARRAY

expiration_date

DATE-TIME

location_id

INTEGER

lot_number

STRING

order_id

INTEGER

order_item_id

INTEGER

order_item_pick_exception_id

INTEGER

picked_primary_qty

NUMBER

picked_secondary_qty

NUMBER

reason

STRING

receive_item_id

INTEGER

serial_number

STRING

secondary_unit_identifier

OBJECT

unit_identifier

OBJECT

id

INTEGER

name

STRING

saved_elements

ARRAY

name

STRING

value

STRING

secondary_qty

NUMBER

serial_number

STRING

weight_imperial

NUMBER

weight_metric

NUMBER

outbound_serial_numbers

ARRAY

item_identifier

OBJECT

id

INTEGER

sku

STRING

qualifier

STRING

serial_numbers

ARRAY

pack_done_date

DATE-TIME

packages

ARRAY

cod

BOOLEAN

cod_amount

NUMBER

create_date

DATE-TIME

description

STRING

height

NUMBER

insured_amount

NUMBER

label

STRING

length

NUMBER

oversize

BOOLEAN

package_contents

ARRAY

create_date

DATE-TIME

expiration_date

DATE-TIME

lot_number

STRING

order_item_id

INTEGER

order_item_pick_exception_id

INTEGER

package_content_id

INTEGER

package_id

INTEGER

qty

NUMBER

receive_item_id

INTEGER

serial_number

STRING

serial_numbers

ARRAY

package_id

INTEGER

package_type_id

INTEGER

tracking_number

STRING

ucc128

INTEGER

weight

NUMBER

width

NUMBER

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

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

saved_elements

ARRAY

name

STRING

value

STRING

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

external_id

STRING

id

INTEGER

name

STRING

name

STRING

number

STRING

same_as

INTEGER

state

STRING

title

STRING

zip

STRING

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

status

INTEGER

total_volume

NUMBER

total_weight

NUMBER

transaction_entry_type

INTEGER

unit2_identifier

OBJECT

id

INTEGER

name

STRING

up_service_option_charge

NUMBER

up_transportation_charge

NUMBER

ups_is_residential

NUMBER

warehouse_transaction_source_type

INTEGER

sku_items

This table contains information about SKU items.

Replication Method

Key-based Incremental

Primary Key

item_id

Replication Key

last_modified_date

Useful links

3PL Central documentation

sku_items schema on GitHub

3PL Central API method

Join sku_items with on
customers
sku_items.customer_id = customers.customer_id
sku_items.customer_identifier.id = customers.customer_id
sku_items.options.directed_put_away.preferred_location_identifier.name_key.facility_identifier.id = customers.facilities.id
sku_items.options.directed_put_away.preferred_location_identifier.name_key.facility_identifier.id = customers.primary_facility_identifier.id
stock_details
sku_items.customer_id = stock_details.customer_id
sku_items.customer_identifier.id = stock_details.customer_id
sku_items.options.directed_put_away.preferred_location_identifier.name_key.facility_identifier.id = stock_details.location_identifier.name_key.facility_identifier.id
sku_items.options.directed_put_away.preferred_location_identifier.name_key.facility_identifier.id = stock_details.pallet_identifier.name_key.facility_identifier.id
sku_items.item_id = stock_details.item_identifier.id
sku_items.kit.components.item_identifier.id = stock_details.item_identifier.id
sku_items.options.directed_put_away.preferred_location_identifier.id = stock_details.location_identifier.id
inventory
sku_items.customer_id = inventory.customer_identifier.id
sku_items.customer_identifier.id = inventory.customer_identifier.id
sku_items.options.directed_put_away.preferred_location_identifier.name_key.facility_identifier.id = inventory.facility_identifier.id
sku_items.options.directed_put_away.preferred_location_identifier.name_key.facility_identifier.id = inventory.location_identifier.name_key.facility_identifier.id
sku_items.options.directed_put_away.preferred_location_identifier.name_key.facility_identifier.id = inventory.pallet_identifier.name_key.facility_identifier.id
sku_items.item_id = inventory.item_identifier.id
sku_items.kit.components.item_identifier.id = inventory.item_identifier.id
sku_items.options.directed_put_away.preferred_location_identifier.id = inventory.location_identifier.id
locations
sku_items.customer_id = locations.customer_identifier.id
sku_items.customer_identifier.id = locations.customer_identifier.id
sku_items.options.directed_put_away.preferred_location_identifier.name_key.facility_identifier.id = locations.facility_id
sku_items.options.directed_put_away.preferred_location_identifier.name_key.facility_identifier.id = locations.item_traits.pallet_identifier.name_key.facility_identifier.id
sku_items.options.directed_put_away.preferred_location_identifier.name_key.facility_identifier.id = locations.location_identifier.name_key.facility_identifier.id
sku_items.item_id = locations.item_traits.item_identifier.id
sku_items.options.directed_put_away.preferred_location_identifier.id = locations.location_id
sku_items.options.directed_put_away.preferred_location_identifier.id = locations.location_identifier.id
orders
sku_items.customer_id = orders.customer_identifier.id
sku_items.customer_identifier.id = orders.customer_identifier.id
sku_items.customer_id = orders.batch_identifier.name_key.customer_identifier.id
sku_items.customer_identifier.id = orders.batch_identifier.name_key.customer_identifier.id
sku_items.customer_id = orders.ship_to.retailer_info.name_key.customer_identifier.id
sku_items.customer_identifier.id = orders.ship_to.retailer_info.name_key.customer_identifier.id
sku_items.options.directed_put_away.preferred_location_identifier.name_key.facility_identifier.id = orders.facility_identifier.id
stock_summaries
sku_items.options.directed_put_away.preferred_location_identifier.name_key.facility_identifier.id = stock_summaries.facility_id
sku_items.item_id = stock_summaries.item_id

account_ref

STRING

classification_identifier

OBJECT

cost

NUMBER

country_of_manufacture

STRING

creation_date

DATE-TIME

customer_id

INTEGER

customer_identifier

OBJECT

external_d

STRING

id

INTEGER

name

STRING

deactivated

BOOLEAN

description

STRING

description2

STRING

harmonized_code

STRING

inventory_category

STRING

item

ARRAY

qualifier

STRING

item_id

INTEGER

kit

OBJECT

components

ARRAY

item_identifier

OBJECT

id

INTEGER

sku

STRING

non_sku_material

STRING

qty

NUMBER

qualifier

STRING

material_notes

STRING

last_modified_date

DATE-TIME

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

id

INTEGER

name_key

OBJECT

facility_identifier

OBJECT

id

INTEGER

name

STRING

name

STRING

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

inventory_unit

OBJECT

inventory_method

INTEGER

maximum_stock

NUMBER

minimum_stock

NUMBER

reorder_quantity

NUMBER

unit_identifier

OBJECT

id

INTEGER

name

STRING

package_unit

OBJECT

imperial

OBJECT

height

NUMBER

length

NUMBER

net_weight

NUMBER

weight

NUMBER

width

NUMBER

metric

OBJECT

height

NUMBER

length

NUMBER

net_weight

NUMBER

weight

NUMBER

width

NUMBER

unit_identifier

OBJECT

id

INTEGER

name

STRING

upc

STRING

pallets

OBJECT

high

NUMBER

imperial

OBJECT

height

NUMBER

length

NUMBER

weight

NUMBER

width

NUMBER

metric

OBJECT

height

NUMBER

length

NUMBER

weight

NUMBER

width

NUMBER

qyt

NUMBER

tie

NUMBER

type_identifier

OBJECT

id

INTEGER

name

STRING

upc

STRING

secondary_unit

OBJECT

inventory_also

BOOLEAN

inventory_units_per_unit

NUMBER

unit_identifier

OBJECT

id

INTEGER

name

STRING

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

price

NUMBER

qualifier_renamers

ARRAY

qualifier

STRING

rename

STRING

sku

STRING

temperature

NUMBER

upc

STRING

stock_details

This table contains information about stock details.

Replication Method

Full Table

Primary Key

receive_item_id

Useful links

3PL Central documentation

stock_details schema on GitHub

3PL Central API method

Join stock_details with on
customers
stock_details.customer_id = customers.customer_id
stock_details.location_identifier.name_key.facility_identifier.id = customers.facilities.id
stock_details.pallet_identifier.name_key.facility_identifier.id = customers.facilities.id
stock_details.location_identifier.name_key.facility_identifier.id = customers.primary_facility_identifier.id
stock_details.pallet_identifier.name_key.facility_identifier.id = customers.primary_facility_identifier.id
sku_items
stock_details.customer_id = sku_items.customer_id
stock_details.customer_id = sku_items.customer_identifier.id
stock_details.location_identifier.name_key.facility_identifier.id = sku_items.options.directed_put_away.preferred_location_identifier.name_key.facility_identifier.id
stock_details.pallet_identifier.name_key.facility_identifier.id = sku_items.options.directed_put_away.preferred_location_identifier.name_key.facility_identifier.id
stock_details.item_identifier.id = sku_items.item_id
stock_details.item_identifier.id = sku_items.kit.components.item_identifier.id
stock_details.location_identifier.id = sku_items.options.directed_put_away.preferred_location_identifier.id
inventory
stock_details.customer_id = inventory.customer_identifier.id
stock_details.location_identifier.name_key.facility_identifier.id = inventory.facility_identifier.id
stock_details.pallet_identifier.name_key.facility_identifier.id = inventory.facility_identifier.id
stock_details.location_identifier.name_key.facility_identifier.id = inventory.location_identifier.name_key.facility_identifier.id
stock_details.pallet_identifier.name_key.facility_identifier.id = inventory.location_identifier.name_key.facility_identifier.id
stock_details.location_identifier.name_key.facility_identifier.id = inventory.pallet_identifier.name_key.facility_identifier.id
stock_details.pallet_identifier.name_key.facility_identifier.id = inventory.pallet_identifier.name_key.facility_identifier.id
stock_details.item_identifier.id = inventory.item_identifier.id
stock_details.location_identifier.id = inventory.location_identifier.id
stock_details.pallet_identifier.id = inventory.pallet_identifier.id
stock_details.receiver_id = inventory.receiver_id
stock_details.receive_item_id = inventory.receive_item_id
stock_details.supplier_identifier.id = inventory.supplier_identifier.id
locations
stock_details.customer_id = locations.customer_identifier.id
stock_details.location_identifier.name_key.facility_identifier.id = locations.facility_id
stock_details.pallet_identifier.name_key.facility_identifier.id = locations.facility_id
stock_details.location_identifier.name_key.facility_identifier.id = locations.item_traits.pallet_identifier.name_key.facility_identifier.id
stock_details.pallet_identifier.name_key.facility_identifier.id = locations.item_traits.pallet_identifier.name_key.facility_identifier.id
stock_details.location_identifier.name_key.facility_identifier.id = locations.location_identifier.name_key.facility_identifier.id
stock_details.pallet_identifier.name_key.facility_identifier.id = locations.location_identifier.name_key.facility_identifier.id
stock_details.location_identifier.id = locations.location_id
stock_details.location_identifier.id = locations.location_identifier.id
stock_details.pallet_identifier.id = locations.item_traits.pallet_identifier.id
orders
stock_details.customer_id = orders.customer_identifier.id
stock_details.customer_id = orders.batch_identifier.name_key.customer_identifier.id
stock_details.customer_id = orders.ship_to.retailer_info.name_key.customer_identifier.id
stock_details.location_identifier.name_key.facility_identifier.id = orders.facility_identifier.id
stock_details.pallet_identifier.name_key.facility_identifier.id = orders.facility_identifier.id
stock_summaries
stock_details.location_identifier.name_key.facility_identifier.id = stock_summaries.facility_id
stock_details.pallet_identifier.name_key.facility_identifier.id = stock_summaries.facility_id

available

NUMBER

cost

NUMBER

customer_id

INTEGER

description

STRING

expiration_date

DATE-TIME

inventory_unit_of_measure_identifier

OBJECT

is_on_hold

BOOLEAN

item_identifier

OBJECT

id

INTEGER

sku

STRING

location_identifier

OBJECT

id

INTEGER

name_key

OBJECT

facility_identifier

OBJECT

id

INTEGER

name

STRING

name

STRING

lot_number

STRING

on_hand

NUMBER

pallet_identifier

OBJECT

id

INTEGER

name_key

OBJECT

facility_identifier

OBJECT

id

INTEGER

name

STRING

name

STRING

po_num

STRING

qualifier

STRING

quarantined

BOOLEAN

receive_item_id

INTEGER

received

NUMBER

received_date

DATE-TIME

receiver_id

INTEGER

reference_num

STRING

saved_elements

ARRAY

name

STRING

value

STRING

serial_number

STRING

supplier_identifier

OBJECT

id

INTEGER

name

STRING

trailer_number

STRING

stock_summaries

This table contains information about stock summaries.

Replication Method

Full Table

Primary Keys

facility_id

item_id

Useful links

3PL Central documentation

stock_summaries schema on GitHub

3PL Central API method

Join stock_summaries with on
customers
stock_summaries.facility_id = customers.facilities.id
stock_summaries.facility_id = customers.primary_facility_identifier.id
inventory
stock_summaries.facility_id = inventory.facility_identifier.id
stock_summaries.facility_id = inventory.location_identifier.name_key.facility_identifier.id
stock_summaries.facility_id = inventory.pallet_identifier.name_key.facility_identifier.id
locations
stock_summaries.facility_id = locations.facility_id
stock_summaries.facility_id = locations.item_traits.pallet_identifier.name_key.facility_identifier.id
stock_summaries.facility_id = locations.location_identifier.name_key.facility_identifier.id
stock_summaries.item_id = locations.item_traits.item_identifier.id
orders
stock_summaries.facility_id = orders.facility_identifier.id
sku_items
stock_summaries.facility_id = sku_items.options.directed_put_away.preferred_location_identifier.name_key.facility_identifier.id
stock_summaries.item_id = sku_items.item_id
stock_details
stock_summaries.facility_id = stock_details.location_identifier.name_key.facility_identifier.id
stock_summaries.facility_id = stock_details.pallet_identifier.name_key.facility_identifier.id

allocated

NUMBER

available

NUMBER

facility_id

INTEGER

item_id

INTEGER

item_identifier

OBJECT

id

INTEGER

sku

STRING

on_hand

NUMBER

on_hold

NUMBER

qualifier

STRING

total_received

NUMBER


Questions? Feedback?

Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.