搜尋 SKU 庫存
Enterprise-only. Returns warehouse-scoped SKU inventory rows for the authenticated account, using cursor-based pagination. Each row carries the total quantity and the availableQuantity for one SKU in one warehouse; the same SKU held in different warehouses appears as separate rows. Omitting both warehouseIdList and skuList returns rows across every warehouse owned by the account.
quantity 與 availableQuantity。
各列以倉庫與 SKU 為鍵
同一個 SKU 若存放於多個倉庫,會以多列回傳——每個倉庫各一列。回應中的一列由其warehouseId + sku 組合唯一識別;searchTotalCount 計算的是「倉庫-SKU」列數,而非相異的 SKU 值數量。若只想查看單一倉庫,請傳入 warehouseIdList。
分頁
此端點採用游標式分頁。每個回應都包含nextCursor 與 previousCursor:
nextCursor是下一頁的游標;已到最後一頁時為null。previousCursor是上一頁的游標;在第一頁時為null。
nextCursor 的值作為 cursor 查詢參數傳回,並帶上 isForward=true。在同一個分頁序列中,請保持相同的 pageSize(以及任何 warehouseIdList / skuList 篩選條件)。
availableQuantity 是供提前檢查可用量的彙總數字——並非保留(reservation)。它可能因投影延遲而與即時退件庫存短暫不一致,也可能將帶有待處理 VAS、實際上不符補寄資格的記錄計入。以 SKU 建立 Resend 會在請求當下對 MySQL 進行具權威性且加鎖的配置。相關
- 計算 SKU 庫存筆數 — 相同篩選條件下符合的「倉庫-SKU」列總數。
- 以 SKU 建立 Resend — 以 SKU 數量(而非退件庫存 ID)建立補寄。
授權
Your API key
Your API token — keep this private
查詢參數
Number of warehouse-SKU rows to return per page. Required. Minimum 1, maximum 1000.
1 <= x <= 1000Opaque, versioned cursor token encoding cursor version, warehouse ID, and SKU. Pass the nextCursor (or previousCursor) from a previous response to fetch the adjacent page. Omit to fetch the first page. Cursors issued by the previous (pre-redesign) version of this endpoint are rejected — restart pagination without a cursor.
Pagination direction. Set true to page forward through results using the returned nextCursor. Defaults to false when omitted. Optional.
Comma-separated list of warehouse IDs to filter by (e.g. 1001,1002). When provided, each value must be a positive integer, the list must contain no duplicates, the number of entries must not exceed 100, and every warehouse must be owned by the authenticated account. Omit to return rows across all owned warehouses. Optional.
Comma-separated list of SKUs to filter by (e.g. SKU-006,SKU-001). When provided, the number of entries must not exceed 100 and each SKU must match the SKU pattern (alphanumerics plus #, -, _; maximum 32 characters). SKUs are matched after trim and uppercase normalization. Omit to return all SKUs. Optional.
回應
Success
Cursor-paginated list of SKU inventory records. The business payload (nextCursor, previousCursor, data) is returned as top-level fields alongside the standard correlationId and meta envelope.
Cursor token for the next page, or null when there is no next page. Pass it back as cursor with isForward=true to page forward.
Cursor token for the previous page, or null when there is no previous page.
SKU inventory records for the current page