getStocks
Retrieve inventory data for products with stock management. Filter by product name, model number, ID, category, display state, or stock quantity below a specified threshold. Supports pagination with limit and offset.
Instructions
在庫管理が有効な商品の在庫情報を一覧取得します。条件なしで呼ぶと該当商品の在庫を返し、商品名・型番・商品 ID・カテゴリ・掲載設定で絞り込み可能。stocks パラメータで指定数以下の在庫のもののみ抽出することもできます(他の絞り込みパラメータの詳細はスキーマを参照)。limit(最大 50、デフォルト 10)/ offset でページング。個別商品の在庫更新は updateProduct の product.stocks、オプション別在庫の確認は getProductVariants。
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ids | No | 商品IDで検索。カンマ区切りにすることで複数検索が可能 | |
| name | No | 商品名で部分一致検索 | |
| limit | No | レスポンスの件数を指定。指定がない場合は10。最大50 | |
| fields | No | レスポンスJSONのキーをカンマ区切りで指定 | |
| offset | No | 指定した数値+1件目以降のデータを返す | |
| stocks | No | 在庫管理している商品のうち、在庫数が指定した数値以下の商品を検索。オプションごとに在庫管理している商品は、オプションごとの在庫数で検索される | |
| model_number | No | 型番で部分一致検索 | |
| display_state | No | 掲載設定で検索 - `showing`: 掲載状態 - `hidden`: 非掲載状態 - `showing_for_members`: 会員にのみ掲載 - `sale_for_members`: 掲載状態だが購入は会員のみ可能 | |
| category_id_big | No | 大カテゴリーIDで検索 | |
| category_id_small | No | 小カテゴリーIDで検索 | |
| recent_zero_stocks | No | `true` の場合、過去1週間以内にオプションが更新された商品から検索 |