查詢商品分類樹

View as Markdown
唯讀端點,列出完整的商品分類樹,用於在建立或更新商品前取得有效的 productCategoryId。分頁是以「根分類」為單位:data 最多回傳 pageSize 個根分類,每個根分類底下帶著它的全部子分類,子分類不會被拆到下一頁;totalCount 計算的是根分類的數量,不是分類總數。isAssignable 只有子分類會是 true,商品只能被歸類到子分類,不能歸類到根分類。分類樹只有兩層、根分類數十個,預設分頁通常一次就能取回整棵樹,建議查一次後在你端快取,不需要每次建立商品前都重新查詢。

Authentication

X-Signaturestring

每個 /v1 請求都必須帶 X-Client-Id、X-Timestamp、X-Nonce 與 X-Signature 四個標頭。X-Signature 是以 client secret 對 canonical string 做 HMAC-SHA256 後的 Base64。canonical string 的組成、可複製的簽章範例與 401 排查步驟,請參閱「驗證與簽章」。

Query parameters

PageintegerOptional

頁碼,從 1 起算,省略時預設 1。這支端點的一頁是一頁根分類,不是一頁節點。小於 1 回傳 400 invalid_page;頁碼大到讓內部位移量溢位時同樣回傳 400 invalid_page。

PageSizeintegerOptional

每頁的根分類筆數上限,範圍 1 至 100,省略時預設 100。每個根分類底下的子分類會跟著一起回傳,不佔用這個額度,所以一頁實際回傳的節點數會比這個數字多。超出範圍一律回傳 400 invalid_page_size,不會自動夾限成合法值。

Response

OK
datalist of objects or nullOptional

本頁的根分類,每一筆為一個 ProductCategoryResponse,底下已帶著全部子分類。

totalCountintegerOptional

符合條件的根分類總數,不是分類總數,也不受目前頁碼影響。

currentPageintegerOptional

目前頁碼,即請求帶入的 page,從 1 起算。

pageSizeintegerOptional

目前頁面的根分類筆數上限,即請求帶入的 pageSize;實際回傳的節點數會因為子分類而更多。

totalPagesintegerOptional

總頁數,等於 totalCount(根分類數)除以 pageSize 後無條件進位;沒有符合的資料時為 0。

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error