Check Creator Sample Eligibility

GET

/affiliate_creator/202412/samples/labels

Check if a creator can apply for a sample of a specific product.

Authorizations

• accessToken

Parameters

Query Parameters

product_id

required

string

The TikTok Shop product identifier.

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

label

Creator applicable sample label information.

object

can_apply

Whether the authenticated creator can apply for a sample of the specified product.

boolean

status

Status indicating whether the creator has applied for a free sample of the specified product.

• UNKNOWN: The application status is unknown.
• TO_APPLY: The creator has not applied for a free sample of the product.
• ONGOING: The creator has applied for a free sample but has not completed sample fulfillment.
• COMPLETE: The creator has applied for a free sample and completed sample fulfillment.

string

application_id

Sample Application ID. only appear when the creator has already applied this product.

string

reach_limit

If the creator has reached the sample application upper limit.

boolean

sample_product

The sample product information.

object

sample_sku_list

The sample product SKU information.

Array<object>

object

id

The SKU identifier.

string

sale_property_value_ids

The SKU property value identifiers joined with underscores (_) in the same order as the entries in sale_properties.

string

price

SKU price information.

object

amount

The SKU price in major units of the currency specified by currency, represented as a decimal string.

string

currency

The price currency code.

string

sale_properties

The SKU property information.

Array<object>

object

id

A SKU property identifier, short for “Stock Keeping Unit Property ID”, is a specific identification code assigned to a particular property or characteristic of a SKU.(i.e: “100000” means “color”)

string

name

The SKU property name.

string

value_id

The SKU property value identifier is an identification code related to the specific values of the properties of a Stock Keeping Unit (SKU). When a SKU has certain properties like color, size, etc., each possible value for those properties has its own unique SKU property value identifier. For instance, if the property is “color” and the possible values are “red”, “blue”, “green”, then “red” would have its own SKU property vvalue identifier, “blue” would have another one, and so on.

string

value_name

The SKU property value name.

string

is_available

Whether this SKU is available for the creator to apply for as a sample.

boolean

unavailable_reason

The reason code associated with SKU sample availability. Interpret a specific unavailability reason only when is_available is false. UNKNOWN can also be returned when is_available is true because no unavailability reason applies. Possible values:

• IS_PREORDER: The product is a preorder product and does not support free samples.
• IS_GIFT: The product is a gift and does not support free samples.
• OUT_OF_STOCK: The product is out of stock.
• EXCEED_CB_PRICE_THRESHOLD: The SKU price exceeds the applicable cross-border price threshold.
• ALREADY_APPLYED: The creator has already applied for this SKU.
• UNKNOWN: No mapped unavailability reason is available.

string

Allowed values: IS_PREORDER IS_GIFT OUT_OF_STOCK EXCEED_CB_PRICE_THRESHOLD ALREADY_APPLYED UNKNOWN

Example

{
  "code": 0,
  "data": {
    "label": {
      "can_apply": true,
      "status": "ONGOING",
      "application_id": "86427198341982134",
      "reach_limit": true,
      "sample_product": {
        "sample_sku_list": [
          {
            "id": "1731055098570377347",
            "sale_property_value_ids": "7068196393634072325",
            "price": {
              "amount": "7588986",
              "currency": "USD"
            },
            "sale_properties": [
              {
                "id": "100000",
                "name": "color",
                "value_id": "7425668826861520646",
                "value_name": "Default"
              }
            ],
            "is_available": true,
            "unavailable_reason": "IS_PREORDER"
          }
        ]
      }
    }
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}