POST
/affiliate_creator/202412/sample_applications/search
Search sample applications for the authenticated creator.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”page_token
string
The page token returned in next_page_token by the previous response. Omit this parameter for the first request. For subsequent pages, pass the returned token and reuse the same application_statuses value.
page_size
integer format: int64
The value of “page_size” must be greater than 0 and less than or equal to 50. Default 20
Request Body
Section titled “Request Body”Media typeapplication/json
object
application_statuses
Filter sample applications by status. The possible enumerated values are:
- PENDING: The sample application is waiting for the seller’s review.
- AWAITING_SHIPMENT: The application is approved, and the seller needs to ship the sample.
- SHIPPED: The sample has been shipped by the seller and is waiting for the creator to receive the package.
- CONTENT_PENDING: The creator has received the sample package and is expected to create content.
- REJECT_CANCELLED: The sample application has been rejected by the seller.
- OVERDUE_CANCELLED: The sample application has expired due to being overdue.
- UNFULFILL_CANCELLED: The creator did not fulfill the commitment to create content within the agreed timeframe.
- FULFILLMENT_SUSPEND: The application fulfillment was paused because the product could not be promoted.
- DEL_OPEN_COLLAB: Open collaboration has been deleted.
- SELLER_NOT_SHIP_CANCELLED: The seller did not ship the sample within the required timeframe.
- WITHDRAW_CANCELLED: The creator withdrew the sample application before the seller approved it.
- UNFULFILLABLE_CANCELLED: The application was cancelled due to reasons beyond the creator’s control, making it impossible to create content.
- OPS_CANCELLED: The application was manually cancelled by operations staff.
- OPS_FAILED: The application was marked as failed by operations staff.
- OPS_ COMPLETED: The application was manually marked as completed by operations staff.
- COMPLETED: The application is complete, and the creator has posted the content.
- TO_BE_POST: The creator has not posted a video or LIVE for this sample.
- POST_IN_REVIEW: The creator has posted a video or LIVE that has not yet satisfied the fulfillment requirements.
- POST_FAILED: The creator posted a video or LIVE but deleted it before completing sample fulfillment.
- CANCELED: The sample application has been canceled. This field allows for tracking the status of a sample application throughout its lifecycle, providing visibility into each stage of the process for sellers and creators.
Array<string>
Example
{ "application_statuses": [ "PENDING", "AWAITING_SHIPMENT" ]}Responses
Section titled “Responses”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
Page token to query next page orders, last page is empty string.
string
sample_applications
The sample application information.
Array<object>
object
id
The unique id of sample application.
string
sample_product
The sample product information.
object
id
The product identifier.
string
sku_id
The SKU identifier.
string
sku_sale_property_value_names
Sku property name list for this sku id.
Array<string>
main_order_id
The sample order is generated after the sample application is approved by seller.
string
activity_id
The sample activity identifier id(only for sample activity).
string
status
The status of sample applications. The possible enumerated values are:
- PENDING: The sample application is waiting for the seller’s review.
- AWAITING_SHIPMENT: The application is approved, and the seller needs to ship the sample.
- SHIPPED: The sample has been shipped by the seller and is waiting for the creator to receive the package.
- REJECT_CANCELLED: The sample application has been rejected by the seller.
- OVERDUE_CANCELLED: The sample application has expired due to being overdue.
- UNFULFILL_CANCELLED: The creator did not fulfill the commitment to create content within the agreed timeframe.
- FULFILLMENT_SUSPEND: the application fulfillment was paused due to the product status being unpromotable.
- DEL_OPEN_COLLAB: Open collaboration has been deleted.
- SELLER_NOT_SHIP_CANCELLED: The seller did not ship the sample within the required timeframe.
- WITHDRAW_CANCELLED: The creator withdrew the sample application before the seller approved it.
- UNFULFILLABLE_CANCELLED: The application was cancelled due to reasons beyond the creator’s control, making it impossible to create content.
- OPS_CANCELLED: The application was manually cancelled by operations staff.
- OPS_FAILED: The application was marked as failed by operations staff.
- OPS_ COMPLETED: The application was manually marked as completed by operations staff.
- COMPLETED: The application is complete, and the creator has posted the content.
- TO_BE_POST: the creator has not posted videos/lives for this sample
- POST_IN_REVIEW: the creator has posted videos/lives which have not satisfied fulfillment rules.
- POST_FAILED: the creator has posted videos/lives and deleted them before completing sample fulfillment.
- CANCELED: this application(order) has been canceled. This field allows tracking the status of a sample application throughout its lifecycle, providing visibility into each stage of the process for sellers and creators.
string
creator_fulfillment
Fulfillment info for this sample application.
object
id
Fulfillment ID.
string
expiration_time
Fulfillment deadline timestamp, in seconds.
integer format: int64
total_suspend_duration
Total suspension duration for fulfillment, in seconds.
integer format: int64
status
Fulfillment status, It indicates the current status of the fulfillment process. The possible values are:
- PENDING: The creator is yet to fulfill 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 has been exempted from the fulfillment obligation.
string
bound_product_status
Represents the marketing status of a product associated with a fulfillment order. It indicates whether the product is available for marketing and fulfillment. The possible values are:
- UNKNOWN: The marketing status of the product is unknown.
- LIVE: The product is available and can be used for fulfillment.
- OUT_OF_STOCK: The product is out of stock and cannot be fulfilled.
- 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 market the product.
- PERMANENT_DELETED: The product has been permanently deleted and is no longer available. This field helps sellers and creators understand the current status of products associated with fulfillment orders, ensuring that all parties are aware of the availability and marketing status of the products involved in sample applications and collaborations.
string
Example
{ "code": 0, "data": { "next_page_token": "20", "sample_applications": [ { "id": "8070590921506065183", "sample_product": { "id": "1729432087292775344", "sku_id": "1729480364147774364", "sku_sale_property_value_names": [ "red", "large size" ] }, "main_order_id": "13444222", "activity_id": "13456677", "status": "PENDING", "creator_fulfillment": { "id": "123456", "expiration_time": 1726301400, "total_suspend_duration": 123, "status": "PENDING", "bound_product_status": "LIVE" } } ] }, "message": "Success", "request_id": "202203070749000101890810281E8C70B7"}