# Product rank list

The product rank list data and the return value of the interface are all incremental data during the list period.

Endpoint: GET /product/ranklist
Version: 1.0.0
Security: MuseumPlaceholderAuth

## Query parameters:

  - `date` (string, required)
    yyyy-MM-dd
    Example: "2024-12-15"

  - `region` (string, required)
    region code
    Example: "US/ID/TH/PH/MY/VN/GB/MX/SG/SA/BR/ES"

  - `category_id` (string)
    first level category id
    Example: "600001"

  - `category_l2_id` (string)
    second level category id
    Example: "851848"

  - `category_l3_id` (string)
    third level category id
    Example: "600621"

  - `rank_type` (integer, required)
    rank cycle,1=day 2=week 3=month

  - `product_rank_field` (integer, required)
    rank field. 1=total_sale_cnt 2=total_ifl_cnt

  - `page_num` (integer, required)
    page number

  - `page_size` (integer, required)
    page size

## Response 200 fields (application/json):

  - `product_id` (string)
    Example: "1729464033034539782"

  - `product_name` (string)
    Example: "Rosabella Moringa Capsules (800mg) for Immune Support, Gut Health & Vitamins"

  - `category_id` (string)
    Example: "600001"

  - `category_l2_id` (string)
    Example: "851848"

  - `category_l3_id` (string)
    Example: "600621"

  - `region` (string)
    Example: "US"

  - `spu_avg_price` (number)
    Example: 14.42

  - `min_price` (number)
    Example: 11

  - `max_price` (number)
    Example: 14.42

  - `product_commission_rate` (number)
    Example: 0.2

  - `total_sale_cnt` (integer)
    Example: 10

  - `total_sale_gmv_amt` (number)
    Example: 22.3

  - `total_ifl_cnt` (integer)
    Example: 10

  - `total_live_cnt` (integer)
    Example: 15

  - `total_video_cnt` (integer)

## Response 403 fields (application/problem+json):

  - `code` (integer)
    Example: 403

  - `message` (string)
    Example: "Usage Limit Exceeded, Please Contact Administrator to Increase Quota"

## Response 429 fields (application/problem+json):

  - `code` (integer)
    Example: 429

  - `message` (string)
    Example: "speed limit"

## Response 500 fields (application/problem+json):

  - `code` (integer)
    Example: 500

  - `message` (string)
    Example: "inner error"

## Response 504 fields (application/problem+json):

  - `code` (integer)
    Example: 504

  - `message` (string)
    Example: "timeout"