搜索 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