Skip to navigation

查詢組合品清單

View as Markdown

分頁查詢租戶的所有組合品,不論是否放在商品頁底下,依 id 由小到大排序。篩選條件比對的是組合 SKU 自己的欄位,不是所在商品頁的欄位。

可用下列參數篩選:

  • outerSysCode、name:大小寫不敏感的子字串比對
  • status:Active、Inactive 或 GiftOnly,完全比對,大小寫必須完全相符
  • updatedSince:篩「異動時間等於或晚於此刻」的資料,判斷來源見下方說明
  • componentSkuId:反查「改動某個元件規格會影響哪些組合品」

⚠️ updatedSince 的判斷來源有兩個:組合 SKU 本身的異動時間,以及配方列(元件、用量、排序)的異動時間,兩者用 OR 合併——改名、改價、改狀態會動到組合 SKU 的異動時間,改配方只會動到配方列的異動時間,所以兩種異動都會出現在增量結果裡。

page 從 1 起算,pageSize 為 1–100(預設 100),超出範圍一律回 400,不會自動夾限。

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

outerSysCodestringOptional

依 ERP 端的組合品料號篩選。大小寫不敏感的子字串比對,查 A100 也會一併比對到 A1000;要精確命中某一筆,請在你端再比對一次完整字串。

namestringOptional

依組合品名稱篩選。大小寫不敏感的子字串比對,規則與 outerSysCode 相同。

statusstringOptional

依組合品狀態篩選:Active、Inactive 或 GiftOnly。這是完全比對,而且大小寫必須與這裡列出的完全相符——帶 active 不會命中任何資料,會回傳 HTTP 200 但 data 是空陣列,不是錯誤(寫入時的 status 則不分大小寫)。

componentSkuIdlongOptional

反查:只回傳目前配方裡仍然含有這個元件規格的組合品,用於「這顆規格庫存異動了,會影響哪些組合品」這類場景。

⚠️ 命中範圍不含歷史關聯——元件曾經在配方裡出現過,後來被替換配方(PUT /v1/bundles/{id} 帶新的 components)移除,就不會再被這個參數命中;查不到不代表沒有影響過,只代表「現在」沒有關聯,這支反查沒有辦法回答「這顆規格曾經被哪些組合品用過」。

updatedSincestringOptional

只回傳異動時間等於或晚於此刻的組合品,用於增量同步;判斷來源與涵蓋範圍見本端點說明。

必須是 ISO-8601 格式,並帶明確的時區位移或 Z(例如 2026-07-01T00:00:00Z);沒有時區資訊會回傳 400 invalid_updated_since。放進網址時記得把 + 編碼成 %2B。

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

本頁的組合品資料,每一筆為一筆組合品資料,形狀與「查詢單一組合品」的回應相同。

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