Skip to main content
GET
Search SKU inventory
このページはAIによって自動翻訳されています。API技術仕様は英語が正式です。不明点がある場合は英語版を参照してください。
これは Enterprise 専用 機能で、Return Helper Enterprise のお客様のみ有効です。本サービスの料金については、enterprise-solution@returnhelper.com までお問い合わせください。
アカウントの SKU 在庫を倉庫単位で返します。カーソルベースのページネーションを使用します。各行は、ある SKU のある倉庫における合計 quantityavailableQuantity の両方を報告します。

行は倉庫と SKU をキーとする

同じ SKU が複数の倉庫に存在する場合は、別々の行として返されます(倉庫ごとに 1 行)。レスポンスの 1 行は warehouseId + sku の組み合わせで一意に識別され、searchTotalCount は相異なる SKU 値の数ではなく「倉庫-SKU」行数を数えます。単一の倉庫のみを見るには warehouseIdList を渡してください。
この端点の旧バージョンが発行したカーソルは拒否されます。古いカーソル値をキャッシュしている場合は、cursor を付けずにページネーションを再開してください。バージョン付きカーソルは後方互換ではなく、古い API ID カーソル値が倉庫 ID として再解釈されることもありません。

ページネーション

このエンドポイントはカーソルベースのページネーションを使用します。各レスポンスには nextCursorpreviousCursor が含まれます。
  • nextCursor は次のページのカーソルです。最後のページに達した場合は null になります。
  • previousCursor は前のページのカーソルです。最初のページでは null になります。
前方向にページ送りするには、nextCursor の値を cursor クエリパラメータとして渡し、isForward=true を指定します。1 つのページネーションシーケンス内では、同じ pageSize(および任意の warehouseIdList / skuList フィルタ)を維持してください。
availableQuantity事前の可用性チェックのためのサマリー値であり、予約ではありません。投影の遅延によりリアルタイムの返品在庫と一時的に異なることがあり、保留中の VAS を持ち実際には resend 対象外のレコードを数える場合もあります。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