Get Weekly Creator Outreach Quota

GET

/affiliate_seller/202607/creator_outreach/quota

Query the weekly outreach invitation quota for a shop. It returns the current GMV tier, maximum reachable creator follower count corresponding to the tier, consumed quota, remaining quota and other related information.

Authorizations

• accessToken

Parameters

Query Parameters

shop_cipher

required

string

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

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

data

Creator outreach quota information for the shop.

object

shop_id

Shop id

string

quota_type

Quota type, e.g. bouns quota; period quota

string

gmv_tier

Shop gmv tier

string

quota_sum

Shop quota sum

string

quota_use

Shop quota used

string

unlimited

Whether the shop has unlimited creator outreach quota.

boolean

reached_max_follower_cnt

Max creator follower count this shop can reach

string

new_connect_count

New connect creator count during this quota period

string

pair_connect_count

Connect paired creator count during this quota period

string

start_time

Quota period start time

string

end_time

Quota period end time

string

gmv_level_rule

Quota GMV level rules

Array<object>

object

reached_max_follower_cnt

Maximum follower count for creators the shop can reach under this GMV tier.

string

gmv_tier

GMV tier id

string

left_gmv

Rule gmv left bound

object

amount

GMV amount

string

currency

GMV currency

string

right_gmv

Rule gmv right bound

object

amount

GMV amount

string

currency

GMV currency

string

quota_details

Creator-level quota detail rules

Array<object>

object

creator_levels

Creator tiers covered in the current quota tiering

Array<integer>

quota_period_sum

Period quota num in the current quota tiering

integer format: int64

quota_bonus_sum

Bonus quota num in the current quota tiering, if the seller meet the exposure posts percentile threshold, will gain quota bonus

integer format: int64

quota_details

Creator-level quota detail information

Array<object>

object

creator_levels

Creator tiers covered in the current quota tiering

Array<integer>

quota_period_sum

Period quota num in the current quota tiering

integer format: int64

quota_period_use

Period quota use in the current quota tiering

integer format: int64

quota_bonus_sum

Bonus quota num in the current quota tiering, if the seller meet the exposure posts percentile threshold, will gain quota bonus

integer format: int64

quota_bonus_use

Bonus quota use in the current quota tiering, bonus will be consume first.

integer format: int64

bonus_exposure_post_percentile_threshold

Threshold for exposure posts percentile for shops to obtain additional reward of creator-level quota, 0.8 means the 80th percentile.

string

Example

{
  "code": 0,
  "data": {
    "data": {
      "shop_id": "1234",
      "quota_type": "BONUS",
      "gmv_tier": "1",
      "quota_sum": "1000",
      "quota_use": "500",
      "unlimited": false,
      "reached_max_follower_cnt": "1000",
      "new_connect_count": "100",
      "pair_connect_count": "100",
      "start_time": "1754296736852",
      "end_time": "1754296736852",
      "gmv_level_rule": [
        {
          "reached_max_follower_cnt": "1000",
          "gmv_tier": "1",
          "left_gmv": {
            "amount": "1000",
            "currency": "JPY"
          },
          "right_gmv": {
            "amount": "2000",
            "currency": "JPY"
          },
          "quota_details": [
            {
              "creator_levels": [
                1,
                2
              ],
              "quota_period_sum": 100,
              "quota_bonus_sum": 60
            }
          ]
        }
      ],
      "quota_details": [
        {
          "creator_levels": [
            1,
            2
          ],
          "quota_period_sum": 100,
          "quota_period_use": 1,
          "quota_bonus_sum": 60,
          "quota_bonus_use": 60
        }
      ],
      "bonus_exposure_post_percentile_threshold": "0.8"
    }
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}