Schema Information for TikTok Shop
Schema Information for TikTok Shop
In this article, we will look at the schema information of the supported APIs and tables for TikTok Shop.
Find the links to other articles related to TikTok Shop below:
Tables/APIs
The tables and APIs associated with the TikTok Shop connector are as follows:
Naming Convention
US Marketplace: Table names follow a standard format. For example: Orders.
UK Marketplace: Table names have a _UK suffix. For example: Orders_UK.
MX Marketplace: Table names have a _MX suffix. For example: Orders_MX.
Orders
Purpose: Get list of all orders.
Source API Documentation: Orders
Replication Type: Key Based Replication
Replication Key: Updated DateTime
Primary Key: id; TikTok Shop order ID
Schema Detail: Orders Schema
Products
Purpose: Fetches List of all products.
Source API Documentation: Products
Replication Type: Key Based Replication
Replication Key: Updated DateTime
Primary Key: id; TikTok Shop product ID
Schema Detail: Products Schema
Packages
Purpose: Retrieves list of packages.
Source API Documentation: Packages
Replication Type: Key Based Replication
Replication Key: Updated DateTime
Primary Key: id; TikTok Shop package ID
Schema Detail: Packages Schema
Withdrawals
Purpose: Get list of the withdrawal records.
Source API Documentation: Withdrawls
Replication Type: Key Based Replication
Replication Key: Created DateTime
Primary Key: id; TikTok Shop unique transaction ID
Schema Detail: Withdrawal Schema
Statements
Purpose: Retrieves statements generated for a shop and key statement information.
Source API Documentation: Statements
Replication Type: Key Based Replication
Replication Key: Created DateTime
Primary Key: id; TikTok Shop statement ID
Schema Detail: Statements Schema
Payments
Purpose: Retrieves records of payments for a shop.
Source API Documentation: Payments
Replication Type: Key Based Replication
Replication Key: Created DateTime
Primary Key: id; TikTok Shop payment ID
Schema Detail: Payments Schema
Product_Details
Purpose: Retrieves all properties of a product using product Id.
Source API Documentation: Product Details
Replication Type: Key Based Replication
Replication Key: Updated DateTime
Primary Key: id; TikTok Shop Product ID
Schema Detail: Product Details Schema
Order_Statement_Transactions
Purpose: Retrieves the transactions associated with an order.
Source API Documentation: Order Statement Transactions
Replication Type: Key Based Replication
Replication Key: Updated DateTime
Primary Key: order_id; TikTok Shop Order Id
Schema Detail: Order Statement Transactions Schema
Returns
Purpose: Get list of all returns.
Source API Documentation: Returns
Replication Type: Key Based Replication
Replication Key: Updated DateTime
Primary Key: return_id
Schema Detail: Returns Schema
Inventory
Purpose: Retrieves inventory information using product Id.
Source API Documentation: Inventory
Replication Type: Key Based Replication
Replication Key: Updated DateTime
Primary Key: id; TikTok Shop product Id
Schema Detail: Inventory Schema
Note: Inventory table is currently unavailable for UK and MX Marketplace.
FBT_Inventory
Purpose: Retrieves inventory information for goods at the warehouse level.
Source API Documentation: FBT_Inventory
Replication Type: None
Replication Key: -
Primary Key: fbt_warehouse_id
Schema Detail: FBT Inventory Schema
Note: FBT_Inventory table is currently unavailable for the UK and MX Marketplace.
FBT_Inventory_Record
Purpose: Retrieves inventory change records for goods at the warehouse level.
Source API Documentation: FBT_Inventory_Record
Replication Type: Key Based Replication
Replication Key: Created DateTime
Primary Key: fbt_warehouse_id
Schema Detail: FBT Inventory Record Schema
Note: FBT_Inventory table is currently unavailable for UK and MX Marketplace.
FBT_Warehouse
Purpose: Retrieves all fulfilled by TikTok warehouse information.
Source API Documentation: FBT_Warehouse
Replication Type: None
Replication Key: -
Primary Key: fbt_warehouse_id
Schema Detail: FBT Warehouse Schema
Note: FBT_Warehouse table is currently unavailable for UK and MX Marketplace.
Authorized_Shops
Purpose: Retrieves all active shops that belong to a seller.
Source API Documentation: Authorized_Shops
Replication Type: None
Replication Key: -
Primary Key: id
Note: Authorized_Shops table is currently unavailable for UK and MX Marketplace.