2.1. (Optional) Register Custom TikTok Shop App

Before configuring in Odoo, if you decide to use your own private developer app, you need to create an app on TikTok Shop Partner Center:

1. Go to https://partner.tiktokshop.com , create new account if you do not have one

2. You will enter home screen like this -> hit button Add category and market

3. Choosing Bussiness guide, i suggest For app developer to easily configuration

4. After that fill in the information in this form

5. For bussiness category, choose Tiktok shop parter and App Developer

6. Go to App & Service to create a new app like following image, remember to choose correct market and enable api and the callback url must follow https://your-odoo-domain.com/tiktok_shop/auth/callback

7. Activate the scope, go to Manage API and activate following scopes: Finance Information, Global Product Delete, Global Product Information, Global Product Modify, Global Shop Information, Logistics Basic, Fulfillment Basic Order Information, Product Basic, Product Delete & Recover, Product Modify, Return & Refund Basic, Shop Authorized Information, TikTok Shop Analytics, Awaiting submission, Update Delivery Status

2.3. Configure Custom Credentials in Odoo

If you chose to use the IAP Proxy with your License Key, you DO NOT need to fill anything in this step. If you are using your custom app:

1. Install the d_tiktok_shop_connector module
2. Go to Sales -> Configuration -> Settings -> TikTok Shop Section (or simply Seller Accounts list)
3. Click on the Connect TikTok Shop button and enter the following information:
   • App Key: From TikTok Shop Partner Center
   • App Secret: From TikTok Shop Partner Center
   • Service ID: From TikTok Shop Partner Center
   • Region: Choose US or Non-US depending on your region

4. Click Connect To TikTok Shop to authenticate

2.4. Connect Seller Account

After authentication, you will be redirected to the TikTok Shop authentication page:

1. Log in to your TikTok Shop account
2. Select the correct market of your tiktok shop, ex: you are selling in Vietnam you should select Vietnam
3. Grant permissions to the app
4. After successful authentication, you will be redirected back to Odoo
5. Seller account and shops will be automatically synchronized

3.1. View Shop List

1. Go to Sales -> Configuration -> TikTok Shop -> Shops
2. You will see a list of synchronized TikTok Shops
3. Each shop will display:
   • Shop name
   • Shop ID
   • Region
   • Seller type

3.2. Configure Shop

Open the shop form to configure:

1. Sync Inventory: Enable/disable inventory synchronization, this option will help you sync all product with variant and inventory (quantity) from tiktok shop to odoo
2. Sales Team: Choose default sales team
3. Salesperson: Choose default salesperson
4. Order Prefix: Set a custom prefix for sales orders generated from this shop (e.g., "TK-")
5. Analytic Account: Assign an analytic account to track financial data and revenues for this shop
6. Last Order Sync Date: This field shows when the last order synchronization was performed. The system uses this date to fetch only new orders since the last sync, improving performance and avoiding duplicate orders.
7. Last Inventory Sync Date: This field shows when the last inventory synchronization was performed. Similar to order sync, this helps track when inventory levels were last updated between Odoo and TikTok Shop.

These date fields are automatically updated whenever a synchronization occurs, either manually or through scheduled jobs. They are useful for troubleshooting and monitoring the synchronization process.

3.3. Advanced Tracking (Prefix & Analytic)

To better manage and track data across multiple shops:

1. Open the TikTok Shop form and navigate to the Shop Setting tab
2. Order Prefix: Configure a prefix like TK-. All sales orders created from this shop will bear this prefix, helping you quickly spot TikTok orders in the sales list.
3. Analytic Account: Assign an Analytic Account. The system will automatically use it for sales order lines and vendor bills (the commission fees), allowing you to evaluate precise profit and loss for each shop.

4. In order to activate analytic feature of odoo, you need to activate analytic accounting see https://www.odoo.com/documentation/master/applications/finance/accounting/reporting/analytic_accounting.html

4.1. Manual Synchronization

1. Open the TikTok Shop form
2. Click the Sync Orders button
3. Odoo will fetch new orders from TikTok Shop

4.2. Automatic Synchronization

The module has pre-configured scheduled jobs to synchronize orders every hour. You can adjust the synchronization frequency at:

1. Go to Settings -> Technical -> Automation -> Scheduled Actions
2. Find the job start with TikTok
3. Adjust the frequency as needed

4.3. View TikTok Orders

1. Go to Sales -> Orders
2. Use the "TikTok Orders" filter to view orders from TikTok Shop
3. Each order will display: - TikTok Order ID - TikTok Status - TikTok Shop

4.4. Order Processing Flow

When an order is synchronized from TikTok Shop to Odoo, the following automated workflow takes place:

1. Order Creation:
   • A sales order is created in Odoo with all product lines from TikTok Shop
   • Customer information is imported and linked to the order
   • TikTok order status is recorded on the Odoo order
2. Delivery Processing:
   • A delivery order (outgoing picking) is automatically created
   • When TikTok status changes to DELIVERED or COMPLETED, the delivery is marked as done
   • Tracking information is synchronized between systems
3. Return Handling (if applicable):
   • If a return request exists in TikTok Shop, it's imported to Odoo
   • For undelivered orders: The original delivery order is updated to remove returned items
   • For delivered orders: A return picking (incoming) is created to receive returned products
   • Return reason and status are tracked in the system
4. Invoice Generation (when order is completed):
   • When TikTok status changes to "COMPLETED": - A customer invoice is automatically created - The invoice is validated - Payment is registered
5. TikTok Fee Processing:
   • Financial data is retrieved from TikTok Shop API
   • A vendor bill is created with "TikTok Platform" as vendor
   • The bill records commission fees charged by TikTok Shop
   • This ensures accurate accounting of all TikTok-related expenses

4.5. Arrange Shipment & Print Shipping Documents

After packing the order and preparing for delivery, you need to notify TikTok Shop to arrange transportation:

1. Arrange Shipment:
   • Go to Inventory -> Operations -> Transfers or the Delivery Smart Button of tiktok order
   • Locate the delivery order related to the TikTok Shop order
   • Click the Arrange Shipment button
   • In the wizard that appears, you have two delivery method options: - Pickup: The carrier will come to your warehouse to pick up the goods. This is a common choice for large order volumes. - Drop Off: You will bring the package to the carrier’s drop-off point. Suitable for smaller order quantities.
   • After confirmation, the order status on TikTok Shop will change to Awaiting Collection, indicating that the carrier has been notified and will pick up the goods according to the scheduled time.

2. Download Shipping Documents:

   • After arranging the shipment, you need to print the shipping documents

   • In the delivery screen, click the Download TikTok Shipping Document button

   • In the wizard that appears, you can configure: - Document Type:

     • SHIPPING_LABEL: Shipping label in PDF format (default)
     • PACKING_SLIP: Packing slip in PDF format
     • SHIPPING_LABEL_AND_PACKING_SLIP: Both shipping label and packing slip
     • SHIPPING_LABEL_PICTURE: Shipping label in PNG image format
     • HAZMAT_LABEL: Hazardous material label (applicable only for packages containing hazardous materials)
     • INVOICE_LABEL: Invoice label (applicable only for the Brazil market)
     • SHIPPING_LABEL_INDICATION_SLIP: Shipping label indication slip
     • CUSTOMS_DECLARATION: Customs declaration
     • PHYSICAL_LABEL: Physical label

     • Document Size: A4, A5, A6 (default), or 4x6 inches
     • Document Format: PDF (default) or ZPL (only for the Brazil market)

   • Click Download Document to download the shipping documents

   • If you select multiple delivery orders, the documents will be automatically downloaded and compressed into a single ZIP file for convenience.

   • The system will automatically update the tracking number from TikTok Shop if available

Note: The shipping label must be printed and attached to the package before handing it over to the carrier. This ensures a smooth tracking and delivery process.

After the carrier picks up the package, the package status will automatically update to "FULFILLING" (In transit) on the TikTok Shop system and will sync to Odoo during the next order synchronization.

4.6. Bulk Download Documents in ZIP

You can download shipping documents for multiple packages simultaneously to save time:

1. Go to Inventory -> Operations -> Deliveries (or TikTok Orders view)
2. Select multiple delivery orders from the list view
3. Click Action -> Download TikTok Shipping Documents
4. Select your document format
5. The system will download all documents from TikTok API, compress them into a single ZIP file, and provide a direct download link.
6. Individual documents also remain attached to each related delivery order's chatter for future reference.

5.1. Manual Inventory Synchronization

1. Open the TikTok Shop form
2. Click the Sync Inventory button
3. Odoo will update inventory to TikTok Shop

5.2. Automatic Inventory Synchronization

The module has pre-configured scheduled jobs to synchronize inventory every hour. You can adjust the frequency similar to order synchronization.

5.3. TikTok Warehouse in Odoo

When synchronizing, the module creates TikTok warehouses in Odoo to track inventory accurately:

1. Go to Inventory -> Configuration -> Warehouses
2. Find warehouses with names starting with "TikTok Shop"

6.1. Map Existing Odoo Products with TikTok Products

If you already have existing products in Odoo and want to map them with TikTok products so that syncing orders will not create new duplicate products, please follow these steps:

• STEP 1: Depending on whether your products use variants or not, if they use variants, first you need to export all your variants including the External ID and the Internal Reference. Remember to add the column Tiktok Sku ID too. Use the same export template for Product Template if your database is not using variants.

  

• STEP 2: Go to your TikTok Shop product management page to export all the SKUs of all products.

  

• STEP 3: Update the Excel/CSV file exported from Odoo to fill in the TikTok Product ID and TikTok SKU ID.

• STEP 4: Import the file back into Odoo to update the TikTok ID and TikTok SKU ID for all your products. Now, when you sync orders, it will correctly map to your existing products instead of creating new ones.

6.2. Product Creation and Management

The module provides comprehensive tools for managing your products on TikTok Shop, including:

1. Automatic Product Creation: When you assign a TikTok Shop to a product in Odoo, the system will automatically mark it for creation on TikTok. This happens through a scheduled job that runs every 15 minutes.
2. Manual Product Creation: You can manually trigger product creation by clicking the Create on TikTok button on the product form.
3. Product Updates: Any changes to product information (name, description, price, etc.) are automatically detected and scheduled for synchronization with TikTok Shop.
4. Video Upload: You can upload a product video (MP4 format) directly from Odoo. After successful synchronization, the video will be uploaded to TikTok Shop, and the TikTok Video ID and URL will be automatically retrieved.
5. Product Deletion: You can delete products from TikTok by clicking the Delete from TikTok button or by deleting the product in Odoo, which will automatically remove it from TikTok as well.

6.3. Product Audit Process

All products on TikTok Shop go through an audit process:

1. Audit Status Tracking: After creating a product on TikTok, it enters the audit process. The audit status is automatically tracked and updated in Odoo.
2. Audit Notifications: The system displays notifications on the product form showing the current audit status: - Under Review: The product is being reviewed by TikTok - Approved: The product has passed audit and can be activated - Failed: The product failed audit with detailed reasons
3. Automatic Status Updates: A scheduled job runs every 5 minutes to check the audit status of products under review, updating their status in Odoo.
4. Manual Status Check: You can manually check the audit status by clicking the Check Audit Status button on the product form.

6.4. Product Synchronization Flow

The product synchronization follows this workflow:

1. Assign TikTok Shop: Select a TikTok Shop on the product form
2. Auto-Creation: The system marks the product for creation on TikTok
3. Audit Process: Product enters TikTok's audit queue
4. Status Updates: Audit status is automatically checked and updated
5. Automatic Updates: Any changes to the product in Odoo are synchronized to TikTok including inventory update

This automated system ensures that your product catalog stays in sync between Odoo and TikTok Shop with minimal manual intervention.

6.5. Product Video Upload

You can enhance your product listing by uploading videos directly from Odoo:

1. Open the Product Template form and ensure it is assigned to a TikTok Shop
2. Under the TikTok Shop settings, locate the Video Information group
3. Use the Video File field to upload your video (Supports .mp4, .mov, .mkv, .wmv, .webm)
4. When the product syncs with TikTok, the video will be uploaded automatically
5. The TikTok Video ID and TikTok Video URL will be fetched from TikTok once the processing is complete.

7.1. View Return Requests

1. Go to Sales -> Configuration -> TikTok Shop -> Returns
2. You will see a list of return requests from TikTok Shop
3. Each request will display: - Return ID - Related order - Return status - Return type - Return reason

8.1. Automatic Customer Invoices

When a TikTok order changes to "COMPLETED" status, the module will automatically:

1. Create a customer invoice
2. Confirm the invoice
3. Create payment

8.2. Vendor Bills for TikTok Fees

The module also automatically creates vendor bills for TikTok fees:

1. Call TikTok financial API to get fee information
2. Create vendor bill with "TikTok Platform" as the vendor
3. Record TikTok commission fees

8.3. View Financial Data

1. Open a TikTok order
2. Go to the "TikTok Shop Order" tab
3. View the "Finance Data" section for details about TikTok fees

9.1. Authentication Errors

Issue: Cannot connect to TikTok Shop

Solution: - Check App Key and App Secret - Ensure Callback URL is correctly configured - Check app permissions

9.2. Order Synchronization Errors

Issue: Orders are not synchronized

Solution: - Check authentication token (may have expired) - Check error logs in Odoo - Ensure TikTok Shop is active

9.3. Inventory Synchronization Errors

Issue: Inventory is not updated to TikTok Shop

Solution: - Check inventory synchronization configuration - Ensure products have SKUs matching TikTok Shop - Check error logs in Odoo

9.4. Product Audit Errors

Issue: Products fail TikTok audit

Solution: - Review the audit failure reasons displayed on the product form - Make necessary corrections to comply with TikTok's requirements - Update the product and resubmit for audit - Ensure your brand is authorized if required