# Product list

product list data

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

## Query parameters:

  - `keyword` (string)
    fuzzy matching keywords

  - `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"

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

  - `sales_trend_flag` (integer)
    sale trend. 0=stable  1=up 2=down

  - `min_total_sale_cnt` (integer)
    total_sale_cnt range query

  - `max_total_sale_cnt` (integer)
    total_sale_cnt range query

  - `min_total_sale_30d_cnt` (integer)
    total_sale_30d_cnt range query

  - `max_total_sale_30d_cnt` (integer)
    total_sale_30d_cnt range query

  - `min_spu_avg_price` (number)
    spu_avg_price range query

  - `max_spu_avg_price` (number)
    spu_avg_price range query

  - `min_product_commission_rate` (number)
    product_commission_rate range query

  - `max_product_commission_rate` (number)
    product_commission_rate range query

  - `min_total_ifl_cnt` (integer)
    total_ifl_cnt range query

  - `max_total_ifl_cnt` (integer)
    total_ifl_cnt range query

  - `min_total_video_cnt` (integer)
    total_video_cnt range query

  - `max_total_video_cnt` (integer)
    total_video_cnt range query

  - `min_total_views_cnt` (integer)
    total_views_cnt range query

  - `max_total_views_cnt` (integer)
    total_views_cnt range query

  - `min_product_rating` (number)
    product_rating range query

  - `max_product_rating` (number)
    product_rating range query

  - `min_review_count` (integer)
    review_count range query

  - `max_review_count` (integer)
    review_count range query

  - `is_s_shop` (integer)
    whether to fully host the store   0=ordinary store   1=fully managed

  - `free_shipping` (integer)
    free shipping  0=N  1=Y

  - `min_total_sale_gmv_amt` (number)
    total_sale_gmv_amt range query

  - `max_total_sale_gmv_amt` (number)
    total_sale_gmv_amt range query

  - `min_total_sale_gmv_30d_amt` (number)
    total_sale_gmv_30d_amt range query

  - `max_total_sale_gmv_30d_amt` (number)
    total_sale_gmv_30d_amt range query

  - `min_first_crawl_dt` (integer)
    first_crawl_dt range query

  - `max_first_crawl_dt` (integer)
    first_crawl_dt range query

  - `sales_flag` (integer)
    Main Sales Methods.  1=video 2=live

  - `sort_type` (integer)
    sort order. 0=asc 1=desc

  - `product_sort_field` (any)
    sort values. 1=total_sale_cnt 2=total_sale_gmv_amt 3=spu_avg_price 4=total_sale_7d_cnt 5=total_sale_30d_cnt 6=total_sale_gmv_7d_amt 7=total_sale_gmv_30d_amt

  - `page_num` (integer, required)
    page number

  - `page_size` (integer, required)
    page size

## Response 200 fields (application/json):

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

  - `cover_url` (array)
    Example: [{"url":"https://echosell-images.tos-ap-southeast-1.volces.com/product-cover/154/1729382308971940777_7.jpeg","index":7},{"url":"https://echosell-images.tos-ap-southeast-1.volces.com/product-cover/154/1729382308971940777_5.jpeg","index":5},{"url":"https://echosell-images.tos-ap-southeast-1.volces.com/product-cover/154/1729382308971940777_6.jpeg","index":6},{"url":"https://echosell-images.tos-ap-southeast-1.volces.com/product-cover/154/1729382308971940777_2.jpeg","index":2},{"url":"https://echosell-images.tos-ap-southeast-1.volces.com/product-cover/154/1729382308971940777_4.jpeg","index":4},{"url":"https://echosell-images.tos-ap-southeast-1.volces.com/product-cover/154/1729382308971940777_3.jpeg","index":3},{"url":"https://echosell-images.tos-ap-southeast-1.volces.com/product-cover/154/1729382308971940777_1.jpeg","index":1},{"url":"https://echosell-images.tos-ap-southeast-1.volces.com/product-cover/154/1729382308971940777_8.jpeg","index":8},{"url":"https://echosell-images.tos-ap-southeast-1.volces.com/product-cover/154/1729382308971940777_0.jpeg","index":0}]

  - `product_name` (string)
    Example: "MOUNTAIN BIKE WEAPON ROCKET AIR SUSPENSION FORK"

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

  - `spu_avg_price` (number)
    avg sku price (USD)
    Example: 111.92

  - `min_price` (number)
    min sku price (USD)
    Example: 11.23

  - `max_price` (number)
    max sku price (USD)
    Example: 11.23

  - `skus` (array)
    Example: [{"sku_id":"1729382308972006313","sale_prop_value_ids":"7104114389657306885_7104114389657372421","real_price":{"price_str":"₱6,499.00","price_val":"6499","currency":"PHP"}},{"sku_id":"1729382309955111849","sale_prop_value_ids":"7104114389657323269_7104114389657372421","real_price":{"price_str":"₱6,499.00","price_val":"6499","currency":"PHP"}},{"sku_id":"1729382309955177385","sale_prop_value_ids":"7104114389657339653_7104114389657372421","real_price":{"price_str":"₱6,499.00","price_val":"6499","currency":"PHP"}},{"sku_id":"1729382309955242921","sale_prop_value_ids":"7104114389657356037_7104114389657372421","real_price":{"price_str":"₱6,499.00","price_val":"6499","currency":"PHP"}}]

  - `sale_props` (array)
    Example: [{"prop_name":"Color","has_image":"true","prop_id":"100000","sale_prop_values":[{"image":"https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/fb37d268c32f41e39f532975e4d77ae5~tplv-o3syd03w52-resize-jpeg:800:800.jpeg?from=1826719393","prop_value_id":"7104114389657306885","prop_value":"29ER GREY BLK GOLD"},{"image":"https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/343016cdebc942f0ae3852d09b06f471~tplv-o3syd03w52-resize-jpeg:800:800.jpeg?from=1826719393","prop_value_id":"7104114389657323269","prop_value":"27.5 GREY BLACK GOLD"},{"image":"https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/8b9bd4cf369048c4ab2263585703973e~tplv-o3syd03w52-resize-jpeg:800:800.jpeg?from=1826719393","prop_value_id":"7104114389657339653","prop_value":"29ER GREY WHITE BLK"},{"image":"https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/c59ca954d838441cb8b16a85d82f29f0~tplv-o3syd03w52-resize-jpeg:800:800.jpeg?from=1826719393","prop_value_id":"7104114389657356037","prop_value":"27.5 GREY WHITE BLK"}]},{"prop_name":"Specification","has_image":"false","prop_id":"100089","sale_prop_values":[{"image":"","prop_value_id":"7104114389657372421","prop_value":"Standard"}]}]

  - `product_commission_rate` (number)
    commission rate
    Example: 0.2

  - `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"

  - `product_rating` (number)
    Example: 4.5

  - `review_count` (integer)
    Example: 4551

  - `free_shipping` (integer)

  - `seller_id` (string)
    shop id
    Example: "7494631990599780670"

  - `discount` (string)
    Example: "-43%"

  - `total_sale_cnt` (integer)
    Example: 100

  - `total_sale_1d_cnt` (integer)
    1 days sales
    Example: 200

  - `total_sale_7d_cnt` (integer)
    7 days sales
    Example: 300

  - `total_sale_15d_cnt` (integer)
    15 days sales
    Example: 300

  - `total_sale_30d_cnt` (integer)
    30 days sales
    Example: 500

  - `total_sale_60d_cnt` (integer)
    60 days sales
    Example: 500

  - `total_sale_90d_cnt` (integer)
    90 days sales
    Example: 1000

  - `total_sale_gmv_amt` (number)
    Example: 332.1

  - `total_sale_gmv_1d_amt` (number)
    Example: 332.1

  - `total_sale_gmv_7d_amt` (number)
    Example: 332.1

  - `total_sale_gmv_15d_amt` (number)
    Example: 332.1

  - `total_sale_gmv_30d_amt` (number)
    Example: 332.1

  - `total_sale_gmv_60d_amt` (number)
    Example: 332.1

  - `total_sale_gmv_90d_amt` (number)
    Example: 332.1

  - `total_live_cnt` (integer)
    Example: 100

  - `total_video_cnt` (integer)

  - `total_ifl_cnt` (integer)
    Example: 20

  - `sales_trend_flag` (integer)
    0=stable 1=up 2=down
    Example: 1

  - `first_crawl_dt` (string)
    Estimated listing time
    Example: "20241205"

  - `off_mark` (integer)
    Product delisting label

  - `is_s_shop` (integer)
    Whether to fully host the store

  - `sales_flag` (integer)
    Main delivery method
    Example: 1

  - `desc_detail` (string)
    product detail
    Example: "[{\"type\":\"image\",\"image\":{\"height\":800,\"width\":800,\"uri\":\"tos-maliva-i-o3syd03w52-us/62865276afb2493483cb6f3c957049fc\",\"url_list\":[\"https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/62865276afb2493483cb6f3c957049fc~tplv-o3syd03w52-resize-jpeg:800:800.jpeg?from=1826719393\",\"https://p19-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/62865276afb2493483cb6f3c957049fc~tplv-o3syd03w52-resize-jpeg:800:800.jpeg?from=1826719393\"]}},{\"type\":\"text\",\"text\":\" \"},{\"type\":\"ul\",\"content\":[\"Crayon Warna: Ungkapan Kreativitas yang Tak Terbatas\"]},{\"type\":\"text\",\"text\":\"Mari jelajahi dunia warna dengan Crayon Warna kami yang menawan! Tak hanya digemari oleh anak-anak, tetapi juga menjadi favorit bagi orang dewasa yang ingin menyalurkan kreativitas mereka.\"},{\"type\":\"text\",\"text\":\"Fitur yang Membuat Anda Tertarik:\"},{\"type\":\"ul\",\"content\":[\"Warna-Warna Menggoda: Dari merah muda yang lembut hingga biru laut yang mendalam, kami menyediakan pilihan warna yang menarik dan menginspirasi. Siapa bilang hanya anak-anak yang boleh bermain dengan warna?\",\"Aman dan Berkualitas: Dirancang khusus untuk kenyamanan dan keselamatan, Crayon Warna kami bebas dari bahan beracun yang dapat membahayakan kesehatan anak-anak. Anda bisa dengan tenang memberikannya kepada balita yang sedang belajar mewarnai.\",\"Kualitas yang Tidak Diragukan: Dengan pigmentasi yang kuat dan daya tahan yang luar biasa, Crayon Warna kami menawarkan pengalaman mewarnai yang memuaskan dan tahan lama. Jadikanlah setiap gambar dan kreasi Anda menjadi karya seni yang mengagumkan!\"]},{\"type\":\"text\",\"text\":\"Dengan Crayon Warna berkualitas kami, Anda tak hanya memiliki alat tulis, tetapi juga kanvas untuk mengekspresikan imajinasi dan kreativitas Anda secara bebas. Mari buat dunia Anda berwarna-warni dengan Crayon Warna kami yang mengagumkan!\"}]"

  - `total_views_cnt` (integer)
    total video views
    Example: 100

  - `total_video_1d_cnt` (integer)

  - `total_video_7d_cnt` (integer)

  - `total_video_15d_cnt` (integer)

  - `total_video_30d_cnt` (integer)

  - `total_video_60d_cnt` (integer)

  - `total_video_90d_cnt` (integer)

  - `total_views_1d_cnt` (integer)

  - `total_views_7d_cnt` (integer)

  - `total_views_15d_cnt` (integer)

  - `total_views_30d_cnt` (integer)

  - `total_views_60d_cnt` (integer)

  - `total_views_90d_cnt` (integer)

  - `total_ifl_video_1d_cnt` (integer)

  - `total_ifl_video_7d_cnt` (integer)

  - `total_ifl_video_15d_cnt` (integer)

  - `total_ifl_video_30d_cnt` (integer)

  - `total_ifl_video_60d_cnt` (integer)

  - `total_ifl_video_90d_cnt` (integer)

  - `total_live_1d_cnt` (integer)

  - `total_live_7d_cnt` (integer)

  - `total_live_15d_cnt` (integer)

  - `total_live_30d_cnt` (integer)

  - `total_live_60d_cnt` (integer)

  - `total_live_90d_cnt` (integer)

  - `total_ifl_live_1d_cnt` (integer)

  - `total_ifl_live_7d_cnt` (integer)

  - `total_ifl_live_15d_cnt` (integer)

  - `total_ifl_live_30d_cnt` (integer)

  - `total_ifl_live_60d_cnt` (integer)

  - `total_ifl_live_90d_cnt` (integer)

  - `total_live_sale_1d_cnt` (integer)

  - `total_live_sale_7d_cnt` (integer)

  - `total_live_sale_15d_cnt` (integer)

  - `total_live_sale_30d_cnt` (integer)

  - `total_live_sale_60d_cnt` (integer)

  - `total_live_sale_90d_cnt` (integer)

  - `total_live_sale_gmv_1d_amt` (integer)

  - `total_live_sale_gmv_7d_amt` (integer)

  - `total_live_sale_gmv_15d_amt` (integer)

  - `total_live_sale_gmv_30d_amt` (integer)

  - `total_live_sale_gmv_60d_amt` (integer)

  - `total_live_sale_gmv_90d_amt` (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"