Creator Search Sample Application Fulfillments

POST

/affiliate_creator/202409/sample_applications/fulfillments/search

You, the creator, can use this API to query the fulfillment status for the received sample applications.

Authorizations

• accessToken

Parameters

Query Parameters

sort_order

string

The sort order for the field specified in the sort_field parameter. Default: ASC Possible values: ASC: Ascending order DESC: Descending order

sort_field

string

Allowed values: expired_time create_time

Possible values:

• expired_time: Sort by the remaining time to fulfill.
• create_time: Sort by the fulfillment record creation time. Default: expired_time.

Request Body^required

Media typeapplication/json

object

fulfillment_statuses

required

A list of fulfillment statuses. The response is filtered to include sample fulfillments with the status field set to one of the specified values. The possible values are:

• PENDING: The creator has not yet fulfilled the content creation obligation.
• ONGOING: Fulfillment is in progress; content has been created and is being evaluated against criteria.
• SUCCEED: Fulfillment has been successfully completed; the content meets the required standards.
• FAILED: Fulfillment failed; the content did not meet the required standards.
• OVERDUE: Fulfillment is overdue; the creator did not meet the deadline.
• SUSPEND: Fulfillment has been suspended.
• CANCELLED: Fulfillment has been cancelled, either by the creator or due to operational reasons.
• EXEMPTED: The creator is exempt from the fulfillment obligation.

Array<string>

Allowed values: PENDING ONGOING SUCCEED FAILED OVERDUE SUSPEND CANCELLED EXEMPTED

Example

{
  "fulfillment_statuses": [
    "PENDING",
    "ONGOING"
  ]
}

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

fulfillments

Creator fulfillment contents.

Array<object>

object

id

The fulfillment identifier.

string

shop_id

The TikTok Shop identifier.

string

application_id

The sample application identifier.

string

sample_application_type

The type of the sample application. Possible values:

• FREE_SAMPLE
• SAMPLE_COUPON
• SAMPLE_CAMPAIGN
• PLATFORM_FREE_SAMPLE
• REFUNDABLE_SAMPLE
• UNSPECIFIED

string

Allowed values: FREE_SAMPLE SAMPLE_COUPON SAMPLE_CAMPAIGN PLATFORM_FREE_SAMPLE REFUNDABLE_SAMPLE UNSPECIFIED

product_id

The product identifier.

string

expiration_time

Fulfillment deadline timestamp. Usually the value is {you_receiving_sample_time} + 14Days. But if you apply for fulfillment suspension, the value is {you_receiving_sample_time} + 14Days + total_suspend_duration.

integer format: int64

total_suspend_duration

The duration you applied for fulfillment suspension in seconds.

integer format: int64

status

The fulfillment status.This is an enumerated type with values:

• PENDING: The creator has not yet fulfilled the content creation obligation.
• ONGOING: Fulfillment is in progress; content has been created and is being evaluated against criteria.
• SUCCEED: Fulfillment has been successfully completed; the content meets the required standards.
• FAILED: Fulfillment failed; the content did not meet the required standards.
• OVERDUE: Fulfillment is overdue; the creator did not meet the deadline.SUSPEND: Fulfillment has been suspended.
• CANCELLED: Fulfillment has been cancelled, either by the creator or due to operational reasons.
• EXEMPTED: The creator is exempt from the fulfillment obligation.

string

bound_product_status

The promotion status of the product associated with the fulfillment. Possible values:

• UNKNOWN: The product’s promotion status is unknown.
• LIVE: The product is available for promotion.
• OUT_OF_STOCK: The product is out of stock.
• SELLER_DEACTIVATE: The product has been deactivated by the seller.
• PLATFORM_DEACTIVATE: The product has been deactivated by the platform.
• NO_PLAN: There is no valid plan available for the creator to promote the product.
• PERMANENT_DELETED: The product has been permanently deleted and is no longer available.

string

Allowed values: UNKNOWN LIVE OUT_OF_STOCK SELLER_DEACTIVATE PLATFORM_DEACTIVATE NO_PLAN PERMANENT_DELETED

Example

{
  "code": 0,
  "data": {
    "fulfillments": [
      {
        "id": "123456",
        "shop_id": "123456",
        "application_id": "123456",
        "sample_application_type": "FREE_SAMPLE",
        "product_id": "123456",
        "expiration_time": 1728542813,
        "total_suspend_duration": 100020,
        "status": "ONGOING",
        "bound_product_status": "LIVE"
      }
    ]
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}