Sign in

v1

latestOpenAPI 3.0.02026-07-26318168886.7 KB
Categories

Get Categories

To get detailed information of couple categories sorted by time<br>利用時間範圍選取與排序獲取分類資料

get/categories

Query parameters

previous_idstring

The last ID of the addon products in the previous request.<br>前一筆分類的 ID <br>beta 測試中，僅開放部分店家使用，如無法使用功能請聯絡客服窗口

updated_afterstring

Filter categories by those updated after specific time.<br>取得 updated_at 大於指定時間的分類(包含指定時間)<br> *Should use UTC time'

updated_beforestring

Filter categories by those updated before specific time.<br>取得 updated_at 小於指定時間的分類(包含指定時間)<br> *Should use UTC time'

pageinteger

Page Number<br>頁數

per_pageinteger

Numbers of Orders per Page<br>每頁顯示 n 筆資料

excludes[]string[]

Could exclude certain parameters in the response<br>結果要排除哪些參數

[
  "items.id"
]
fields[]string[]

Could only show certain parameters in the response<br>結果只顯示哪些參數

[
  "items.id"
]
created_by_filter'admin' | 'pos'

Filter categories by those created by. Default 'admin'. <br>取得指定 created_by 的分類。預設為'admin'。

with_product_setboolean

Include product set in response. Default false.<br>是否在回應中包含商品集。預設為false。

include_fields[]string[]

Provide additional attributes in the response<br>結果添加哪些參數

[
  "product_count"
]
category_ids[]string[]

The category ids to be included in the response<br>結果包含哪些分類

[
  "5f69a8de60ae4900113fe72e"
]

Response

OK

Example response

{
  "items": [
    {
      "id": "5de4b3fe461b13002154587d",
      "name_translations": {
        "en": "Featured Products",
        "zh-hant": "精選商品",
        "zh-hk": "精選商品",
        "zh-cn": "精选商品",
        "zh-tw": "精選商品",
        "vi": "Sản phẩm nổi bật",
        "ms": "Produk Terpilih",
        "ja": "おすすめ商品",
        "th": "สินค้าแนะนำ",
        "id": "Produk Unggulan",
        "de": "Empfohlene Produkte",
        "fr": "Produits à la une"
      },
      "seo_title_translations": {
        "en": "SEO",
        "zh-hant": "SEO優化"
      },
      "seo_description_translations": {
        "en": "SEO",
        "zh-hant": "SEO內文"
      },
      "seo_keywords": "關鍵字修改",
      "key": "featured_products",
      "sort_setting": "quantity_sold:desc",
      "status": "active",
      "parent_id": "5de4b3fe461b13002154587f",
      "product_count": 5
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 24,
    "total_count": 1,
    "total_pages": 1
  }
}