Configure TikTok Shop Partner Center as a Source in your Pipeline

Perform the following steps to configure your TikTok Shop Partner Center Source:

1. Click Pipelines in the Navigation Bar.

2. Click + Create Pipeline in the Pipelines List View.

3. On the Select Source Type page, select TikTok Shop Partner Center.

4. On the Select Destination Type page, select the type of Destination you want to use.

5. In the Configure Source screen, specify the following:

   

   • Source Name: A unique name for your Source, not exceeding 255 characters. For example, TikTok Shop Partner Center Source.

   • In the Connect to your TikTok Shop account section, specify the following:

     • App Key: The App key that you obtained from your app in Partner Center.

     • App Secret: The App secret of your app.

     • Authorization URL: The authorization link of your app. For example, https://services.tiktokshop.com/open/authorize?service_id=<your service id>.

     • Click Authorize Your TikTok Shop Account, log in with the main account of your TikTok Shop seller, and authorize the app to access your shop. The button is available once you specify the App Key, App Secret, and Authorization URL.

   • In the Select your shop section, which appears after you authorize your account, specify the following:

     • Shop: The shop from which you want to ingest data. The list contains the shops that you authorized the app to access. If you authorized only one shop, you can leave this field blank. If you authorized more than one shop, you must select one.

   • (Optional) In the External orders (optional) section, specify the following:

     • External order platforms: The systems from which the external order references of your orders were added, such as Shopify or ERP System. You can select one or more platforms. You must select at least one platform to ingest data for the external_order object.

6. Click Test & Continue to test the connection to your TikTok Shop Partner Center Source. Once the test is successful, you can proceed to set up your Destination.

Test & Continue

When you click this button, Hevo performs the following validations:

• The App Key and App Secret are specified, and you authorized your TikTok Shop account.

• The Shop Authorized Information scope is granted to the app.

• Hevo can retrieve the list of shops that you authorized, and the authorization includes at least one shop.

• The shop that you selected is still accessible. If you did not select a shop, the authorization includes only one shop.

Data Replication

Hevo replicates data for all the objects selected on the Configure Objects page during Pipeline creation. By default, all supported objects and their available fields are selected. However, you can modify this selection while creating or editing the Pipeline. To select a child object, you must also select its parent object.

Hevo ingests the following types of data from your Source objects:

• Historical Data: The first run of the Pipeline ingests all the historical data of the selected objects that is available through the API. For the analytics objects, such as shop_product_performance, Hevo ingests the data from January 1, 2021.

• Incremental Data: Once the historical load is complete, Hevo ingests new and updated data as per the sync frequency:

  • orders, return, and cancellation: Hevo ingests the records created or updated since the previous run.

  • statement, transactions_by_statement, transactions_by_order_sku_transaction, and payment: Hevo ingests the data since the previous run, and also re-ingests the data of the last 2 days in each run and the last 7 days once a day, to capture late changes.

  • shop_product_performance, shop_video_performance, shop_sku_performance_interval, and shop_live_performance: Hevo re-ingests the data of the last 3 days in each run, and the last 7 days once a day, as TikTok Shop may update recent metrics.

  • external_order: Hevo ingests the external order references of the orders created or updated since the previous run.

  • coupon and shop_video_performance_detail_interval: Hevo ingests the entire data in each run.

Note: You can create a Pipeline with this Source only using the Merge load mode. The Append mode is not supported for this Source.

Schema and Primary Keys

Hevo uses the following schema to upload the records in the Destination. For a detailed view of the objects, fields, and relationships, click the ERD.

Click to view ERD

The primary key of most objects is id. The following objects use other primary keys:

• shop_product_performance and shop_video_performance: id, start_date, and end_date.

• shop_sku_performance_interval and shop_video_performance_detail_interval: The ID of the SKU or video, index, start_date, and end_date.

• transactions_by_order_sku_transaction: order_id and index.

• external_order: id and orders_id.

Data Model

The following is the list of tables (objects) that are created at the Destination when you run the Pipeline: