Skip to main content
GET
Search SKU inventory
此頁面由 AI 自動翻譯。API 技術規格以英文呈現為標準。如有任何疑問,請參閱英文版本
此為 Enterprise 專屬 功能,僅對 Return Helper Enterprise 客戶啟用。如需了解此服務的定價,請聯絡 enterprise-solution@returnhelper.com
以倉庫為單位回傳您帳戶的 SKU 庫存,並採用游標式分頁(cursor-based pagination)。每一列同時回報某 SKU 在某倉庫的總 quantityavailableQuantity

各列以倉庫與 SKU 為鍵

同一個 SKU 若存放於多個倉庫,會以多列回傳——每個倉庫各一列。回應中的一列由其 warehouseId + sku 組合唯一識別;searchTotalCount 計算的是「倉庫-SKU」列數,而非相異的 SKU 值數量。若只想查看單一倉庫,請傳入 warehouseIdList
由此端點舊版發出的游標將被拒絕。若您快取了舊的游標值,請以不帶 cursor 的方式重新開始分頁——版本化游標不向後相容,舊的 API ID 游標值也不會被重新解讀為倉庫 ID。

分頁

此端點採用游標式分頁。每個回應都包含 nextCursorpreviousCursor
  • nextCursor 是下一頁的游標;已到最後一頁時為 null
  • previousCursor 是上一頁的游標;在第一頁時為 null
若要向前翻頁,將 nextCursor 的值作為 cursor 查詢參數傳回,並帶上 isForward=true。在同一個分頁序列中,請保持相同的 pageSize(以及任何 warehouseIdList / skuList 篩選條件)。
availableQuantity 是供提前檢查可用量的彙總數字——並非保留(reservation)。它可能因投影延遲而與即時退件庫存短暫不一致,也可能將帶有待處理 VAS、實際上不符補寄資格的記錄計入。以 SKU 建立 Resend 會在請求當下對 MySQL 進行具權威性且加鎖的配置。

授權

x-rr-apikey
string
header
必填

Your API key

x-rr-apitoken
string
header
必填

Your API token — keep this private

查詢參數

pageSize
integer
必填

Number of warehouse-SKU rows to return per page. Required. Minimum 1, maximum 1000.

必填範圍: 1 <= x <= 1000
cursor
string

Opaque, 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.

isForward
boolean

Pagination direction. Set true to page forward through results using the returned nextCursor. Defaults to false when omitted. Optional.

warehouseIdList
string

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.

skuList
string

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.

nextCursor
string | null

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.

previousCursor
string | null

Cursor token for the previous page, or null when there is no previous page.

data
object[]

SKU inventory records for the current page