TikTok Shop Partner Center

https://partner.tiktokshop.com/doc
Admin
TikTok Shop Partner Center is an e-commerce service platform designed for developers, talent...
Tokens:75,363
Snippets:1,180
Trust Score:8.1
Update:2 months ago
Show doc for...
Tokens:
Raw
### Retrieve Data via cURL

Source: https://partner.tiktokshop.com/docv2/page/6503075656e2bb0289dd5d01

Example of a GET request using cURL.

```bash
curl -X GET \
```

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

### Global replication status change event example

Source: https://partner.tiktokshop.com/docv2/page/7nzxgima

A JSON payload example representing the webhook notification for a completed product replication.

```json
{
    "type": 51,
    "shop_id": "7494049642642441621",
    "tts_notification_id": "7327112393057371910",
    "timestamp": 1644412885,
    "data": {
        "source_product_id": "764c6e87eedcea90399a0dafcd572b71",
        "replicated_product": {
            "product_id": "576486316948490000",
            "region": "GB",
            "result": "SUCCESS",              
            "fail_reasons": {
                "message": ""
                }
            }
        }
    }
}
```

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

### Get Categories API Request

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

Example request for retrieving product categories using cURL.

```curl
curl -X GET \
'https://open-api.tiktokglobalshop.com/product/202309/categories?shop_cipher=GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3&keyword=electronics&listing_platform=TIKTOK_SHOP&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&timestamp=1623812664&locale=en-US&category_version=v1&include_prohibited_categories=false&app_key=38abcd' \
-H 'x-tts-access-token: TTP_pwSm2AAAAABmmtFz1xlyKMnwg74T2GJ5s0uQbS8jPjb_GkdFVCxPqzQXSyuyfXdQa0AqyDsea2tYFNVf4XeqgZHFfPyv0Vs659QqyLYfsGzanZ5XZAin3_ZkcIxxS0_In6u6XDeU96k' \
-H 'content-type: application/json'
```

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

### Get Brands API Request

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

Example request to retrieve brand information using cURL.

```bash
curl -X GET \
'https://open-api.tiktokglobalshop.com/product/202309/brands?app_key=38abcd&shop_cipher=GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3&category_id=600006&brand_name=Teas&category_version=v1&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&timestamp=1623812664&is_authorized=false&page_size=100&page_token=b2Zmc2V0PTAK' \
-H 'x-tts-access-token: TTP_pwSm2AAAAABmmtFz1xlyKMnwg74T2GJ5s0uQbS8jPjb_GkdFVCxPqzQXSyuyfXdQa0AqyDsea2tYFNVf4XeqgZHFfPyv0Vs659QqyLYfsGzanZ5XZAin3_ZkcIxxS0_In6u6XDeU96k' \
-H 'content-type: application/json'
```

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

### Get Product

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

Retrieves detailed information for a specific product.

```APIDOC
## GET Get Product

### Description
Retrieves the details of a specific product.

### Method
GET

### Endpoint
/products/get
```

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

### GET /product/202309/categories/{category_id}/rules

Source: https://partner.tiktokshop.com/docv2/page/get-category-rules-202309

Retrieves the rules and certification requirements for a specific product category.

```APIDOC
## GET /product/202309/categories/{category_id}/rules

### Description
Retrieves the rules and certification requirements for a specific product category.

### Method
GET

### Endpoint
https://open-api.tiktokglobalshop.com/product/202309/categories/{category_id}/rules

### Parameters
#### Path Parameters
- **category_id** (string) - Required - The unique identifier for the category.

#### Query Parameters
- **app_key** (string) - Required - The application key.
- **sign** (string) - Required - The request signature.
- **shop_cipher** (string) - Required - The shop cipher identifier.
- **category_version** (string) - Required - The version of the category system (e.g., v1).
- **locale** (string) - Required - The locale code (e.g., es-MX).
- **timestamp** (string) - Required - The request timestamp.

### Response
#### Success Response (200)
- **code** (int) - The success or failure status code.
- **message** (string) - The success or failure message.
- **request_id** (string) - The request log identifier.
- **data** (object) - The specific return information containing product_certifications.

#### Response Example
{
  "code": 0,
  "data": {
    "product_certifications": [
      {
        "id": "602362",
        "name": "SNI Certificate",
        "is_required": true,
        "document_details": "Upload a user manual or instructions in the official local language.",
        "sample_image_url": "https://p-boei18n.byted.org/tos-boei18n-i-jvtte31kaf/80b32f2896829eeb69d4b278c4f3aa75.jpg~tplv-jvtte31kaf-origin-jpeg.jpeg",
        "requirement_conditions": [
          {
            "condition_type": "VALUE_ID_MATCH",
            "attribute_id": "101610",
            "attribute_value_id": "1024358"
          }
        ],
        "expiration_date": {
          "is_required": true
        }
      }
    ]
  }
}
```

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

### Search Order By External Order Reference Response

Source: https://partner.tiktokshop.com/docv2/page/search-order-by-external-order-reference-202406

Example JSON response structure returned by the API.

```json
{
"code": 0,
"data": {
"orders": [
{
"id": "576461413038785752",
"external_order": {
"id": "676461413038785752",
"platform": "SHOPIFY",
"line_items": [
{
"id": "577086512123755123",
"origin_id": "677086512123755123"
}
]
}
}
]
},
"message": "Success",
"request_id": "202203070749000101890810281E8C70B7"
}
```

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

### Get Brands API Response

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

Example JSON response structure returned by the Get Brands API.

```json
{
"code": 0,
"data": {
"brands": [
{
"id": "7082427311584347905",
"name": "Teas",
"authorized_status": "AUTHORIZED",
"is_t1_brand": true,
"brand_status": "AVAILABLE"
}
],
"total_count": 10000,
"next_page_token": "b2Zmc2V0PTAK"
},
"message": "Success",
"request_id": "202203070749000101890810281E8C70B7"
}
```

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

### Create Product

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

Creates a new product listing.

```APIDOC
## POST Create Product

### Description
Creates a new product in the system.

### Method
POST

### Endpoint
/products/create
```

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

### Get Categories API Response

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

Example JSON response structure returned by the Get Categories API.

```json
{
"code": 0,
"data": {
"categories": [
{
"id": "600002",
"parent_id": "600001",
"local_name": "Home Supplies",
"is_leaf": false,
"permission_statuses": [
"INVITE_ONLY",
"NON_MAIN_CATEGORY"
]
}
]
},
"message": "Success",
"request_id": "202203070749000101890810281E8C70B7"
}
```

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

### Product Package Recommended Event Payload

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

Example JSON payload received when a product package recommendation is triggered.

```json
{
  "type": 62,
  "tts_notification_id": "7611238471432161025",
  "shop_id": "1111111",
  "timestamp": 1772129552,
  "data": {
    "abnormality_types": [
      "Weight",
      "Dimension"
    ],
    "dimension_recommendation": {
      "height": {
        "max_value": "3",
        "min_value": "3"
      },
      "length": {
        "max_value": "1234",
        "min_value": "123"
      },
      "unit": "CENTIMETER",
      "width": {
        "max_value": "666",
        "min_value": "555"
      }
    },
    "product_id": "1733529220361062152",
    "weight_recommendation": {
      "unit": "GRAM",
      "weight": {
        "max_value": "12000",
        "min_value": "12000"
      }
    }
  }
}
```

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

### Webhook: Product Package Recommended (Type 62)

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

This webhook is triggered when a product package recommendation is generated. It is applicable only for Brazil (BR) and Mexico (MX) markets and requires the 'Product Basic' API scope.

```APIDOC
## Webhook: Product Package Recommended

### Description
This webhook event is triggered when a product package recommendation is generated for a seller's product. It provides specific recommendations for weight and dimension corrections.

### Parameters
- **type** (int) - The ID of the webhook type (62).
- **tts_notification_id** (string) - The unique ID of the notification.
- **shop_id** (string) - The shop_id of the seller.
- **timestamp** (int) - The UNIX timestamp when this webhook was triggered.
- **data** (object) - Contains the recommendation details:
  - **product_id** (string) - The product ID generated by TikTok Shop.
  - **abnormality_types** (array) - List of current anomaly types (e.g., ["Weight", "Dimension"]).
  - **weight_recommendation** (object) - Weight correction recommendation including unit and min/max values.
  - **dimension_recommendation** (object) - Dimension correction recommendation including unit and min/max values for length, width, and height.

### Event Example
{
  "type": 62,
  "tts_notification_id": "7611238471432161025",
  "shop_id": "1111111",
  "timestamp": 1772129552,
  "data": {
    "abnormality_types": [
      "Weight",
      "Dimension"
    ],
    "dimension_recommendation": {
      "height": {
        "max_value": "3",
        "min_value": "3"
      },
      "length": {
        "max_value": "1234",
        "min_value": "123"
      },
      "unit": "CENTIMETER",
      "width": {
        "max_value": "666",
        "min_value": "555"
      }
    },
    "product_id": "1733529220361062152",
    "weight_recommendation": {
      "unit": "GRAM",
      "weight": {
        "max_value": "12000",
        "min_value": "12000"
      }
    }
  }
}
```

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

### Search Responsible Persons Response Example

Source: https://partner.tiktokshop.com/docv2/page/search-responsible-persons-202501

Example JSON response structure returned by the search endpoint.

```json
{
"code": 0,
"data": {
"responsible_persons": [
{
"id": "66d3cbe4d9c8b09ddca932a7",
"regional_profiles": [
{
"locale": "en-IE",
"name": "John Doe",
"email": "john.doe@email.com",
"phone_number": {
"country_code": "+353",
"local_number": "80915151"
},
"address": {
"street_address_line1": "63 Cardiff Ln, Grand Canal Dock, Dublin City, Dublin",
"street_address_line2": "-",
"district": "-",
"city": "-",
"postal_code": "D02 HD23",
"province": "-"
```

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

### POST /product/202309/products

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

Creates a new product in the shop. Requires the seller.product.write scope.

```APIDOC
## POST /product/202309/products

### Description
Create and list products intended for sale exclusively in local shops. After creation, the product is sent for audit review by TikTok Shop.

### Method
POST

### Endpoint
/product/202309/products

### Parameters
#### Header Parameters
- **content-type** (string) - Required - Allowed type: application/json
- **x-tts-access-token** (string) - Required - The seller access_token value.

#### Query Parameters
- **app_key** (string) - Required - Unique key assigned to your app.
- **sign** (string) - Required - Signature generated by the generation algorithm.
- **timestamp** (int) - Required - Unix timestamp GMT (UTC+00:00).
- **shop_cipher** (string) - Required - Shop information identifier.

#### Request Body
- **save_mode** (string) - Optional - Indicates how the product should be saved. Values: AS_DRAFT, LISTING. Default: LISTING.
```

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

### Get Order List / Get Order Detail API Update

Source: https://partner.tiktokshop.com/docv2/page/for-us-local-sellers-item-level-tax-rate-added-to-order-resource

The tax_rate property is now available in the response for order-related API calls in version 202309.

```APIDOC
## GET /order/202309/orders

### Description
Retrieves order information including the new tax_rate property for item-level tax calculations in US markets.

### Method
GET

### Endpoint
/order/202309/orders

### Response
#### Success Response (200)
- **data.orders.line_items.item_tax.tax_rate** (string) - The tax rate applied to the specific item.

#### Response Example
{
  "code": 0,
  "data": {
    "orders": [
      {
        "line_items": [
          {
            "display_status": "TO_SHIP",
            "id": "577086512123755123",
            "is_gift": false,
            "item_tax": [
              {
                "tax_amount": "21.2",
                "tax_type": "SALES_TAX",
                "tax_rate": "0.03"
              }
            ]
          }
        ]
      }
    ]
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}
```

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

### POST /products

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

Creates a new product in the shop. The request body supports various fields including search terms, key product features, and purchase order quantity limits.

```APIDOC
## POST /products

### Description
Creates a new product listing. This endpoint allows for the configuration of product attributes such as search terms, key features, and purchase limits.

### Method
POST

### Parameters
#### Request Body
- **auto_translate_enabled** (bool) - Optional - Enables automatic translation for products listed in multiple languages.
- **search_terms** (array of strings) - Optional - Search terms to increase search weight (max 15 terms, max 250 characters).
- **key_product_features** (array of strings) - Optional - Key features displayed on the product detail page (max 5 items, max 1500 characters).
- **product_tag_operations** (array of objects) - Optional - Tags to identify special product types (e.g., AUCTION).
- **purchase_order_quantity_limit** (object) - Optional - Defines the limit for customer purchase quantity.

### Response
#### Success Response (200)
- **code** (int) - The success or failure status code.
- **message** (string) - Success or failure description.
- **request_id** (string) - Unique identifier for the request log.
- **data** (object) - Specific return information.
```

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

### Category Rules API Response Example

Source: https://partner.tiktokshop.com/docv2/page/get-category-rules-202309

A sample JSON response containing product certification requirements and condition types for a specific category.

```json
{
"code": 0,
"data": {
"product_certifications": [
{
"id": "602362",
"name": "SNI Certificate",
"is_required": true,
"document_details": "Upload a user manual or instructions in the official local language.\\\n\\\nWhere there are multiple items sold as a part of a bundle, please clearly indicate which specific product the certification pertains to in the uploaded file or image.",
"sample_image_url": "https://p-boei18n.byted.org/tos-boei18n-i-jvtte31kaf/80b32f2896829eeb69d4b278c4f3aa75.jpg~tplv-jvtte31kaf-origin-jpeg.jpeg",
"requirement_conditions": [
{
"condition_type": "VALUE_ID_MATCH",
"attribute_id": "101610",
"attribute_value_id": "1024358"
}
],
"expiration_date": {
"is_required": true
}
}
]
}
```
Tokens:
Raw