TikTok Shop Partner Center

https://partner.tiktokshop.com/docv2/
Admin
TikTok Shop Partner Center is a comprehensive platform for service partners, sellers, and creators...
Tokens:289,767
Snippets:2,444
Trust Score:8.1
Update:1 month ago
Show doc for...
Tokens:
Raw
### Get Product Response (JSON)

Source: https://partner.tiktokshop.com/docv2/page/get-product

Example of a successful JSON response from the Get Product API.

```json
{
"code": 0,
"data": {
"audit": {
"pre_approved_reasons": [
"KYC_PENDING"
],
"status": "AUDITING",
"not_submitted_reasons": [
"SHOP_INACTIVE"
]
},
"audit_failed_reasons": [
{
"listing_platform": "TIKTOK_SHOP",
"position": "product",
"reasons": [
"violate listing rules"
],
"suggestions": [
"The product violates TikTok Shopping listing rules, please check and resubmit."
]
}
```

--------------------------------

### Get Product Request (cURL)

Source: https://partner.tiktokshop.com/docv2/page/get-product

Example of a GET request to retrieve product details using cURL.

```bash
curl -X GET \
'https://open-api.tiktokglobalshop.com/product/202309/products/1729592969712207008?app_key=38abcd&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&timestamp=1623812664&shop_cipher=GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3&return_under_review_version=true&return_draft_version=true&locale=en' \
-H 'x-tts-access-token: TTP_pwSm2AAAAABmmtFz1xlyKMnwg74T2GJ5s0uQbS8jPjb_GkdFVCxPqzQXSyuyfXdQa0AqyDsea2tYFNVf4XeqgZHFfPyv0Vs659QqyLYfsGzanZ5XZAin3_ZkcIxxS0_In6u6XDeU96k' \
-H 'content-type: application/json'
```

--------------------------------

### Get Reject Reasons Response Example

Source: https://partner.tiktokshop.com/docv2/page/get-reject-reasons-202309

Example JSON response containing the list of available reject reasons for an aftersales request.

```json
{
"code": 0,
"data": {
"reasons": [
{
"name": "seller_reject_apply_you_have_reached_an_agreement_with_the_buyer",
"text": "You have reached an agreement with the buyer"
}
]
},
"message": "Success",
"request_id": "202203070749000101890810281E8C70B7"
}
```

--------------------------------

### Get Product Info Request

Source: https://partner.tiktokshop.com/docv2/page/id-market-tokopedia-shop-open-api-integration-one-pager

Example HTTP GET request to retrieve product mapping information using product and shop IDs.

```http
GET /inventory/v1/fs/:fs_id/product/info?product=123456?shop_id=78910  
Authorization: Bearer {access_token}
```

--------------------------------

### Get Product API Response Example

Source: https://partner.tiktokshop.com/docv2/page/q50o39n1

Example JSON response from the GET /product/202309/products/{product_id} endpoint showing the audit.not_submitted_reasons field.

```json
{
  "code": 0,
  "message": "Success",
  "request_id": "your_request_id",
  "data": {
    "id": "1729592969712207008",
    "audit": {
      "status": "NONE",
      "not_submitted_reasons": [
        "SHOP_INACTIVE"
      ]
    }
  }
}
```

--------------------------------

### Run Demo with Environment Variables

Source: https://partner.tiktokshop.com/docv2/page/integrate-golang-sdk

Command to execute the Go application while providing necessary authentication credentials via environment variables.

```bash
TTS_APP_KEY="your_app_key" \
TTS_APP_SECRET="your_app_secret" \
TTS_AUTH_CODE="your_auth_code" \
go run .
```

--------------------------------

### Get Order Detail API request example

Source: https://partner.tiktokshop.com/docv2/page/delivery-instructions-now-available-in-orders-api

Example URL for the Get Order Detail API endpoint using version 202309.

```plaintext
https://open-api.tiktokglobalshop.com/order/202309/orders?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&timestamp=1625484268&ids=ids=1234565,123555
```

--------------------------------

### Run the Java SDK demo

Source: https://partner.tiktokshop.com/docv2/page/integrate-java-sdk

Set the required environment variables for authentication and execute the Maven build command. Ensure that real app secrets and tokens are not committed to source control.

```bash
export TTS_APP_KEY="YOUR_APP_KEY"  
export TTS_APP_SECRET="YOUR_APP_SECRET"  
export TTS_AUTH_CODE="AUTH_CODE_FROM_AUTHORIZATION_REDIRECT"  
  
mvn clean test
```

--------------------------------

### Install SDK with Maven

Source: https://partner.tiktokshop.com/docv2/page/integrate-java-sdk

Run this command in the SDK source directory to install the SDK locally.

```bash
mvn clean install
```

--------------------------------

### Get Order List API request example

Source: https://partner.tiktokshop.com/docv2/page/delivery-instructions-now-available-in-orders-api

Example URL for the Get Order List API endpoint using version 202309.

```plaintext
https://open-api.tiktokglobalshop.com/order/202309/orders/search?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&timestamp=1625484268
```

--------------------------------

### Project Directory Layout

Source: https://partner.tiktokshop.com/docv2/page/integrate-golang-sdk

Recommended folder structure for integrating the SDK into a Go project.

```text
my-project/  
  go.mod  
  main.go  
  sdk_golang/  
    apis/  
    models/  
    utils/  
    ...
```

--------------------------------

### Get Live Room View Trends Response Example

Source: https://partner.tiktokshop.com/docv2/page/get-live-room-view-trends-202502

Example JSON response structure for the Get Live Room View Trends API.

```json
{

```

--------------------------------

### Configure go.mod for SDK

Source: https://partner.tiktokshop.com/docv2/page/integrate-golang-sdk

Example go.mod file configuration to include the local SDK folder.

```go
module example.com/my-project  
  
go 1.22  
  
require tiktokshop/open/sdk_golang v1.0.0  
  
replace tiktokshop/open/sdk_golang => ./sdk_golang
```

--------------------------------

### TikTok Shop Java SDK Integration Example

Source: https://partner.tiktokshop.com/docv2/page/integrate-java-sdk

This example shows the full workflow of initializing the API client, obtaining an access token, fetching authorized shops, and searching for products. It requires environment variables for TTS_APP_KEY, TTS_APP_SECRET, and TTS_AUTH_CODE.

```java
import java.util.List;  
  
import tiktokshop.open.sdk_java.api.AuthorizationV202309Api;  
import tiktokshop.open.sdk_java.api.ProductV202502Api;  
import tiktokshop.open.sdk_java.invoke.AccessTokenAPI;  
import tiktokshop.open.sdk_java.invoke.ApiClient;  
import tiktokshop.open.sdk_java.invoke.ApiException;  
import tiktokshop.open.sdk_java.invoke.Configuration;  
import tiktokshop.open.sdk_java.invoke.ResponseInfo;  
import tiktokshop.open.sdk_java.model.Authorization.V202309.GetAuthorizedShopsResponse;  
import tiktokshop.open.sdk_java.model.Authorization.V202309.GetAuthorizedShopsResponseDataShops;  
import tiktokshop.open.sdk_java.model.Product.V202502.SearchProductsRequestBody;  
import tiktokshop.open.sdk_java.model.Product.V202502.SearchProductsResponse;  
  
public class Example {  
    private static final String CONTENT_TYPE = "application/json";  
    private static final String DEFAULT_BASE_PATH = "https://open-api.tiktokglobalshop.com";  
  
    public static void main(String[] args) throws Exception {  
        String appKey = requireEnv("TTS_APP_KEY");  
        String appSecret = requireEnv("TTS_APP_SECRET");  
        String authCode = requireEnv("TTS_AUTH_CODE");  
        String basePath = optionalEnv("TTS_OPEN_API_BASE_URL", DEFAULT_BASE_PATH);  
  
        AccessTokenAPI accessTokenAPI = new AccessTokenAPI(appKey, appSecret);  
        ResponseInfo tokenResponse = accessTokenAPI.getToken(authCode);  
        if (tokenResponse == null || tokenResponse.getCode() != 0 || tokenResponse.getData() == null  
                || tokenResponse.getData().getAccessToken() == null) {  
            String message = tokenResponse == null ? "null response" : tokenResponse.getMessage();  
            throw new IllegalStateException("Failed to get access token: " + message);  
        }  
  
        String accessToken = tokenResponse.getData().getAccessToken();  
  
        ApiClient defaultClient = Configuration.getDefaultApiClient()  
                .setAppkey(appKey)  
                .setSecret(appSecret)  
                .setBasePath(basePath);  
  
        String shopCipher = getFirstShopCipher(defaultClient, accessToken);  
        searchProducts(defaultClient, accessToken, shopCipher);  
    }  
  
    private static String getFirstShopCipher(ApiClient defaultClient, String accessToken) throws ApiException {  
        AuthorizationV202309Api authApi = new AuthorizationV202309Api(defaultClient);  
        GetAuthorizedShopsResponse shopsResponse =  
                authApi.authorization202309ShopsGet(accessToken, CONTENT_TYPE);  
  
        if (shopsResponse == null || shopsResponse.getCode() == null || shopsResponse.getCode() != 0) {  
            throw new IllegalStateException("Get Authorized Shops failed: " + shopsResponse);  
        }  
  
        if (shopsResponse.getData() == null || shopsResponse.getData().getShops() == null) {  
            throw new IllegalStateException("No authorized shops returned.");  
        }  
  
        List<GetAuthorizedShopsResponseDataShops> shops = shopsResponse.getData().getShops();  
        for (GetAuthorizedShopsResponseDataShops shop : shops) {  
            if (shop.getCipher() != null && !shop.getCipher().isEmpty()) {  
                System.out.println("Using authorized shop_id: " + shop.getId());  
                return shop.getCipher();  
            }  
        }  
  
        throw new IllegalStateException("No shop_cipher found in authorized shops.");  
    }  
  
    private static void searchProducts(ApiClient defaultClient, String accessToken, String shopCipher)  
            throws ApiException {  
        ProductV202502Api productApi = new ProductV202502Api(defaultClient);  
        SearchProductsRequestBody requestBody = new SearchProductsRequestBody();  
        requestBody.setStatus("ALL");  
  
        SearchProductsResponse result = productApi.product202502ProductsSearchPost(  
                1,  
                accessToken,  
                CONTENT_TYPE,  
                null,  
                shopCipher,  
                requestBody  
        );  
  
        System.out.println("Search Products response: " + result);  
    }  
  
    private static String requireEnv(String name) {  
        String value = System.getenv(name);  
        if (value == null || value.isEmpty()) {  
            throw new IllegalStateException("Missing required environment variable: " + name);  
        }  
        return value;  
    }  
  
    private static String optionalEnv(String name, String defaultValue) {  
        String value = System.getenv(name);  
        return value == null || value.isEmpty() ? defaultValue : value;  
    }  
}
```

--------------------------------

### Get Shop Info Request

Source: https://partner.tiktokshop.com/docv2/page/id-market-tokopedia-shop-open-api-integration-one-pager

Example HTTP GET request to retrieve shop mapping information.

```http
GET /v1/shop/fs/:fs_id/shop-info  
Authorization: Bearer {access_token}
```

--------------------------------

### POST /promotion/create

Source: https://partner.tiktokshop.com/docv2/page/create-promotion-activity-202309

Creates a new promotion activity with the specified configuration.

```APIDOC
## POST /promotion/create

### Description
Creates a new promotion activity for a shop.

### Request Body
- **title** (string) - Required - The name of the promotion activity.
- **activity_type** (string) - Required - The type of activity (e.g., FIXED_PRICE).
- **product_level** (string) - Required - The level at which the promotion applies (e.g., PRODUCT).
- **duration_type** (string) - Required - The duration type (e.g., INDEFINITE).
- **begin_time** (int) - Required - Start timestamp.
- **end_time** (int) - Required - End timestamp.
- **participation_limit** (array) - Required - List of participation constraints.
- **discount** (object) - Required - Discount configuration details.

### Request Example
{
  "title": "DiscountEvent0829",
  "activity_type": "FIXED_PRICE",
  "product_level": "PRODUCT",
  "duration_type": "INDEFINITE",
  "begin_time": 1661756811,
  "end_time": 1661856811,
  "participation_limit": [{"type": "BUYER_NO_LIMIT"}],
  "discount": {
    "shipping_discount": {
      "threshold_type": "MINIMAL_ITEM_QUANTITY",
      "threshold_value": "3",
      "type": "DISCOUNT_SHIPPING_FEE",
      "value": "10.5",
      "shipping_method": "STANDARD_SHIPPING"
    }
  }
}

### Response
#### Success Response (200)
- **code** (int) - Status code.
- **message** (string) - Success message.
- **data** (object) - Contains activity_id, create_time, update_time, and status.
```

--------------------------------

### Get Shipping Providers Response

Source: https://partner.tiktokshop.com/docv2/page/get-shipping-providers-202309

Example JSON response returned by the Get Shipping Providers API.

```json
{
"code": 0,
"data": {
"shipping_providers": [
{
"id": "7117858858072016686",
"name": "USPS"
}
]
},
"message": "Success",
"request_id": "202203070749000101890810281E8C70B7"
}
```

--------------------------------

### Initialize API Client

Source: https://partner.tiktokshop.com/docv2/page/integrate-golang-sdk

Code to create the API client using app credentials. Ensure appKey and appSecret are loaded before initialization.

```go
configuration := apis.NewConfiguration()  
configuration.AddAppInfo(appKey, appSecret)  
  
apiClient := apis.NewAPIClient(configuration)
```

--------------------------------

### Get Logistics Tracking Response Example

Source: https://partner.tiktokshop.com/docv2/page/get-logistics-tracking-202604

A JSON response example containing the logistics tracking details for an order.

```json
{
"code": 0,
"data": {
"order_id": "577071607420326620",
"logistics_details": [
{
"newest_tracking_no": "861651122474",
"carrier_name": "J&T Express",
"track_list": [
{
"description": "Package has been delivered!\\n",
"tracking_no": "861651122474",
"update_time_millis": 1694686949000,
"action_code": 50101,
"action_code_name": "signed_personally"
}
]
}
]
},
"message": "Success",
"request_id": "202203070749000101890810281E8C70B7"
}
```

--------------------------------

### Complete TikTok Shop Golang SDK Integration Demo

Source: https://partner.tiktokshop.com/docv2/page/integrate-golang-sdk

This example demonstrates the full lifecycle of a TikTok Shop API integration, including authentication, fetching authorized shops, and searching for products. It requires the TTS_APP_KEY, TTS_APP_SECRET, and TTS_AUTH_CODE environment variables to be set.

```go
package main  
  
import (  
    "context"  
    "fmt"  
    "log"  
    "net/http"  
    "os"  
  
    "tiktokshop/open/sdk_golang/apis"  
    productV202502 "tiktokshop/open/sdk_golang/models/product/v202502"  
    "tiktokshop/open/sdk_golang/utils"  
)  
  
func requiredEnv(name string) string {  
    value := os.Getenv(name)  
    if value == "" {  
        log.Fatalf("missing required environment variable: %s", name)  
    }  
    return value  
}  
  
func getAccessToken(appKey string, appSecret string, authCode string) (string, error) {  
    at := apis.NewAccessToken(appKey, appSecret)  
  
    resp, err := at.GetToken(authCode)  
    if err != nil {  
        return "", fmt.Errorf("GetToken failed: %w", err)  
    }  
    if resp.Code != 0 {  
        return "", fmt.Errorf("GetToken business error: code=%d", resp.Code)  
    }  
  
    accessToken := resp.Data.AccessToken  
    if accessToken == "" {  
        return "", fmt.Errorf("GetToken response has empty access_token")  
    }  
  
    return accessToken, nil  
}  
  
func getFirstShopCipher(ctx context.Context, apiClient *apis.APIClient, accessToken string) (string, error) {  
    shopsRequest := apiClient.AuthorizationV202309API.Authorization202309ShopsGet(ctx)  
    shopsRequest = shopsRequest.ContentType("application/json")  
    shopsRequest = shopsRequest.XTtsAccessToken(accessToken)  
  
    shopsResponse, httpRes, err := shopsRequest.Execute()  
    if err != nil {  
        return "", fmt.Errorf("Authorization202309ShopsGet failed: %w", err)  
    }  
    if httpRes != nil && httpRes.StatusCode != http.StatusOK {  
        return "", fmt.Errorf("Authorization202309ShopsGet HTTP status: %d", httpRes.StatusCode)  
    }  
    if shopsResponse == nil {  
        return "", fmt.Errorf("Authorization202309ShopsGet response is nil")  
    }  
    if shopsResponse.GetCode() != 0 {  
        return "", fmt.Errorf(  
            "Authorization202309ShopsGet business error: code=%d message=%s",  
            shopsResponse.GetCode(),  
            shopsResponse.GetMessage(),  
        )  
    }  
    if len(shopsResponse.Data.Shops) == 0 {  
        return "", fmt.Errorf("no authorized shops found")  
    }  
  
    var shopCipher string  
    for _, shop := range shopsResponse.Data.Shops {  
        var shopID string  
        var cipher string  
        if shop.Id != nil {  
            shopID = *shop.Id  
        }  
        if shop.Cipher != nil {  
            cipher = *shop.Cipher  
        }  
  
        fmt.Printf("Authorized shop: shop_id=%s, shop_cipher=%s\n", shopID, cipher)  
  
        if shopCipher == "" && cipher != "" {  
            shopCipher = cipher  
        }  
    }  
  
    if shopCipher == "" {  
        return "", fmt.Errorf("no shop_cipher found in authorized shops")  
    }  
  
    return shopCipher, nil  
}  
  
func searchProducts(ctx context.Context, apiClient *apis.APIClient, accessToken string, shopCipher string) error {  
    productsRequest := apiClient.ProductV202502API.Product202502ProductsSearchPost(ctx)  
    productsRequest = productsRequest.ContentType("application/json")  
    productsRequest = productsRequest.XTtsAccessToken(accessToken)  
    productsRequest = productsRequest.ShopCipher(shopCipher)  
    productsRequest = productsRequest.PageSize(1)  
  
    reqBody := productV202502.Product202502SearchProductsRequestBody{  
        Status: utils.PtrString("ALL"),  
    }  
    productsRequest = productsRequest.Product202502SearchProductsRequestBody(reqBody)  
  
    searchProductsResponse, httpRes, err := productsRequest.Execute()  
    if err != nil {  
        return fmt.Errorf("Product202502ProductsSearchPost failed: %w", err)  
    }  
    if httpRes != nil && httpRes.StatusCode != http.StatusOK {  
        return fmt.Errorf("Product202502ProductsSearchPost HTTP status: %d", httpRes.StatusCode)  
    }  
    if searchProductsResponse == nil {  
        return fmt.Errorf("Product202502ProductsSearchPost response is nil")  
    }  
    if searchProductsResponse.GetCode() != 0 {  
        return fmt.Errorf(  
            "Product202502ProductsSearchPost business error: code=%d message=%s",  
            searchProductsResponse.GetCode(),  
            searchProductsResponse.GetMessage(),  
        )  
    }  
  
    fmt.Printf("Search Products data: %+v\n", searchProductsResponse.GetData())  
    return nil  
}  
  
func main() {  
    ctx := context.Background()  
  
    appKey := requiredEnv("TTS_APP_KEY")  
    appSecret := requiredEnv("TTS_APP_SECRET")  
    authCode := requiredEnv("TTS_AUTH_CODE")  
  
    configuration := apis.NewConfiguration()  
    configuration.AddAppInfo(appKey, appSecret)  
    apiClient := apis.NewAPIClient(configuration)  
  
    accessToken, err := getAccessToken(appKey, appSecret, authCode)  
    if err != nil {  
        log.Fatal(err)  
    }  
  
    shopCipher, err := getFirstShopCipher(ctx, apiClient, accessToken)
```

--------------------------------

### Create Promotion Activity Request

Source: https://partner.tiktokshop.com/docv2/page/create-promotion-activity-202309

Example of the cURL request headers and body for creating a promotion activity.

```bash
-H 'x-tts-access-token: TTP_pwSm2AAAAABmmtFz1xlyKMnwg74T2GJ5s0uQbS8jPjb_GkdFVCxPqzQXSyuyfXdQa0AqyDsea2tYFNVf4XeqgZHFfPyv0Vs659QqyLYfsGzanZ5XZAin3_ZkcIxxS0_In6u6XDeU96k' \
-H 'content-type: application/json' \
-d '{
"title": "DiscountEvent0829",
"activity_type": "FIXED_PRICE",
"product_level": "PRODUCT",
"duration_type": "INDEFINITE",
"begin_time": 1661756811,
"end_time": 1661856811,
"participation_limit": [
{
"type": "BUYER_NO_LIMIT"
}
],
"discount": {
"shipping_discount": {
"threshold_type": "MINIMAL_ITEM_QUANTITY",
"threshold_value": "3",
"type": "DISCOUNT_SHIPPING_FEE",
"value": "10.5",
"shipping_method": "STANDARD_SHIPPING",
```

--------------------------------

### Get Warehouse Delivery Options Response

Source: https://partner.tiktokshop.com/docv2/page/get-warehouse-delivery-options-202309

Example JSON response structure for the Get Warehouse Delivery Options API.

```json
{
"code": 0,
"data": {
"delivery_options": [
{
"id": "6955034615128000261",
"name": "LSV-TTS-STD",
"type": "STANDARD",
"description": "LSV-TTS-STD S",
"dimension_limit": {
"max_height": 100,
"max_length": 100,
"max_width": 100,
"unit": "INCH"
},
"weight_limit": {
"max_weight": 100,
"min_weight": 100,
"unit": "GRAM"
},
"platform": [
"TOKOPEDIA",
"TIKTOK_SHOP"
```

--------------------------------

### Get Global Categories Request

Source: https://partner.tiktokshop.com/docv2/page/get-global-categories-202309

Example request for the Get Global Categories endpoint using various programming languages.

```curl
curl -X GET \
'https://open-api.tiktokglobalshop.com/product/202309/global_categories?app_key=38abcd&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&timestamp=1623812664&locale=en-GB&keyword=electronics&category_version=v1' \
-H 'content-type: application/json'
```
Tokens:
Raw