Get Product Package Recommendations

POST

/product/202602/packages/recommend

Retrieve recommended weight and dimension ranges for product packages. Only available in BR and MX.

Authorizations

• accessToken

Parameters

Query Parameters

shop_cipher

required

string

Identifies the shop. Obtain it from the Get Authorized Shops API.

page_size

required

integer format: int64

>= 1 <= 100

The number of results to be returned per page. Valid range: [1-100]

page_token

string

An opaque token used to retrieve the next page of a paginated result set. Retrieve this value from the result of the next_page_token from a previous response. It is not needed for the first page.

Request Body

Media typeapplication/json

object

product_ids

A JSON array of product IDs for which to retrieve package recommendations.

Array<string>

Example

{
  "product_ids": [
    "12345678",
    "12345679"
  ]
}

Responses

200

Success

Media typeapplication/json

object

code

Status code; 0 means success.

integer format: int64

message

Success or failure message.

string

request_id

Request log ID.

string

data

object

next_page_token

An opaque token used to retrieve the next page of a paginated result set. Provide this value in the page_token parameter of your request if the current response does not return all the results.

string

total_count

The total number of products that meet the query conditions.

integer format: int64

products

The product package recommendations that meet the query conditions. Each item identifies a product and provides detected anomaly types with any available weight or dimension correction range.

Array<object>

object

product_id

The product ID generated by TikTok Shop.

string

abnormality_types

The detected package anomaly types. Possible values:

• None: No weight or dimension anomaly was detected.
• Dimension: A dimension correction is recommended.
• Weight: A weight correction is recommended.

Array<string>

Allowed values: None Dimension Weight

weight_recommendation

Weight correction recommendation (Returned only when the weight of product has been recommended ).

object

unit

Unit of weight, fixed as GRAM.

string

weight

Recommended values for weight.

object

min_value

Recommended range minimum; unit: g

string

max_value

Recommended range maximum; unit: g

string

dimension_recommendation

Dimension correction recommendation (Returned only when the dimensions of product has been recommended).

object

unit

Unit of dimension, fixed as centimeter.

string

length

Recommended values for length.

object

min_value

Recommended range minimum; unit: cm

string

max_value

Recommended range maximum; unit: cm

string

height

Recommended values for height (structure same as length).

object

min_value

Recommended range minimum; unit: cm

string

max_value

Recommended range maximum; unit: cm

string

width

Recommended values for width (structure same as length).

object

min_value

Recommended range minimum; unit: cm

string

max_value

Recommended range maximum; unit: cm

string

Example

{
  "code": 0,
  "data": {
    "next_page_token": "b2Zmc2V0PTAK",
    "total_count": 200,
    "products": [
      {
        "product_id": "23423",
        "abnormality_types": [
          "Dimension",
          "Weight"
        ],
        "weight_recommendation": {
          "unit": "GRAM",
          "weight": {
            "min_value": "550",
            "max_value": "650"
          }
        },
        "dimension_recommendation": {
          "unit": "CENTIMETER",
          "length": {
            "min_value": "19",
            "max_value": "22"
          },
          "height": {
            "min_value": "19",
            "max_value": "22"
          },
          "width": {
            "min_value": "19",
            "max_value": "22"
          }
        }
      }
    ]
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}