Search Sample Application Fulfillments

POST

/affiliate_seller/202409/sample_applications/{application_id}/fulfillments/search

You, the seller, can use this API to get the fulfillment status of the specific sample application and whether the fulfillment resulted in orders. This allows Sellers to track the current progress or analyze the results of their sample distribution program.

Authorizations

• accessToken

Parameters

Path Parameters

application_id

required

string

The application identifier.

Query Parameters

shop_cipher

required

string

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

Request Body

Media typeapplication/json

object

content_format

The content type generated by the creator after receiving the samples. Possible enumerations:

• LIVE
• VIDEO

string

Allowed values: LIVE VIDEO

Example

{
  "content_format": "LIVE"
}

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

Fulfillments

Array<object>

object

product

Product information

object

id

The product identifier.

string

main_image_url

The cover image url of product.

string

content

Fulfillment content information.

object

id

The video or live room identifier.

string

format

The format of the generated content:

• LIVE
• VIDEO

string

url

The content source link.

string

view_count

The cumulative number of views of the content.

integer format: int64

like_count

The cumulative number of likes on the content.

integer format: int64

comment_count

The cumulative number of comments on the content.

integer format: int64

paid_order_count

The cumulative total number of orders paid for content.

integer format: int64

page_link

Content page url of TikTok.

string

description

The title of video or the description of the live room.

string

create_time

• When format is VIDEO, this is the Unix timestamp, in seconds, when the video is first made public and linked to the product.
• When format is LIVE, this is the Unix timestamp, in seconds, when the product link is first added to the live stream.

integer format: int64

live_end_time

Only when format==LIVE. It refers to the time when the product link is removed from the live room. If the product link remains active and is not removed, then it is the end of the live stream.

integer format: int64

Example

{
  "code": 0,
  "data": {
    "fulfillments": [
      {
        "product": {
          "id": "123456",
          "main_image_url": "https://www.example.com"
        },
        "content": {
          "id": "123456",
          "format": "LIVE",
          "url": "https://www.example.com",
          "view_count": 100,
          "like_count": 123,
          "comment_count": 10,
          "paid_order_count": 1,
          "page_link": "https://www.example.com",
          "description": "abc def gh",
          "create_time": 1723529426,
          "live_end_time": 1723529426
        }
      }
    ]
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}