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 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:
-
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
This table contains information about customers.
Full Table |
|
Primary Key |
customer_id |
Useful links |
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
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_date DATE-TIME |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customer_id INTEGER |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivated BOOLEAN |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
external_id STRING |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
facilities
ARRAY
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
groups
ARRAY |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
options OBJECT
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
other_contacts
ARRAY
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
primary_contact OBJECT
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
primary_facility_identifier OBJECT
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
website STRING |
inventory
This table contains information about inventory resources.
Full Table |
|
Primary Key |
receive_item_id |
Useful links |
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
|
||||||
expiration_date DATE-TIME |
||||||
facility_identifier OBJECT
|
||||||
inventory_unit_of_measure_identifier OBJECT
|
||||||
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
|
||||||
pallet_identifier OBJECT
|
||||||
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
|
||||||
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.
Full Table |
|
Primary Keys |
location_id facility_id |
Useful links |
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
|
||||||||||||||
description STRING |
||||||||||||||
facility_id INTEGER |
||||||||||||||
item_traits OBJECT
|
||||||||||||||
location_id INTEGER |
||||||||||||||
location_identifier OBJECT
|
||||||||||||||
location_type_identifier OBJECT
|
||||||||||||||
on_hand NUMBER |
orders
This table contains information about orders.
Key-based Incremental |
|
Primary Key |
order_id |
Replication Key |
last_modified_date |
Useful links |
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
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bill_to OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
billing OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
billing_code STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_by_identifier OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_date DATE-TIME |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customer_identifier OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
defer_notification BOOLEAN |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
earliest_ship_date DATE-TIME |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
export_channel_identifier OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
export_module_ids STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
external_id STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
facility_identifier OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fulfill_inv_info OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
outbound_serial_numbers
ARRAY
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pack_done_date DATE-TIME |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
packages
ARRAY
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
saved_elements
ARRAY
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ship_cancel_date DATE-TIME |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ship_to OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shipping_notes STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sold_to OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status INTEGER |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total_volume NUMBER |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total_weight NUMBER |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
transaction_entry_type INTEGER |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
unit2_identifier OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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.
Key-based Incremental |
|
Primary Key |
item_id |
Replication Key |
last_modified_date |
Useful links |
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
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivated BOOLEAN |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description2 STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
harmonized_code STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
inventory_category STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
item
ARRAY
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
item_id INTEGER |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
kit OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_modified_date DATE-TIME |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_price_change DATE-TIME |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nmfc STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
options OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
price NUMBER |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
qualifier_renamers
ARRAY
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sku STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
temperature NUMBER |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
upc STRING |
stock_details
This table contains information about stock details.
Full Table |
|
Primary Key |
receive_item_id |
Useful links |
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
|
||||||
location_identifier OBJECT
|
||||||
lot_number STRING |
||||||
on_hand NUMBER |
||||||
pallet_identifier OBJECT
|
||||||
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
|
||||||
serial_number STRING |
||||||
supplier_identifier OBJECT
|
||||||
trailer_number STRING |
stock_summaries
This table contains information about stock summaries.
Full Table |
|
Primary Keys |
facility_id item_id |
Useful links |
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
|
||
on_hand NUMBER |
||
on_hold NUMBER |
||
qualifier STRING |
||
total_received NUMBER |
Related | Troubleshooting |
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.