Get Open Collaboration Sample Rules

GET

/affiliate_seller/202410/open_collaborations/sample_rules

Use this API to get the status and the details of the sample rules for products under an open collaboration. With this API, you can efficiently review the sample distribution criteria for products within the open collaboration context.

Authorizations

• accessToken

Parameters

Query Parameters

shop_cipher

required

string

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

product_ids

required

Array<string>

The product IDs whose sample rules to retrieve. Specify 1 to 200 product IDs per request.

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

sample_rules

The sample rules for the requested products. Products whose sample rules have never been created or have been deleted are omitted.

Array<object>

object

product_id

The unique id of product.

string

sample_quota

The sample total quantity provided by seller which creators can apply for.

integer format: int64

is_sample_time_unlimited

Whether samples are timely unlimited for request:

• If true, it means available all the time
• If false, it means sample only available from begin_time to end_time.

boolean

status

Free sample rule status:

• NOT_STARTED. Not yet reached the specified begin_time.
• ONGOING. The sample rule is effective and the collaboration is ongoing.
• NO_LEFT_COUNT. sample_quantity_available is 0.
• PLAN_EXCEPTION. The product commission collaboration status is abnormal
• EXPIRED. Exceeded the end_time.

string

available_quantity

The quantity of remaining samples available for application.

integer format: int64

start_time

When present, the start of the sample application period, expressed as a Unix timestamp in seconds (UTC).

integer format: int64

end_time

When present, the end of the sample application period, expressed as a Unix timestamp in seconds (UTC).

integer format: int64

thresholds

The threshold criteria that a creator must meet to be eligible to apply for the sample.

object

minimum_follower_count

The creator must have a follower count greater than or equal to this value to be eligible to request the sample.

integer format: int64

minimum_gmv

The creator must have the GMV in the past 30 days greater than this value to be eligible to request the sample.

integer format: int64

avg_ec_video_views

The creator must have an average number of e-commerce video views in the past 30 days greater than or equal to this value to be eligible to request the sample.

integer format: int64

category_ids

A list of product first-level category IDs. Use this to limit participating creators: for each creator, sort their GMV over the past 30 days by first-level product category. If the GMV of one of the categories is among the top three, the creator is eligible to participate in the event. No restriction by default. For example, if a creator’s top three categories are [{Cellphone_ID}, {Furniture_ID}, {Food_ID}], and the value of tehis parameter is [{Food_ID}], the creator is qualified for open collaboration.

Array<string>

predicted_fulfillment_rank

The creators whose predicted rate of posting a shoppable video or LIVE after receiving a sample.

• ALL. All creators regardless of the rate.
• LOW. The creators whose rate is above or equal to low.
• MEDIUM. The creators whose rate is above or equal to medium.
• HIGH. The creators whose rate is high.

string

Example

{
  "code": 0,
  "data": {
    "sample_rules": [
      {
        "product_id": "123456",
        "sample_quota": 100,
        "is_sample_time_unlimited": true,
        "status": "ONGOING",
        "available_quantity": 50,
        "start_time": 1728546888,
        "end_time": 1728546888,
        "thresholds": {
          "minimum_follower_count": 200,
          "minimum_gmv": 1000,
          "avg_ec_video_views": 5,
          "category_ids": [
            "601152"
          ],
          "predicted_fulfillment_rank": "ALL"
        }
      }
    ]
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}